@tellegen/engine 0.3.0 → 0.4.1

package/dist/wasm-pkg/tellegen.d.ts

@@ -4,11 +4,20 @@
 /**
  * A retained fixed-point current-injection session. The prepared network,
  * sparse LU, and last converged voltage remain in this WASM object across
- * load edits.
+ * load edits. Ordinary edits return the compact summary; detailed terminal
+ * and equipment values are fetched on demand.
  */
 export class McPfSession {
     free(): void;
     [Symbol.dispose](): void;
+    /**
+     * Phase timings of the session's parse, preparation, factorization, and first solve.
+     */
+    cold_profile(): string;
+    /**
+     * One bounded page of terminal and equipment values for a bus or element.
+     */
+    detail(query_json: string): string;
     /**
      * Materialize the current edited input as PowerIO IR.
      */
@@ -17,20 +26,46 @@ export class McPfSession {
      * Editable load branches with base and current P/Q values.
      */
     load_branches(): string;
+    /**
+     * Edited networks materialized for portable output; ordinary edits build none.
+     */
+    materialization_count(): number;
     constructor(module_json: string, options_json: string);
     /**
-     * Replace the absolute branch-power edit state and solve with the retained
-     * factorization and previous converged voltage.
+     * Phase timings of the most recent solve.
+     */
+    profile(): string;
+    /**
+     * Replace the absolute branch-power edit state, solve with the retained
+     * factorization and previous converged voltage, and return the summary.
      */
     replace_load_powers(edits_json: string): string;
     /**
-     * The current complete solver result.
+     * The complete terminal and equipment result, built on demand. Its size
+     * grows with the network; the interactive path uses `summary`/`detail`.
      */
     result(): string;
     /**
      * Save the current edited point and result without re-solving.
      */
     snapshot(study_id: string, study_title: string): string;
+    /**
+     * The compact summary of the current operating point (constant size).
+     */
+    summary(): string;
+    /**
+     * Currents injected into the network as interleaved `[re, im]` amperes.
+     */
+    terminal_currents(): Float64Array;
+    /**
+     * Terminal identities as `[bus, terminal]` pairs in calculation order.
+     * They never change for a session, so a host fetches them once.
+     */
+    terminal_ids(): string;
+    /**
+     * Terminal voltages as interleaved `[re, im]` volts (a `Float64Array`).
+     */
+    terminal_voltages(): Float64Array;
 }
 
 /**
@@ -138,6 +173,76 @@ export class Study {
     solution(): string;
 }
 
+/**
+ * A synthetic preview as flat arrays: bus `[lon, lat]` pairs, kinds (0 load,
+ * 1 substation, 2 generator, 3 converter) and kV in bus order, branch route
+ * points, the index where each route starts (one entry more than there are
+ * branches) and branch kV.
+ */
+export class SynthPreviewBuffers {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    branch_kv(): Float32Array;
+    branch_positions(): Float64Array;
+    branch_start_indices(): Uint32Array;
+    bus_kinds(): Uint8Array;
+    bus_kv(): Float32Array;
+    bus_positions(): Float64Array;
+}
+
+/**
+ * A staged synthetic generation: one bounded stage per `advance`, a map
+ * preview between stages, and the module, the report and the drop-panel
+ * payload once it is done.
+ */
+export class SynthSession {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Run one stage (one calibration iteration for `calibrate`); returns the
+     * `StepOutcome` JSON.
+     */
+    advance(): string;
+    /**
+     * The network as GridFM graphkit JSON (per-unit feature matrices on a
+     * 0-based bus index), from `electrify` on.
+     */
+    export_gridfm(): string;
+    /**
+     * The drop-panel payload of the module (the `ingest_case` shape with
+     * `module_json`).
+     */
+    ingest(): string;
+    /**
+     * The module as generation 2 PowerIO IR text, with bus locations and
+     * branch routes, from `electrify` on.
+     */
+    module(): string;
+    /**
+     * Open a session at the `context` stage. `osm_json` is the Overpass
+     * document (one, or a JSON array of documents) for `source: "osm"`.
+     */
+    constructor(request_json: string, osm_json?: string | null);
+    /**
+     * The map preview as `Preview` JSON records.
+     */
+    preview(): string;
+    /**
+     * The map preview as flat arrays for binary map attributes, computed
+     * once; read each array, then `free()` the buffers.
+     */
+    preview_buffers(): SynthPreviewBuffers;
+    /**
+     * The `GenerationReport` JSON, partial until the session is done.
+     */
+    report(): string;
+    /**
+     * The stage the next `advance` runs.
+     */
+    stage(): string;
+}
+
 /**
  * Fill case coordinates from a PowerWorld `.pwd` sibling: substation symbols
  * project to approximate longitude/latitude and join onto buses through the
@@ -230,6 +335,13 @@ export function ingest_dist_case_bytes(bytes: Uint8Array, format: string): strin
  */
 export function ingest_json_drop(bytes: Uint8Array): string;
 
+/**
+ * Engine heap accounting: live and peak bytes held by the WASM allocator
+ * (peak since the last reset) and the size of linear memory, which only
+ * grows. Native builds report zeros.
+ */
+export function memory_stats(): string;
+
 /**
  * Parse a case file (MATPOWER, PSS/E RAW, PowerWorld aux, PowerModels or
  * egret JSON) and return `{"network": ..., "diagnostics": [...]}` as JSON.
@@ -261,6 +373,11 @@ export function parse_geo(bytes: Uint8Array, hint: string): string;
  */
 export function replay_mc_study(snapshot_json: string): string;
 
+/**
+ * Start a new peak-heap window at the current live size.
+ */
+export function reset_peak_memory(): void;
+
 /**
  * Solve a raw BMOPF multiconductor constant-power case.  The parser and
  * fixed-point implementation remain in the engine crate; this export only
@@ -303,12 +420,32 @@ export function study_document_import(bundle_json: string): string;
  */
 export function study_document_run(bundle_json: string, request_json: string, cancelled: Function): Promise<string>;
 
+/**
+ * Run every stage of a synthetic generation: `{module_json, report, ingest}`.
+ */
+export function synth_generate(request_json: string, osm_json?: string | null): string;
+
+/**
+ * Load the populated places table every synthetic session of this instance
+ * reads (the engine package's `data/populated_places.json`, or any table of
+ * `{n, lo, la, p, c}` rows). Returns `{count, sha256}`.
+ */
+export function synth_load_places(bytes: Uint8Array): string;
+
+/**
+ * The Overpass QL queries for a synthetic request's region: a JSON array, two
+ * entries when the region crosses the antimeridian.
+ */
+export function synth_overpass_queries(request_json: string): string;
+
 export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
 
 export interface InitOutput {
     readonly memory: WebAssembly.Memory;
     readonly __wbg_mcpfsession_free: (a: number, b: number) => void;
     readonly __wbg_study_free: (a: number, b: number) => void;
+    readonly __wbg_synthpreviewbuffers_free: (a: number, b: number) => void;
+    readonly __wbg_synthsession_free: (a: number, b: number) => void;
     readonly apply_display_geo: (a: number, b: number, c: number, d: number) => [number, number, number, number];
     readonly apply_geo: (a: number, b: number, c: number, d: number) => [number, number, number, number];
     readonly apply_layout: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number, number, number];
@@ -320,16 +457,26 @@ export interface InitOutput {
     readonly ingest_dist_case: (a: number, b: number, c: number, d: number) => [number, number, number, number];
     readonly ingest_dist_case_bytes: (a: number, b: number, c: number, d: number) => [number, number, number, number];
     readonly ingest_json_drop: (a: number, b: number) => [number, number, number, number];
+    readonly mcpfsession_cold_profile: (a: number) => [number, number, number, number];
+    readonly mcpfsession_detail: (a: number, b: number, c: number) => [number, number, number, number];
     readonly mcpfsession_input_module: (a: number) => [number, number, number, number];
     readonly mcpfsession_load_branches: (a: number) => [number, number, number, number];
+    readonly mcpfsession_materialization_count: (a: number) => number;
     readonly mcpfsession_new: (a: number, b: number, c: number, d: number) => [number, number, number];
+    readonly mcpfsession_profile: (a: number) => [number, number, number, number];
     readonly mcpfsession_replace_load_powers: (a: number, b: number, c: number) => [number, number, number, number];
     readonly mcpfsession_result: (a: number) => [number, number, number, number];
     readonly mcpfsession_snapshot: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
+    readonly mcpfsession_summary: (a: number) => [number, number, number, number];
+    readonly mcpfsession_terminal_currents: (a: number) => [number, number];
+    readonly mcpfsession_terminal_ids: (a: number) => [number, number, number, number];
+    readonly mcpfsession_terminal_voltages: (a: number) => [number, number];
+    readonly memory_stats: () => [number, number];
     readonly parse_case: (a: number, b: number, c: number, d: number) => [number, number, number, number];
     readonly parse_display: (a: number, b: number, c: number, d: number) => [number, number, number, number];
     readonly parse_geo: (a: number, b: number, c: number, d: number) => [number, number, number, number];
     readonly replay_mc_study: (a: number, b: number) => [number, number, number, number];
+    readonly reset_peak_memory: () => void;
     readonly solve_mc_bmopf: (a: number, b: number, c: number, d: number) => [number, number, number, number];
     readonly solve_mc_module: (a: number, b: number, c: number, d: number) => [number, number, number, number];
     readonly solve_mc_study: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number) => [number, number, number, number];
@@ -350,8 +497,26 @@ export interface InitOutput {
     readonly study_save_module: (a: number) => [number, number, number, number];
     readonly study_save_solution_module: (a: number) => [number, number, number, number];
     readonly study_solution: (a: number) => [number, number, number, number];
-    readonly wasm_bindgen__convert__closures_____invoke__h0178a8f776e4ef73: (a: number, b: number, c: any, d: any) => void;
-    readonly wasm_bindgen__convert__closures_____invoke__h42fc1c09ce4112c3: (a: number, b: number, c: any) => [number, number];
+    readonly synth_generate: (a: number, b: number, c: number, d: number) => [number, number, number, number];
+    readonly synth_load_places: (a: number, b: number) => [number, number, number, number];
+    readonly synth_overpass_queries: (a: number, b: number) => [number, number, number, number];
+    readonly synthpreviewbuffers_branch_kv: (a: number) => [number, number];
+    readonly synthpreviewbuffers_branch_positions: (a: number) => [number, number];
+    readonly synthpreviewbuffers_branch_start_indices: (a: number) => [number, number];
+    readonly synthpreviewbuffers_bus_kinds: (a: number) => [number, number];
+    readonly synthpreviewbuffers_bus_kv: (a: number) => [number, number];
+    readonly synthpreviewbuffers_bus_positions: (a: number) => [number, number];
+    readonly synthsession_advance: (a: number) => [number, number, number, number];
+    readonly synthsession_export_gridfm: (a: number) => [number, number, number, number];
+    readonly synthsession_ingest: (a: number) => [number, number, number, number];
+    readonly synthsession_module: (a: number) => [number, number, number, number];
+    readonly synthsession_new: (a: number, b: number, c: number, d: number) => [number, number, number];
+    readonly synthsession_preview: (a: number) => [number, number, number, number];
+    readonly synthsession_preview_buffers: (a: number) => number;
+    readonly synthsession_report: (a: number) => [number, number, number, number];
+    readonly synthsession_stage: (a: number) => [number, number];
+    readonly wasm_bindgen__convert__closures_____invoke__h1c534e945ee6d3b6: (a: number, b: number, c: any) => [number, number];
+    readonly wasm_bindgen__convert__closures_____invoke__h67ba427e9454f1d8: (a: number, b: number, c: any, d: any) => void;
     readonly __wbindgen_exn_store: (a: number) => void;
     readonly __externref_table_alloc: () => number;
     readonly __wbindgen_externrefs: WebAssembly.Table;