@swmmrs/swmmrs 0.1.0

package/lib/swmmrs/objects/nodes.js

@@ -0,0 +1,147 @@
+/**
+ * Owner-bound node handle obtained with `simulation.nodes.get(id)`.
+ *
+ * The constructor is private. Use {@link NodeConfiguration.kind} to distinguish
+ * junctions, storage nodes, outfalls, and dividers; there are no public subtype
+ * classes. Reads return detached, frozen records. Mutations require explicit
+ * methods, not assignments to those records.
+ *
+ * Operations reject when the owner is closed or failed, or the requested operation
+ * is invalid for its lifecycle state or node kind. Wrong-kind calls do not mutate
+ * the model. Read {@link statistics} before ending the run; hydraulic and quality
+ * reads remain available in `ended`.
+ */
+export class Node {
+    /** Canonical configured node ID. */
+    id;
+    #call;
+    constructor(id, call) { this.id = id; this.#call = call; Object.freeze(this); }
+    /** @internal */
+    static create(id, call) { return new Node(id, call); }
+    /**
+     * Read current hydraulics in `running`, `complete`, or `ended`.
+     * @returns A detached {@link NodeResults} record in project units, not a time series.
+     */
+    results() { return this.#call("node", this.id); }
+    /**
+     * Read common and kind-specific declarations in any healthy owner state.
+     * @returns A detached {@link NodeConfiguration}; non-applicable subtype fields are `null`.
+     */
+    configuration() { return this.#call("nodeConfiguration", this.id); }
+    /**
+     * Atomically update declarations in `open` or `ended`.
+     * An accepted edit in `ended` returns the owner to `open`.
+     * @param patch - Sparse {@link NodePatch}. Omitted top-level fields retain their values.
+     * @returns Resolves after the complete patch is accepted.
+     * @throws Rejects for an invalid patch, wrong node kind, or invalid lifecycle state;
+     * no part of a rejected patch is applied.
+     * @example
+     * ```typescript
+     * import type { Node } from "@swmmrs/swmmrs";
+     * declare const node: Node;
+     * await node.configure({ fullDepth: 4.5, initialDepth: 0.25 });
+     * ```
+     */
+    configure(patch) { return this.#call("configureNode", this.id, patch); }
+    /**
+     * Read the persistent additive API inflow in any healthy owner state.
+     * @returns Inflow in project flow units, excluding other inflow sources.
+     */
+    externalInflow() { return this.#call("nodeExternalInflow", this.id); }
+    /**
+     * Set persistent additive API inflow in `open`, `running`, or `ended`.
+     * @param flow - Inflow in project flow units. Zero removes the API contribution.
+     * @returns Resolves after the forcing is updated.
+     */
+    setExternalInflow(flow) { return this.#call("setNodeExternalInflow", this.id, flow); }
+    /**
+     * Set a persistent fixed-stage override in `open`, `running`, or `ended`.
+     * This runtime forcing is separate from {@link NodePatch.boundary}.
+     * @param stage - Outfall boundary elevation in project length units (ft or m).
+     * @returns Resolves after the forcing is updated.
+     * @throws Rejects for a non-outfall node or an invalid stage or lifecycle state.
+     */
+    setOutfallStage(stage) { return this.#call("setOutfallStage", this.id, stage); }
+    /**
+     * Read the effective fixed stage in any healthy owner state; outfalls only.
+     * @returns Runtime override if set, otherwise the declared fixed stage, in project
+     * length units; `null` when neither supplies a fixed stage.
+     * @throws Rejects for a non-outfall node.
+     */
+    fixedStage() { return this.#call("outfallFixedStage", this.id); }
+    /**
+     * Read current pollutant concentrations in `running`, `complete`, or `ended`.
+     * @returns Detached {@link NodeQuality} arrays aligned with their pollutant IDs.
+     */
+    quality() { return this.#call("nodeQuality", this.id); }
+    /**
+     * Queue concentration overrides for the next quality-routing step; requires `running`.
+     * The override expires after that step rather than becoming a persistent forcing.
+     * @param values - Sparse pollutant-ID map of nonnegative concentrations in each
+     * pollutant's configured concentration units.
+     * @returns Resolves after the overrides are queued.
+     * @throws Rejects invalid IDs, concentrations, or lifecycle states.
+     */
+    overridePollutantConcentrations(values) {
+        return this.#call("overrideNodePollutantConcentrations", this.id, values);
+    }
+    /**
+     * Read persistent external pollutant mass fluxes in `open`, `running`, or `ended`.
+     * @returns A detached {@link PollutantValues} map in configured pollutant mass-flux units.
+     */
+    externalPollutantMassFlux() {
+        return this.#call("nodeExternalPollutantMassFlux", this.id);
+    }
+    /**
+     * Read one persistent external mass flux in `open`, `running`, or `ended`.
+     * @param pollutantId - Configured pollutant ID.
+     * @returns The pollutant's external mass flux in its configured mass-flux units.
+     * @throws Rejects an unknown pollutant ID or invalid lifecycle state.
+     */
+    externalPollutantMassFluxValue(pollutantId) {
+        return this.#call("nodeExternalPollutantMassFluxValue", this.id, pollutantId);
+    }
+    /**
+     * Update persistent external pollutant mass fluxes in `open`, `running`, or `ended`.
+     * @param values - Sparse pollutant-ID map in configured pollutant mass-flux units.
+     * @param replace - Defaults to `false`: merge supplied IDs. With `true`, replace
+     * the complete mapping and reset omitted pollutants to zero.
+     * @returns Resolves after the atomic update.
+     * @throws Rejects invalid pollutant IDs, values, or lifecycle states.
+     */
+    updateExternalPollutantMassFlux(values, replace = false) {
+        return this.#call("updateNodeExternalPollutantMassFlux", this.id, values, replace);
+    }
+    /**
+     * Reset all persistent external pollutant mass fluxes to zero.
+     * Requires `open`, `running`, or `ended`; equivalent to
+     * `updateExternalPollutantMassFlux({}, true)`.
+     * @returns Resolves after the complete mapping is cleared.
+     */
+    clearExternalPollutantMassFlux() {
+        return this.updateExternalPollutantMassFlux({}, true);
+    }
+    /**
+     * Read cumulative node statistics in `running` or `complete`, before ending the run.
+     * @returns A detached {@link NodeStatistics} record for the current run.
+     */
+    statistics() { return this.#call("nodeStatistics", this.id); }
+    /**
+     * Read storage-only statistics in `running` or `complete`.
+     * @returns A detached {@link StorageStatistics} record for the current run.
+     * @throws Rejects for a non-storage node or invalid lifecycle state.
+     */
+    storageStatistics() { return this.#call("storageStatistics", this.id); }
+    /**
+     * Read outfall-only statistics in `running` or `complete`.
+     * @returns A detached {@link OutfallStatistics} record for the current run.
+     * @throws Rejects for a non-outfall node or invalid lifecycle state.
+     */
+    outfallStatistics() { return this.#call("outfallStatistics", this.id); }
+    /**
+     * Read cumulative total inflow volume in `running` or `complete`.
+     * @returns Volume in project volume units (ft³ or m³), not a flow rate.
+     */
+    totalInflowVolume() { return this.#call("nodeTotalInflowVolume", this.id); }
+}
+//# sourceMappingURL=nodes.js.map

package/lib/swmmrs/objects/nodes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"nodes.js","sourceRoot":"","sources":["../../../src/swmmrs/objects/nodes.ts"],"names":[],"mappings":"AAqVA;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,IAAI;IACf,oCAAoC;IAC3B,EAAE,CAAS;IACX,KAAK,CAAO;IACrB,YAAoB,EAAU,EAAE,IAAU,IAAI,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACrG,gBAAgB;IAChB,MAAM,CAAC,MAAM,CAAC,EAAU,EAAE,IAAU,IAAU,OAAO,IAAI,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAE1E;;;OAGG;IACH,OAAO,KAA2B,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAEvE;;;OAGG;IACH,aAAa,KAAiC,OAAO,IAAI,CAAC,KAAK,CAAC,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAEhG;;;;;;;;;;;;;OAaG;IACH,SAAS,CAAC,KAAgB,IAAmB,OAAO,IAAI,CAAC,KAAK,CAAC,eAAe,EAAE,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAElG;;;OAGG;IACH,cAAc,KAAsB,OAAO,IAAI,CAAC,KAAK,CAAC,oBAAoB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAEvF;;;;OAIG;IACH,iBAAiB,CAAC,IAAY,IAAmB,OAAO,IAAI,CAAC,KAAK,CAAC,uBAAuB,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAE7G;;;;;;OAMG;IACH,eAAe,CAAC,KAAa,IAAmB,OAAO,IAAI,CAAC,KAAK,CAAC,iBAAiB,EAAE,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IAEvG;;;;;OAKG;IACH,UAAU,KAA6B,OAAO,IAAI,CAAC,KAAK,CAAC,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAEzF;;;OAGG;IACH,OAAO,KAA2B,OAAO,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAE9E;;;;;;;OAOG;IACH,+BAA+B,CAAC,MAAuB;QACrD,OAAO,IAAI,CAAC,KAAK,CAAC,qCAAqC,EAAE,IAAI,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;IAC5E,CAAC;IAED;;;OAGG;IACH,yBAAyB;QACvB,OAAO,IAAI,CAAC,KAAK,CAAC,+BAA+B,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;OAKG;IACH,8BAA8B,CAAC,WAAmB;QAChD,OAAO,IAAI,CAAC,KAAK,CAAC,oCAAoC,EAAE,IAAI,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;IAChF,CAAC;IAED;;;;;;;OAOG;IACH,+BAA+B,CAAC,MAAuB,EAAE,OAAO,GAAG,KAAK;QACtE,OAAO,IAAI,CAAC,KAAK,CAAC,qCAAqC,EAAE,IAAI,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;IAED;;;;;OAKG;IACH,8BAA8B;QAC5B,OAAO,IAAI,CAAC,+BAA+B,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;IACxD,CAAC;IAED;;;OAGG;IACH,UAAU,KAA8B,OAAO,IAAI,CAAC,KAAK,CAAC,gBAAgB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAEvF;;;;OAIG;IACH,iBAAiB,KAAiC,OAAO,IAAI,CAAC,KAAK,CAAC,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAEpG;;;;OAIG;IACH,iBAAiB,KAAiC,OAAO,IAAI,CAAC,KAAK,CAAC,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAEpG;;;OAGG;IACH,iBAAiB,KAAsB,OAAO,IAAI,CAAC,KAAK,CAAC,uBAAuB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;CAC9F"}

package/lib/swmmrs/objects/options.d.ts

@@ -0,0 +1,112 @@
+import type { CustomEllipseModel, InertiaDamping, ModelTime, NormalFlowLimit, SurchargeMethod } from "../enums.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 declare class SimulationOptionsView {
+    #private;
+    private constructor();
+    /** Read the complete option record in a healthy owner state.
+     * @returns Detached {@link ModelOptions}, including read-only solver tolerances.
+     */
+    read(): Promise<ModelOptions>;
+    /** 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>;
+    /** Read the maximum routing interval allowed by current configuration.
+     * @returns Maximum routing interval in seconds.
+     */
+    maximumRoutingStepSeconds(): Promise<number>;
+}
+//# sourceMappingURL=options.d.ts.map

package/lib/swmmrs/objects/options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../../src/swmmrs/objects/options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,cAAc,EAAE,SAAS,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAGnH,oFAAoF;AACpF,MAAM,MAAM,QAAQ,GAAG,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,CAAC,CAAC;AAE7D,mGAAmG;AACnG,MAAM,WAAW,iBAAiB;IAChC,+FAA+F;IAC/F,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,4FAA4F;IAC5F,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,qFAAqF;IACrF,wBAAwB,CAAC,EAAE,OAAO,CAAC;IACnC,4CAA4C;IAC5C,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;IACxC,2BAA2B;IAC3B,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,8CAA8C;IAC9C,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,yCAAyC;IACzC,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,iCAAiC;IACjC,eAAe,CAAC,EAAE,eAAe,CAAC;IAClC,wCAAwC;IACxC,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,6DAA6D;IAC7D,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,sDAAsD;IACtD,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,wBAAwB;IACxB,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,2BAA2B;IAC3B,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,4BAA4B;IAC5B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,6BAA6B;IAC7B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,8CAA8C;IAC9C,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,6CAA6C;IAC7C,UAAU,CAAC,EAAE,QAAQ,CAAC;IACtB,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,6CAA6C;IAC7C,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,wGAAwG;IACxG,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,yDAAyD;IACzD,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC,gDAAgD;IAChD,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAChC,wCAAwC;IACxC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,oHAAoH;IACpH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,+CAA+C;IAC/C,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,0DAA0D;IAC1D,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,6FAA6F;AAC7F,MAAM,WAAW,YAAa,SAAQ,QAAQ,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC;IACzE,sDAAsD;IACtD,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;IAC/B,mDAAmD;IACnD,QAAQ,CAAC,mBAAmB,EAAE,MAAM,CAAC;IACrC,oDAAoD;IACpD,QAAQ,CAAC,oBAAoB,EAAE,MAAM,CAAC;CACvC;AAED,uGAAuG;AACvG,MAAM,WAAW,aAAa;IAC5B,6DAA6D;IAC7D,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,iEAAiE;IACjE,WAAW,CAAC,EAAE,SAAS,CAAC;IACxB,2DAA2D;IAC3D,OAAO,CAAC,EAAE,SAAS,CAAC;CACrB;AAED,oEAAoE;AACpE,MAAM,WAAW,iBAAiB;IAChC,cAAc,EAAE;QAAE,IAAI,EAAE,CAAC,aAAa,CAAC,CAAC;QAAC,MAAM,EAAE,IAAI,CAAA;KAAE,CAAC;IACxD,yBAAyB,EAAE;QAAE,IAAI,EAAE,EAAE,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC;CACzD;AAED,iFAAiF;AACjF,qBAAa,qBAAqB;;IAEhC,OAAO,eAA+C;IAGtD;;OAEG;IACH,IAAI,IAAI,OAAO,CAAC,YAAY,CAAC,CAAkC;IAC/D;;;;;;;;;OASG;IACH,MAAM,CAAC,KAAK,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAkD;IACjG;;OAEG;IACH,yBAAyB,IAAI,OAAO,CAAC,MAAM,CAAC,CAAoD;CACjG"}

package/lib/swmmrs/objects/options.js

@@ -0,0 +1,27 @@
+/** Stable model options. Updates are atomic and require an open or ended run. */
+export class SimulationOptionsView {
+    #call;
+    constructor(call) { this.#call = call; }
+    /** @internal */
+    static create(call) { return new SimulationOptionsView(call); }
+    /** Read the complete option record in a healthy owner state.
+     * @returns Detached {@link ModelOptions}, including read-only solver tolerances.
+     */
+    read() { 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) { return this.#call("configureOptions", patch); }
+    /** Read the maximum routing interval allowed by current configuration.
+     * @returns Maximum routing interval in seconds.
+     */
+    maximumRoutingStepSeconds() { return this.#call("maximumRoutingStepSeconds"); }
+}
+//# sourceMappingURL=options.js.map

package/lib/swmmrs/objects/options.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.js","sourceRoot":"","sources":["../../../src/swmmrs/objects/options.ts"],"names":[],"mappings":"AAwFA,iFAAiF;AACjF,MAAM,OAAO,qBAAqB;IACvB,KAAK,CAAO;IACrB,YAAoB,IAAU,IAAI,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC;IACtD,gBAAgB;IAChB,MAAM,CAAC,MAAM,CAAC,IAAU,IAA2B,OAAO,IAAI,qBAAqB,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC5F;;OAEG;IACH,IAAI,KAA4B,OAAO,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAC/D;;;;;;;;;OASG;IACH,MAAM,CAAC,KAAwB,IAAmB,OAAO,IAAI,CAAC,KAAK,CAAC,kBAAkB,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;IACjG;;OAEG;IACH,yBAAyB,KAAsB,OAAO,IAAI,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAC,CAAC,CAAC;CACjG"}

package/lib/swmmrs/objects/rtk.d.ts

@@ -0,0 +1,82 @@
+/** 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 declare class UnitHydrograph {
+    #private;
+    /** Canonical configured hydrograph ID. */
+    readonly id: string;
+    private constructor();
+    /** Read the definition in any healthy owner state.
+     * @returns Detached rain-gage identity and complete twelve-month response matrix.
+     */
+    configuration(): Promise<UnitHydrographConfiguration>;
+    /** 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>;
+}
+//# sourceMappingURL=rtk.d.ts.map

package/lib/swmmrs/objects/rtk.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rtk.d.ts","sourceRoot":"","sources":["../../../src/swmmrs/objects/rtk.ts"],"names":[],"mappings":"AAEA,wEAAwE;AACxE,MAAM,WAAW,sBAAsB;IACrC,8CAA8C;IAC9C,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC;IAClC,6BAA6B;IAC7B,QAAQ,CAAC,eAAe,EAAE,MAAM,CAAC;IACjC,uCAAuC;IACvC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,kEAAkE;IAClE,QAAQ,CAAC,yBAAyB,EAAE,MAAM,CAAC;IAC3C,yEAAyE;IACzE,QAAQ,CAAC,8BAA8B,EAAE,MAAM,CAAC;IAChD,mEAAmE;IACnE,QAAQ,CAAC,yBAAyB,EAAE,MAAM,CAAC;CAC5C;AAED,gDAAgD;AAChD,MAAM,WAAW,mBAAmB;IAClC,iCAAiC;IACjC,QAAQ,CAAC,KAAK,EAAE,sBAAsB,CAAC;IACvC,kCAAkC;IAClC,QAAQ,CAAC,MAAM,EAAE,sBAAsB,CAAC;IACxC,gCAAgC;IAChC,QAAQ,CAAC,IAAI,EAAE,sBAAsB,CAAC;CACvC;AAED,6DAA6D;AAC7D,MAAM,WAAW,2BAA2B;IAC1C,8BAA8B;IAC9B,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,gEAAgE;IAChE,QAAQ,CAAC,gBAAgB,EAAE,SAAS,mBAAmB,EAAE,CAAC;CAC3D;AAED,qEAAqE;AACrE,MAAM,WAAW,mBAAmB;IAClC,gCAAgC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,mFAAmF;IACnF,gBAAgB,CAAC,EAAE,SAAS,mBAAmB,EAAE,CAAC;CACnD;AAED,oFAAoF;AACpF,MAAM,WAAW,cAAc;IAC7B,mCAAmC;IACnC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,wCAAwC;IACxC,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAChC,yDAAyD;IACzD,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,aAAa;IAC5B,2BAA2B,EAAE;QAAE,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC;QAAC,MAAM,EAAE,2BAA2B,CAAA;KAAE,CAAC;IACrF,uBAAuB,EAAE;QAAE,IAAI,EAAE,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;QAAC,MAAM,EAAE,IAAI,CAAA;KAAE,CAAC;IAC/E,eAAe,EAAE;QAAE,IAAI,EAAE,EAAE,CAAC;QAAC,MAAM,EAAE,SAAS,cAAc,EAAE,CAAA;KAAE,CAAC;IACjE,sBAAsB,EAAE;QAAE,IAAI,EAAE,CAAC,SAAS,cAAc,EAAE,CAAC,CAAC;QAAC,MAAM,EAAE,IAAI,CAAA;KAAE,CAAC;CAC7E;AAED,gGAAgG;AAChG,qBAAa,cAAc;;IACzB,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAEpB,OAAO,eAA8F;IAGrG;;OAEG;IACH,aAAa,IAAI,OAAO,CAAC,2BAA2B,CAAC,CAA+D;IACpH;;;OAGG;IACH,SAAS,CAAC,KAAK,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAkE;CACvH"}

package/lib/swmmrs/objects/rtk.js

@@ -0,0 +1,19 @@
+/** Editable RTK definition from `simulation.unitHydrographs`; node assignments are separate. */
+export class UnitHydrograph {
+    /** Canonical configured hydrograph ID. */
+    id;
+    #call;
+    constructor(id, call) { this.id = id; this.#call = call; Object.freeze(this); }
+    /** @internal */
+    static create(id, call) { 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() { 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) { return this.#call("configureUnitHydrograph", this.id, patch); }
+}
+//# sourceMappingURL=rtk.js.map

package/lib/swmmrs/objects/rtk.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rtk.js","sourceRoot":"","sources":["../../../src/swmmrs/objects/rtk.ts"],"names":[],"mappings":"AA6DA,gGAAgG;AAChG,MAAM,OAAO,cAAc;IACzB,0CAA0C;IACjC,EAAE,CAAS;IACX,KAAK,CAAO;IACrB,YAAoB,EAAU,EAAE,IAAU,IAAI,IAAI,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACrG,gBAAgB;IAChB,MAAM,CAAC,MAAM,CAAC,EAAU,EAAE,IAAU,IAAoB,OAAO,IAAI,cAAc,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAC9F;;OAEG;IACH,aAAa,KAA2C,OAAO,IAAI,CAAC,KAAK,CAAC,6BAA6B,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IACpH;;;OAGG;IACH,SAAS,CAAC,KAA0B,IAAmB,OAAO,IAAI,CAAC,KAAK,CAAC,yBAAyB,EAAE,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;CACvH"}