@swmmrs/swmmrs 0.1.0 → 0.2.0

package/src/swmmrs/objects/options.ts

@@ -1,114 +1,114 @@
-import type { CustomEllipseModel, InertiaDamping, ModelTime, NormalFlowLimit, SurchargeMethod } from "../enums.js";
-import type { Call } from "../protocol.js";
-
-/** Calendar month and day for seasonal sweeping; validated by the native solver. */
-export type SweepDay = readonly [month: number, day: number];
-
-/** Sparse model-option update. Omitted fields retain their values; tolerances are not writable. */
-export interface ModelOptionsPatch {
-  /** Nominal routing step in seconds. Resets Courant factor to zero unless both are supplied. */
-  routingStepSeconds?: number;
-  /** Binary report interval in whole seconds, independent of iterator observation cadence. */
-  reportStepSeconds?: number;
-  /** Enable detailed report tables; object selection still uses `includedInReport`. */
-  detailedReportingEnabled?: boolean;
-  /** Ellipse cross-section interpretation. */
-  customEllipseModel?: CustomEllipseModel;
-  /** Surcharge treatment. */
-  surchargeMethod?: SurchargeMethod;
-  /** Allow configured nodal surface ponding. */
-  allowPonding?: boolean;
-  /** Dynamic Wave inertia-damping rule. */
-  inertiaDamping?: InertiaDamping;
-  /** Normal-flow limiting rule. */
-  normalFlowLimit?: NormalFlowLimit;
-  /** Allow steady-state routing skips. */
-  skipSteadyState?: boolean;
-  /** Process rainfall; does not create missing definitions. */
-  rainfallEnabled?: boolean;
-  /** Process rainfall-dependent infiltration/inflow. */
-  rdiiEnabled?: boolean;
-  /** Process snowmelt. */
-  snowmeltEnabled?: boolean;
-  /** Process groundwater. */
-  groundwaterEnabled?: boolean;
-  /** Route hydraulic flow. */
-  routingEnabled?: boolean;
-  /** Process water quality. */
-  qualityEnabled?: boolean;
-  /** Control-rule interval in whole seconds. */
-  ruleStepSeconds?: number;
-  /** First month/day for seasonal sweeping. */
-  sweepStart?: SweepDay;
-  /** Last month/day for seasonal sweeping. */
-  sweepEnd?: SweepDay;
-  /** Maximum Dynamic Wave trial iterations. */
-  maximumTrials?: number;
-  /** Model-requested solver threads, distinct from the worker capacity in `SimulationOptions.threads`. */
-  requestedThreads?: number;
-  /** Lower bound for variable routing steps in seconds. */
-  minimumRoutingStepSeconds?: number;
-  /** Conduit-lengthening time step in seconds. */
-  lengtheningStepSeconds?: number;
-  /** Antecedent dry period in seconds. */
-  antecedentDrySeconds?: number;
-  /** Variable-step adjustment factor. Explicit writes must be positive; reads may contain the disabled value zero. */
-  courantFactor?: number;
-  /** Minimum nodal surface area in ft² or m². */
-  minimumSurfaceArea?: number;
-  /** Minimum conduit slope as a ratio, not a percentage. */
-  minimumConduitSlope?: number;
-}
-
-/** Complete read-only option record, including all writable fields and solver tolerances. */
-export interface ModelOptions extends Readonly<Required<ModelOptionsPatch>> {
-  /** Read-only hydraulic head convergence tolerance. */
-  readonly headTolerance: number;
-  /** Read-only system-flow convergence tolerance. */
-  readonly systemFlowTolerance: number;
-  /** Read-only lateral-flow convergence tolerance. */
-  readonly lateralFlowTolerance: number;
-}
-
-/** Sparse calendar boundaries for `Simulation.updateSchedule()`; omitted times retain their values. */
-export interface SchedulePatch {
-  /** Simulation start in timezone-free model calendar time. */
-  startTime?: ModelTime;
-  /** First reporting time in timezone-free model calendar time. */
-  reportStart?: ModelTime;
-  /** Simulation end in timezone-free model calendar time. */
-  endTime?: ModelTime;
-}
-
-/** Option-family operations added to the shared worker protocol. */
-export interface OptionsOperations {
-  updateSchedule: { args: [SchedulePatch]; result: void };
-  maximumRoutingStepSeconds: { args: []; result: number };
-}
-
-/** Stable model options. Updates are atomic and require an open or ended run. */
-export class SimulationOptionsView {
-  readonly #call: Call;
-  private constructor(call: Call) { this.#call = call; }
-  /** @internal */
-  static create(call: Call): SimulationOptionsView { return new SimulationOptionsView(call); }
-  /** Read the complete option record in a healthy owner state.
-   * @returns Detached {@link ModelOptions}, including read-only solver tolerances.
-   */
-  read(): Promise<ModelOptions> { return this.#call("options"); }
-  /** Atomically update model options in `open` or `ended`; accepted edits return `ended` to `open`.
-   * @param patch - Sparse option values. Unknown keys, invalid types/enums, and solver-invalid values reject the whole patch.
-   * @returns Resolves after all supplied fields are accepted.
-   * @example
-   * ```typescript
-   * import type { Simulation } from "@swmmrs/swmmrs";
-   * declare const simulation: Simulation;
-   * await simulation.options.update({ routingStepSeconds: 30, reportStepSeconds: 300, qualityEnabled: true });
-   * ```
-   */
-  update(patch: ModelOptionsPatch): Promise<void> { return this.#call("configureOptions", patch); }
-  /** Read the maximum routing interval allowed by current configuration.
-   * @returns Maximum routing interval in seconds.
-   */
-  maximumRoutingStepSeconds(): Promise<number> { return this.#call("maximumRoutingStepSeconds"); }
-}
+import type { CustomEllipseModel, InertiaDamping, ModelTime, NormalFlowLimit, SurchargeMethod } from "../enums.js";
+import type { Call } from "../protocol.js";
+
+/** Calendar month and day for seasonal sweeping; validated by the native solver. */
+export type SweepDay = readonly [month: number, day: number];
+
+/** Sparse model-option update. Omitted fields retain their values; tolerances are not writable. */
+export interface ModelOptionsPatch {
+  /** Nominal routing step in seconds. Resets Courant factor to zero unless both are supplied. */
+  routingStepSeconds?: number;
+  /** Binary report interval in whole seconds, independent of iterator observation cadence. */
+  reportStepSeconds?: number;
+  /** Enable detailed report tables; object selection still uses `includedInReport`. */
+  detailedReportingEnabled?: boolean;
+  /** Ellipse cross-section interpretation. */
+  customEllipseModel?: CustomEllipseModel;
+  /** Surcharge treatment. */
+  surchargeMethod?: SurchargeMethod;
+  /** Allow configured nodal surface ponding. */
+  allowPonding?: boolean;
+  /** Dynamic Wave inertia-damping rule. */
+  inertiaDamping?: InertiaDamping;
+  /** Normal-flow limiting rule. */
+  normalFlowLimit?: NormalFlowLimit;
+  /** Allow steady-state routing skips. */
+  skipSteadyState?: boolean;
+  /** Process rainfall; does not create missing definitions. */
+  rainfallEnabled?: boolean;
+  /** Process rainfall-dependent infiltration/inflow. */
+  rdiiEnabled?: boolean;
+  /** Process snowmelt. */
+  snowmeltEnabled?: boolean;
+  /** Process groundwater. */
+  groundwaterEnabled?: boolean;
+  /** Route hydraulic flow. */
+  routingEnabled?: boolean;
+  /** Process water quality. */
+  qualityEnabled?: boolean;
+  /** Control-rule interval in whole seconds. */
+  ruleStepSeconds?: number;
+  /** First month/day for seasonal sweeping. */
+  sweepStart?: SweepDay;
+  /** Last month/day for seasonal sweeping. */
+  sweepEnd?: SweepDay;
+  /** Maximum Dynamic Wave trial iterations. */
+  maximumTrials?: number;
+  /** Model-requested solver threads, distinct from the worker capacity in `SimulationOptions.threads`. */
+  requestedThreads?: number;
+  /** Lower bound for variable routing steps in seconds. */
+  minimumRoutingStepSeconds?: number;
+  /** Conduit-lengthening time step in seconds. */
+  lengtheningStepSeconds?: number;
+  /** Antecedent dry period in seconds. */
+  antecedentDrySeconds?: number;
+  /** Variable-step adjustment factor. Explicit writes must be positive; reads may contain the disabled value zero. */
+  courantFactor?: number;
+  /** Minimum nodal surface area in ft² or m². */
+  minimumSurfaceArea?: number;
+  /** Minimum conduit slope as a ratio, not a percentage. */
+  minimumConduitSlope?: number;
+}
+
+/** Complete read-only option record, including all writable fields and solver tolerances. */
+export interface ModelOptions extends Readonly<Required<ModelOptionsPatch>> {
+  /** Read-only hydraulic head convergence tolerance. */
+  readonly headTolerance: number;
+  /** Read-only system-flow convergence tolerance. */
+  readonly systemFlowTolerance: number;
+  /** Read-only lateral-flow convergence tolerance. */
+  readonly lateralFlowTolerance: number;
+}
+
+/** Sparse calendar boundaries for `Simulation.updateSchedule()`; omitted times retain their values. */
+export interface SchedulePatch {
+  /** Simulation start in timezone-free model calendar time. */
+  startTime?: ModelTime;
+  /** First reporting time in timezone-free model calendar time. */
+  reportStart?: ModelTime;
+  /** Simulation end in timezone-free model calendar time. */
+  endTime?: ModelTime;
+}
+
+/** Option-family operations added to the shared worker protocol. */
+export interface OptionsOperations {
+  updateSchedule: { args: [SchedulePatch]; result: void };
+  maximumRoutingStepSeconds: { args: []; result: number };
+}
+
+/** Stable model options. Updates are atomic and require an open or ended run. */
+export class SimulationOptionsView {
+  readonly #call: Call;
+  private constructor(call: Call) { this.#call = call; }
+  /** @internal */
+  static create(call: Call): SimulationOptionsView { return new SimulationOptionsView(call); }
+  /** Read the complete option record in a healthy owner state.
+   * @returns Detached {@link ModelOptions}, including read-only solver tolerances.
+   */
+  read(): Promise<ModelOptions> { return this.#call("options"); }
+  /** Atomically update model options in `open` or `ended`; accepted edits return `ended` to `open`.
+   * @param patch - Sparse option values. Unknown keys, invalid types/enums, and solver-invalid values reject the whole patch.
+   * @returns Resolves after all supplied fields are accepted.
+   * @example
+   * ```typescript
+   * import type { Simulation } from "@swmmrs/swmmrs";
+   * declare const simulation: Simulation;
+   * await simulation.options.update({ routingStepSeconds: 30, reportStepSeconds: 300, qualityEnabled: true });
+   * ```
+   */
+  update(patch: ModelOptionsPatch): Promise<void> { return this.#call("configureOptions", patch); }
+  /** Read the maximum routing interval allowed by current configuration.
+   * @returns Maximum routing interval in seconds.
+   */
+  maximumRoutingStepSeconds(): Promise<number> { return this.#call("maximumRoutingStepSeconds"); }
+}

package/src/swmmrs/objects/rtk.ts

@@ -1,79 +1,79 @@
-import type { Call } from "../protocol.js";
-
-/** One detached RTK short-, medium-, or long-response parameter set. */
-export interface UnitHydrographResponse {
-  /** Fraction of rainfall converted to RDII. */
-  readonly rainfallFraction: number;
-  /** Time to peak in hours. */
-  readonly timeToPeakHours: number;
-  /** Recession-to-time-to-peak ratio. */
-  readonly recessionRatio: number;
-  /** Maximum initial abstraction depth in inches or millimetres. */
-  readonly maximumInitialAbstraction: number;
-  /** Initial abstraction recovery rate in rainfall-depth units per day. */
-  readonly initialAbstractionRecoveryRate: number;
-  /** Initial abstraction depth at start in inches or millimetres. */
-  readonly initialAbstractionAtStart: number;
-}
-
-/** One calendar month's named RTK responses. */
-export interface UnitHydrographMonth {
-  /** Short-response parameters. */
-  readonly short: UnitHydrographResponse;
-  /** Medium-response parameters. */
-  readonly medium: UnitHydrographResponse;
-  /** Long-response parameters. */
-  readonly long: UnitHydrographResponse;
-}
-
-/** Complete January-through-December RTK response matrix. */
-export interface UnitHydrographConfiguration {
-  /** Canonical rain-gage ID. */
-  readonly rainGage: string;
-  /** Exactly twelve monthly records, January through December. */
-  readonly monthlyResponses: readonly UnitHydrographMonth[];
-}
-
-/** Sparse RTK update. Omitted fields retain their current values. */
-export interface UnitHydrographPatch {
-  /** Replacement rain-gage ID. */
-  rainGage?: string;
-  /** Replacement complete January-through-December array, exactly twelve entries. */
-  monthlyResponses?: readonly UnitHydrographMonth[];
-}
-
-/** Detached RTK RDII node assignment in native project units. IDs are canonical. */
-export interface RdiiAssignment {
-  /** Canonical receiving node ID. */
-  readonly node: string;
-  /** Canonical RTK unit-hydrograph ID. */
-  readonly unitHydrograph: string;
-  /** Assigned land area in acres (US) or hectares (SI). */
-  readonly area: number;
-}
-
-export interface RtkOperations {
-  unitHydrographConfiguration: { args: [string]; result: UnitHydrographConfiguration };
-  configureUnitHydrograph: { args: [string, UnitHydrographPatch]; result: void };
-  rdiiAssignments: { args: []; result: readonly RdiiAssignment[] };
-  replaceRdiiAssignments: { args: [readonly RdiiAssignment[]]; result: void };
-}
-
-/** Editable RTK definition from `simulation.unitHydrographs`; node assignments are separate. */
-export class UnitHydrograph {
-  /** Canonical configured hydrograph ID. */
-  readonly id: string;
-  readonly #call: Call;
-  private constructor(id: string, call: Call) { this.id = id; this.#call = call; Object.freeze(this); }
-  /** @internal */
-  static create(id: string, call: Call): UnitHydrograph { return new UnitHydrograph(id, call); }
-  /** Read the definition in any healthy owner state.
-   * @returns Detached rain-gage identity and complete twelve-month response matrix.
-   */
-  configuration(): Promise<UnitHydrographConfiguration> { return this.#call("unitHydrographConfiguration", this.id); }
-  /** Atomically update an RTK definition in `open` or `ended`; accepted edits return the owner to `open`.
-   * @param patch - Sparse fields; a monthly array replaces all twelve months.
-   * @returns Resolves after the complete patch is accepted.
-   */
-  configure(patch: UnitHydrographPatch): Promise<void> { return this.#call("configureUnitHydrograph", this.id, patch); }
-}
+import type { Call } from "../protocol.js";
+
+/** One detached RTK short-, medium-, or long-response parameter set. */
+export interface UnitHydrographResponse {
+  /** Fraction of rainfall converted to RDII. */
+  readonly rainfallFraction: number;
+  /** Time to peak in hours. */
+  readonly timeToPeakHours: number;
+  /** Recession-to-time-to-peak ratio. */
+  readonly recessionRatio: number;
+  /** Maximum initial abstraction depth in inches or millimetres. */
+  readonly maximumInitialAbstraction: number;
+  /** Initial abstraction recovery rate in rainfall-depth units per day. */
+  readonly initialAbstractionRecoveryRate: number;
+  /** Initial abstraction depth at start in inches or millimetres. */
+  readonly initialAbstractionAtStart: number;
+}
+
+/** One calendar month's named RTK responses. */
+export interface UnitHydrographMonth {
+  /** Short-response parameters. */
+  readonly short: UnitHydrographResponse;
+  /** Medium-response parameters. */
+  readonly medium: UnitHydrographResponse;
+  /** Long-response parameters. */
+  readonly long: UnitHydrographResponse;
+}
+
+/** Complete January-through-December RTK response matrix. */
+export interface UnitHydrographConfiguration {
+  /** Canonical rain-gage ID. */
+  readonly rainGage: string;
+  /** Exactly twelve monthly records, January through December. */
+  readonly monthlyResponses: readonly UnitHydrographMonth[];
+}
+
+/** Sparse RTK update. Omitted fields retain their current values. */
+export interface UnitHydrographPatch {
+  /** Replacement rain-gage ID. */
+  rainGage?: string;
+  /** Replacement complete January-through-December array, exactly twelve entries. */
+  monthlyResponses?: readonly UnitHydrographMonth[];
+}
+
+/** Detached RTK RDII node assignment in native project units. IDs are canonical. */
+export interface RdiiAssignment {
+  /** Canonical receiving node ID. */
+  readonly node: string;
+  /** Canonical RTK unit-hydrograph ID. */
+  readonly unitHydrograph: string;
+  /** Assigned land area in acres (US) or hectares (SI). */
+  readonly area: number;
+}
+
+export interface RtkOperations {
+  unitHydrographConfiguration: { args: [string]; result: UnitHydrographConfiguration };
+  configureUnitHydrograph: { args: [string, UnitHydrographPatch]; result: void };
+  rdiiAssignments: { args: []; result: readonly RdiiAssignment[] };
+  replaceRdiiAssignments: { args: [readonly RdiiAssignment[]]; result: void };
+}
+
+/** Editable RTK definition from `simulation.unitHydrographs`; node assignments are separate. */
+export class UnitHydrograph {
+  /** Canonical configured hydrograph ID. */
+  readonly id: string;
+  readonly #call: Call;
+  private constructor(id: string, call: Call) { this.id = id; this.#call = call; Object.freeze(this); }
+  /** @internal */
+  static create(id: string, call: Call): UnitHydrograph { return new UnitHydrograph(id, call); }
+  /** Read the definition in any healthy owner state.
+   * @returns Detached rain-gage identity and complete twelve-month response matrix.
+   */
+  configuration(): Promise<UnitHydrographConfiguration> { return this.#call("unitHydrographConfiguration", this.id); }
+  /** Atomically update an RTK definition in `open` or `ended`; accepted edits return the owner to `open`.
+   * @param patch - Sparse fields; a monthly array replaces all twelve months.
+   * @returns Resolves after the complete patch is accepted.
+   */
+  configure(patch: UnitHydrographPatch): Promise<void> { return this.#call("configureUnitHydrograph", this.id, patch); }
+}