@tellegen/engine 0.1.0

package/dist/wasm-pkg/LICENSE-APACHE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Samuel Talkington
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/wasm-pkg/LICENSE-MIT

@@ -0,0 +1,19 @@
+Copyright (c) 2026 Samuel Talkington and contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/wasm-pkg/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "tellegen-wasm",
+  "type": "module",
+  "description": "WebAssembly browser adapter for the tellegen power flow engine.",
+  "version": "0.1.0",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/eigenergy/tellegen"
+  },
+  "files": [
+    "tellegen_bg.wasm",
+    "tellegen.js",
+    "tellegen.d.ts"
+  ],
+  "main": "tellegen.js",
+  "types": "tellegen.d.ts",
+  "sideEffects": [
+    "./snippets/*"
+  ]
+}

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

@@ -0,0 +1,250 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * A build-once handle over the engine, exported to JS. Construct once per case (the
+ * network is parsed and the model built here); then [`replace_edits`](Study::replace_edits)
+ * solves exactly at an absolute edit state and [`preview_replacement`](Study::preview_replacement)
+ * returns a first-order linearization toward an absolute edit state — neither re-parses
+ * the network, unlike `solve_json` which rebuilds it on every call. This is
+ * the path a reactive drag should use.
+ *
+ * Arguments and results are JSON in the engine's `Study` shapes: edits are a
+ * `NetworkEdit[]` (e.g. `[{"kind":"add_load","bus":2,"p_mw":50}]`; the element key
+ * also accepts the powerio row uid string `ingest_case` stamps, e.g.
+ * `"bus":"buses:1"`), `preview` watches an
+ * `Operand[]` (e.g. `[{"Price":"Active"}]`) and returns a `Preview`. `commit` takes the
+ * edits plus a `SensRequest[]` of watched cells and returns `{ solution, iterations,
+ * sensitivities }` — the committed [`SolveResponse`] plus the requested ∂operand/∂param
+ * columns, computed in the *same* solve (no second round-trip). Only in the sensitivity
+ * build (preview needs the differentiable path).
+ */
+export class Study {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Apply a geographic layer (a canonical `.geo.json` from [`parse_geo`] or
+     * [`apply_layout`]) onto this study's base network, so a later
+     * [`save_package`](Study::save_package) or export carries the coordinates
+     * on screen. Locations are metadata the model never reads; nothing
+     * re-solves. Returns the apply report JSON.
+     */
+    apply_geo(layer_geojson: string): string;
+    /**
+     * Apply `edits_json` (a `NetworkEdit[]`) at the committed point and exact-re-solve,
+     * attaching the `sensitivities_json` cells (a `SensRequest[]`, or empty/blank for
+     * none) in the same solve. Advances the committed point. Returns
+     * `{ "solution": SolveResponse, "iterations": Iterations, "sensitivities":
+     * SensitivityMatrix[] }` — `solution` is the full committed response, and
+     * `iterations` / `sensitivities` mirror its convergence trace and the watched
+     * columns so the UI renders the ∂LMP/∂d column without a second solve.
+     */
+    commit(edits_json: string, sensitivities_json: string): string;
+    /**
+     * The formulation tag (`"dcopf"` / `"acpf"`).
+     */
+    formulation(): string;
+    /**
+     * Build a study over `network_json` for `formulation` (`"dcopf"` / `"acpf"`, and —
+     * in a build that includes them — `"socwr"` / `"acopf"`), solving the base case.
+     * Errors on an unknown or not-built formulation.
+     */
+    constructor(network_json: string, formulation: string);
+    /**
+     * First-order preview of `edits_json` (a `NetworkEdit[]`) for the `watched_json`
+     * operands (an `Operand[]`), at the committed point, without re-solving. Returns the
+     * `Preview` JSON.
+     */
+    preview(edits_json: string, watched_json: string): string;
+    /**
+     * First-order preview for replacing the committed edit set with `edits_json`.
+     * This accepts absolute demand delta state and internally previews only the step
+     * from the current committed point.
+     */
+    preview_replacement(edits_json: string, watched_json: string): string;
+    /**
+     * Replace the committed edit set with `edits_json` and exact-re-solve, attaching
+     * the `sensitivities_json` cells in the same solve. Use this for UI state that stores
+     * absolute demand deltas from the base case.
+     */
+    replace_edits(edits_json: string, sensitivities_json: string): string;
+    /**
+     * Serialize this study as a `.pio.json` package: the base network is the payload,
+     * the edit log is the study block (one commit per `commit` call, keyed by row uid),
+     * and the formulation and solve options ride under `study.app["tellegen"]`. Returns
+     * the package JSON, ready to download or hand to [`export_study`].
+     */
+    save_package(): string;
+    /**
+     * The most recent committed solution as `SolveResponse` JSON.
+     */
+    solution(): string;
+}
+
+/**
+ * Fill case coordinates from a PowerWorld `.pwd` sibling: substation symbols
+ * project to approximate longitude/latitude and join onto buses through the
+ * `SubNum` extras key. Returns the refreshed `ingest_case` payload plus a
+ * `report`; errors when no bus joined.
+ */
+export function apply_display_geo(network_json: string, bytes: Uint8Array): string;
+
+/**
+ * Apply a [`parse_geo`] layer onto a case network: matched bus points land in
+ * `Bus.location`, matched routes in `Branch.route` (matching by uid, external
+ * id, name, and the unordered endpoint pair — upstream semantics). Returns
+ * the refreshed `ingest_case` payload plus a `report` of matched/unmatched
+ * counts; errors when nothing matched.
+ */
+export function apply_geo(network_json: string, layer_geojson: string): string;
+
+/**
+ * Stamp a computed layout (bus id => `[lon, lat]`) onto a case network with
+ * `kind` provenance (`synthetic` or `manual`). Returns the refreshed
+ * `ingest_case` payload plus `layer`, the stamped layout as a canonical
+ * `.geo.json` document.
+ */
+export function apply_layout(network_json: string, coords_json: string, kind: string): string;
+
+/**
+ * The capability matrix as JSON: which `(formulation, operand, parameter)` cells this
+ * build supports, so the UI can populate menus and grey out the rest.
+ */
+export function capabilities_json(): string;
+
+/**
+ * Export the balanced study state at commit `commit` to a powerio `format`
+ * (`matpower`, `psse`, `powerio-json`, ...). Returns `{ text, warnings, format,
+ * extension }` as JSON: the serialized case, the writer's fidelity warnings so the
+ * frontend can surface them, and the format token and file extension. The package
+ * JSON is untrusted; malformed input returns a `JsError`, never a panic.
+ */
+export function export_study(package_json: string, commit: number, format: string): string;
+
+/**
+ * A case's coordinates as a canonical `.geo.json` document (one point per
+ * located bus, one route per routed branch, provenance preserved). Errors
+ * when the case carries none.
+ */
+export function extract_geo(network_json: string): string;
+
+/**
+ * Everything the drop panel needs from one parse: counts, total load and
+ * capacity, parse warnings, and a `view` of buses and branches in the shape
+ * the tellegen API serves, placed at the coordinates the file carries
+ * (PowerWorld complete case aux exports). `view` is null when the file has no
+ * coordinates.
+ */
+export function ingest_case(text: string, format: string): string;
+
+/**
+ * The distribution counterpart of [`ingest_case`]: view a multiconductor case
+ * with no solve. `format` is a distribution reader token (`dss`, `bmopf`,
+ * `pmd`) parsed by [`powerio_dist`], or `pio` for a `.pio.json` package
+ * carrying a multiconductor payload. Returns the drop-panel payload JSON:
+ * name, element counts, connected load/generation (kW), parse warnings,
+ * coordinate provenance, and the bus/terminal graph the frontend renders (see
+ * [`dist`]).
+ *
+ * Untrusted input: the parse and package restore return error strings (mapped
+ * to `JsError` here), so a malformed, truncated, or oversized `.dss`/JSON
+ * rejects cleanly and never panics the wasm instance.
+ */
+export function ingest_dist_case(text: string, format: string): string;
+
+/**
+ * Restore a study saved by [`Study::save_package`]. Returns a JSON bundle the frontend
+ * reads to rebuild its case, edit sliders, formulation, and solve options in one step.
+ * See [`load_package_bundle`] for the shape and the fail-closed contract.
+ */
+export function load_package(package_json: string): string;
+
+/**
+ * Parse a case file (MATPOWER, PSS/E RAW, PowerWorld aux, PowerModels or
+ * egret JSON) and return `{"network": ..., "warnings": [...]}` as JSON.
+ */
+export function parse_case(text: string, format: string): string;
+
+/**
+ * Decode a PowerWorld `.pwd` display file (binary). Returns the substation
+ * symbols at the diagram coordinates the file stores (x east, y north) plus
+ * the canvas size, each with the approximate `lon`/`lat` projection
+ * (`pwd_mercator_to_lonlat`; hand edited diagrams drift from it). A `.pwd`
+ * carries no buses or branches. `format` is "pwd". Pure in-memory parsing,
+ * no filesystem, so it runs in the browser.
+ */
+export function parse_display(bytes: Uint8Array, format: string): string;
+
+/**
+ * Parse a geographic sidecar (buscoords CSV, aliased CSV/JSON records,
+ * GeoJSON) from raw dropped bytes; `hint` is the file name ("" to sniff).
+ * Returns `{ layer, warnings, n_points, n_routes }` — the layer as its
+ * canonical `.geo.json` document, ready for [`apply_geo`]. Untrusted input
+ * rejects as a `JsError`, never a panic.
+ */
+export function parse_geo(bytes: Uint8Array, hint: string): string;
+
+/**
+ * The stateless solve front door: a [`SolveRequest`](tellegen::SolveRequest) JSON
+ * in, a [`SolveResponse`](tellegen::SolveResponse) JSON out. One-shot callers only;
+ * the reactive hot path is the [`Study`].
+ */
+export function solve_json(network_json: string, request_json: string): string;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly __wbg_study_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];
+    readonly capabilities_json: () => [number, number];
+    readonly export_study: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
+    readonly extract_geo: (a: number, b: number) => [number, number, number, number];
+    readonly ingest_case: (a: number, b: number, c: number, d: number) => [number, number, number, number];
+    readonly ingest_dist_case: (a: number, b: number, c: number, d: number) => [number, number, number, number];
+    readonly load_package: (a: number, b: number) => [number, number, 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 solve_json: (a: number, b: number, c: number, d: number) => [number, number, number, number];
+    readonly study_apply_geo: (a: number, b: number, c: number) => [number, number, number, number];
+    readonly study_commit: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
+    readonly study_formulation: (a: number) => [number, number];
+    readonly study_new: (a: number, b: number, c: number, d: number) => [number, number, number];
+    readonly study_preview: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
+    readonly study_preview_replacement: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
+    readonly study_replace_edits: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
+    readonly study_save_package: (a: number) => [number, number, number, number];
+    readonly study_solution: (a: number) => [number, number, number, number];
+    readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+    readonly __wbindgen_malloc: (a: number, b: number) => number;
+    readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+    readonly __externref_table_alloc: () => number;
+    readonly __wbindgen_externrefs: WebAssembly.Table;
+    readonly __externref_table_dealloc: (a: number) => void;
+    readonly __wbindgen_start: () => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+
+/**
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;