mostlyright 1.1.3 → 1.4.0

package/dist/index.d.ts

@@ -5,13 +5,15 @@ export { LiveStreamError, NoLiveDataError, SourceMismatchRole, helloCore } from
 import { Observation } from '@mostlyrightmd/weather';
 import * as weather from '@mostlyrightmd/weather';
 export { weather };
-export { LatestOptions, LiveObservation, LiveSource, LiveSourceTag, POLITE_FLOORS_S, SOURCE_IDENTITY_TAGS, SUPPORTED_SOURCES, StreamOptions, helloWeather, isLiveSource, latest, sourceTag, stream, validatePollSeconds, validateSource } from '@mostlyrightmd/weather';
+export { DailyExtremeRow, DailyExtremesMergeMode, DailyExtremesOptions, LatestOptions, LiveObservation, LiveSource, LiveSourceTag, ObsOptions, ObsRow, ObsSourceFilter, ObsStrategy, POLITE_FLOORS_S, SOURCE_IDENTITY_TAGS, SUPPORTED_SOURCES, StreamOptions, dailyExtremes, helloWeather, isLiveSource, latest, obs, sourceTag, stream, validatePollSeconds, validateSource } from '@mostlyrightmd/weather';
 import * as markets from '@mostlyrightmd/markets';
 export { markets };
 export { helloMarkets } from '@mostlyrightmd/markets';
 import { CacheStore } from '@mostlyrightmd/core/internal/cache';
 import { PairsRow } from '@mostlyrightmd/core/internal/pairs';
 export { PairsRow } from '@mostlyrightmd/core/internal/pairs';
+import * as preprocessing from '@mostlyrightmd/core/preprocessing';
+export { preprocessing };
 
 /** The four mutually-exclusive selector names. */
 declare const SELECTOR_NAMES: readonly ["station", "city", "contract", "contracts"];
@@ -70,7 +72,56 @@ declare function annotateSettlesFor(station: string, city: string | null): reado
  */
 declare function buildOverrideWarning(contractStation: string, overrideStation: string): StationOverrideWarning;
 
-interface ResearchOptions {
+/**
+ * Phase 21 21-01 composable-kwargs extension to `ResearchOptions`.
+ *
+ * All fields are optional; defaults match Python. Each field's runtime
+ * validation lives in `validateResearchKwargs()` so the failure surface is
+ * lockstep with Python's `_validate_research_kwargs`.
+ */
+interface ResearchKwargsExtension {
+    /**
+     * When `true`, attach `fcst_*` columns. Phase 17 wired this end-to-end
+     * for IEM MOS; other forecast models require Phase 21 follow-up plans.
+     *
+     * Default: `false`.
+     */
+    include_forecast?: boolean;
+    /**
+     * Single forecast model name (e.g. `"gfs"`, `"nbm"`). Requires
+     * `include_forecast=true`. Mutually exclusive with `forecast_models`.
+     */
+    forecast_model?: string;
+    /**
+     * Multi-model forecast fan-out. Requires `include_forecast=true`.
+     * Mutually exclusive with `forecast_model`.
+     */
+    forecast_models?: ReadonlyArray<string>;
+    /**
+     * When `true`, run QC passes and surface QC columns. Default `false`.
+     */
+    qc?: boolean;
+    /**
+     * IANA timezone override for stations not in the canonical registry.
+     * Rarely needed for the 20-station Phase 1 set (all covered).
+     */
+    tz_override?: string;
+    /**
+     * D-03: accepted but no-op in TS. `backend="polars"` raises
+     * `DataAvailabilityError` (no Polars in browser/Node TS). Default
+     * `"pandas"` mirrors Python; in TS this is informational only.
+     */
+    backend?: "pandas" | "polars";
+    /**
+     * D-03: accepted but no-op in TS. Python returns a `MostlyRightResult`
+     * wrapper class when `return_type="wrapper"`; TS returns plain object
+     * arrays (no `.attrs` divergence to bridge), so the wrapper would carry
+     * no extra signal.
+     */
+    return_type?: "frame" | "wrapper";
+}
+
+interface ResearchOptions extends ResearchKwargsExtension {
     /** Forward to all underlying fetchers; aborts the whole pipeline. */
     signal?: AbortSignal;
     /** AWC lookback window in hours. Default 168 (AWC max). Clamped by the fetcher. */
@@ -290,6 +341,12 @@ declare function discover(args: {
     readonly city: string;
 }): DiscoverResult;
 
+/**
+ * @deprecated Use the lowercase `preprocessing` namespace instead — it
+ * matches the Python `mostlyright.preprocessing` namespace. The
+ * PascalCase alias is scheduled for removal in v2.0.0.
+ */
+declare const Preprocessing: typeof preprocessing;
 /**
  * Placeholder version string for the meta package. The authoritative
  * package version lives in `package.json#version` (currently
@@ -299,4 +356,4 @@ declare function discover(args: {
  */
 declare const version = "0.0.0";
 
-export { type DiscoverResult, type DiscoverRow, MODE2_SOURCES, type Mode2Source, type ResearchBySourceOptions, type ResearchOptions, SELECTOR_NAMES, SOURCE_ALIASES, type SelectorArgs, type SelectorName, type StationOverrideWarning, annotateSettlesFor, assertSourceIdentity, buildOverrideWarning, discover, isMode2Source, research, researchBySource, resolveCity, resolveContract, validateSelectors, version };
+export { type DiscoverResult, type DiscoverRow, MODE2_SOURCES, type Mode2Source, Preprocessing, type ResearchBySourceOptions, type ResearchOptions, SELECTOR_NAMES, SOURCE_ALIASES, type SelectorArgs, type SelectorName, type StationOverrideWarning, annotateSettlesFor, assertSourceIdentity, buildOverrideWarning, discover, isMode2Source, research, researchBySource, resolveCity, resolveContract, validateSelectors, version };