smithkit 0.0.0-stage → 0.1.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Krzysztof Rosiński
+
+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/README.md

@@ -1,3 +1,468 @@
-# Temporary Holding Version
+# Smithkit
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+**`smithkit`** is a framework-independent JavaScript and TypeScript library for
+interactive SVG Smith charts, RF calculations, and S11 measurement exploration.
+
+[Try the interactive demo](https://rosek86.github.io/smithkit/).
+
+## Features
+
+- Labeled resistance, reactance, conductance, and susceptance grids.
+- Configurable constant-Q and constant-VSWR circles.
+- Zoom, pan, view reset, and cursor readings.
+- Named traces with colors, visibility, and draggable markers that snap to samples.
+- Marker comparisons: frequency, complex impedance, and wrapped phase differences.
+- Physical impedance/admittance conversions and DOM-independent RF readings.
+- Twelve parameter scales mounted independently of chart zoom.
+- Four peripheral rulers for phase and electrical length.
+- One-port Touchstone 1.x import with RI, MA, and DB representations.
+- ESM modules and TypeScript declarations.
+
+## Installation
+
+Install from npm:
+
+```sh
+npm install smithkit
+```
+
+Browser applications need SVG, ES2022, and an ESM-compatible build tool.
+No library stylesheet is required. To build the library from source, see
+[Contributing](https://github.com/rosek86/smithkit/blob/main/CONTRIBUTING.md).
+
+For a complete application using the installed package, see the
+[standalone integration example](https://github.com/rosek86/smithkit/tree/main/examples/basic).
+It demonstrates mounting, replacing samples, event subscriptions, resizing, and cleanup.
+
+## Quick start
+
+Give the container an explicit size and run the code after it is mounted:
+
+```html
+<div id="smith" style="width: 100%; max-width: 700px; aspect-ratio: 1;"></div>
+```
+
+```ts
+import { Smith } from 'smithkit';
+
+const chart = new Smith(50); // Reference impedance in ohms; defaults to 50.
+chart.draw('#smith');
+const traceId = chart.addTrace(
+  [
+    { frequencyHz: 1e9, reflectionCoefficient: [0.5, -0.5] },
+    { frequencyHz: 1.5e9, reflectionCoefficient: [0, 0] },
+    { frequencyHz: 2e9, reflectionCoefficient: [0.5, 0.5] },
+  ],
+  { name: 'Antenna', color: '#2563eb' },
+);
+```
+
+Each `TraceSample` contains `frequencyHz` and the dimensionless voltage reflection
+coefficient Γ as `[real, imaginary]`. Samples are copied and validated; readonly tuples and arrays (`as const`) are accepted. Frequencies
+must be finite and non-negative; both coordinates must be finite. A trace must
+contain at least one sample.
+
+Each new trace receives one marker on its first sample. Drag markers to select
+samples, scroll to zoom, and drag the chart to pan. Markers stay above all sample
+points. `chart.resetView()` restores the initial view, including peripheral rulers.
+
+Construct `Smith` only in a browser, such as your framework's mount hook. Importing
+the package and using its calculation or parsing functions does not require a DOM.
+
+Zoom is enabled by default. For a fixed view, call `chart.setZoomEnabled(false)` before or after mounting.
+It disables wheel/double-click zoom and mouse/touch panning and pinch zoom while
+preserving the current view. Set it back to `true` to restore gestures. This is a
+view control: cursor readings and marker dragging stay available. `resetView()`
+also remains available when zoom is disabled. New wheel gestures do not consume
+page scrolling. Disabling during an active gesture freezes the view while that
+gesture finishes normally.
+
+```ts
+import { Smith } from 'smithkit';
+
+const chart = new Smith(50);
+chart.setZoomEnabled(false);
+chart.draw('#smith');
+```
+
+`draw(selector | HTMLElement)` moves the existing SVG when called again. A missing
+container throws. Call `chart.destroy()` on unmount; it removes the SVG, releases
+event handlers, and cancels queued notifications. Repeated destruction is safe.
+
+## Traces and markers
+
+Trace and marker IDs are opaque strings, unique within a chart and never reused
+there. They survive renaming, hiding, updating samples, and removing other items.
+They are not persistent across chart instances or page reloads.
+
+```ts
+const markerA = chart.getTraces().find((trace) => trace.id === traceId)!.markers[0].id;
+const markerB = chart.addMarker(traceId, 2)!; // Zero-based sample index.
+
+chart.setTraceOptions(traceId, { name: 'Tuned antenna', visible: true });
+chart.setMarkerSample(markerB, 1);
+console.log(chart.getMarker(markerB)?.frequencyHz); // 1.5e9
+
+const difference = chart.compareMarkers(markerA, markerB);
+console.log(difference?.frequencyDeltaHz); // B − A, in Hz.
+console.log(difference?.impedanceDeltaOhms?.toVector());
+console.log(difference?.phaseDeltaDegrees);
+
+chart.removeMarker(markerB);
+```
+
+| Method                                | Result / behavior                                                                                                        |
+| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
+| `addTrace(samples, options?)`         | Returns a trace ID. Options: nonblank `name`, solid CSS `color`, and `visible`.                                          |
+| `getTraces()`                         | Detached `TraceInfo` snapshots: ID, name, color, visibility, sample count, and marker metadata.                          |
+| `setTraceOptions(id, options)`        | Updates the supplied options only. Invalid options throw before any change.                                              |
+| `updateTrace(id, samples, options?)`  | Replaces samples and preserves identity, appearance, and markers. Empty/invalid input throws without changing the trace. |
+| `removeTrace(id)`                     | Removes the trace and its markers.                                                                                       |
+| `clearTraces()`                       | Removes all traces and their markers.                                                                                    |
+| `addMarker(traceId, sampleIndex = 0)` | Returns a marker ID, or `undefined` if the trace is missing.                                                             |
+| `getMarker(id)`                       | Returns a `MarkerSnapshot`, or `undefined` if missing.                                                                   |
+| `setMarkerSample(id, sampleIndex)`    | Selects an existing sample and queues a marker notification.                                                             |
+| `removeMarker(id)`                    | Removes one marker without renumbering the remaining markers.                                                            |
+| `compareMarkers(a, b)`                | Returns B − A, or `undefined` if either marker is missing.                                                               |
+| `referenceImpedanceOhms`              | Read-only reference impedance. Must be positive and finite.                                                              |
+
+Update/remove methods return a boolean: `false` means the ID was not found.
+Sample indices must be zero-based integers within the trace; invalid indices throw
+`RangeError`. Sample replacement follows the nearest measured frequency by default.
+Pass `{ markerSelection: 'sample-index' }` to retain indices (clamped to the new last
+sample if the trace shrinks), or `{ markerSelection: 'reflection' }` to select the
+nearest Γ. Frequency and Γ ties select the earlier sample in input order, including
+unsorted sweeps and duplicate frequencies. Selection uses the actual selected sample,
+not a previous requested frequency. No interpolation is performed.
+
+```ts
+chart.updateTrace(
+  traceId,
+  [
+    { frequencyHz: 1e9, reflectionCoefficient: [0.2, 0] },
+    { frequencyHz: 2e9, reflectionCoefficient: [0.3, 0] },
+  ],
+  { markerSelection: 'frequency' },
+);
+```
+
+Invalid strategies throw `TypeError`; empty or invalid samples throw `RangeError`
+before mutation. Unknown trace IDs return `false` without validating input.
+Renormalization always preserves sample indices because it transforms the existing
+sweep rather than replacing it.
+
+Trace snapshots contain `markers: { id, number, sampleIndex }[]`. `number` is the
+stable display number within that trace. A `MarkerSnapshot` includes the common
+RF reading fields below plus `traceId`, `markerId`, `markerNumber`, `sampleIndex`,
+and `frequencyHz`.
+
+Hiding a trace hides its points and markers while retaining measurements for
+comparisons. Hiding or deleting a dragged marker/trace ends the drag. Mutations
+after destruction throw; trace/marker lookups return empty or missing results.
+
+## Trace appearance
+
+Pass `mode: 'points' | 'line' | 'both'`, `lineWidth`, and `pointRadius` to
+`addTrace` or `setTraceOptions`. Defaults are points, 2 px line width, and 2 px point radius. Both sizes are
+CSS pixels and remain constant under chart zoom and container resize. Widths and radii must be positive and finite.
+`getTraces()` includes the current style.
+
+Lines connect all samples in input order, without smoothing or frequency sorting.
+A line-only trace creates one SVG path and no sample circles, suitable for dense
+sweeps. Points/both render every sample for traces up to 5,000 samples. Larger traces
+render one representative per point-radius-sized display cell and skip points
+outside the viewport; representatives are recalculated during zoom/pan.
+This only simplifies the image: all original samples remain available to markers,
+snapping, readouts, and comparisons. Lines still connect every input sample.
+Styles do not change marker identity or layer ordering. Hidden traces retain their style after sample replacement.
+The demo exposes the same controls per trace.
+
+## Events and readings
+
+`onEvent(listener)` supports multiple independent subscriptions and returns an
+unsubscribe function. `SmithEvent` is a discriminated union: checking `type`
+narrows `data` without a cast or a property-presence test.
+
+```ts
+import { SmithEventType } from 'smithkit';
+
+const unsubscribe = chart.onEvent((event) => {
+  if (event.type === SmithEventType.Cursor) {
+    // undefined when the pointer leaves or a marker drag starts.
+    console.log(event.data?.impedanceOhms?.toVector());
+    return;
+  }
+  // Marker, MarkerDragStart, and MarkerDragEnd always carry a MarkerSnapshot.
+  console.log(event.data.markerId, event.data.frequencyHz);
+});
+
+// On component unmount:
+unsubscribe();
+chart.destroy();
+```
+
+The event types are `Cursor` (`'cursor'`), `Marker` (`'marker'`),
+`MarkerDragStart` (`'marker-drag-start'`), and `MarkerDragEnd` (`'marker-drag-end'`).
+Cursor movement is suspended during marker dragging. Drag start/end events fire
+synchronously; marker position notifications are queued and report the latest
+snapshot at delivery. Before delivery, repeated updates to the same marker coalesce
+into one notification; different markers have independent notifications. Creation
+queues an initial marker notification too. Removed markers cannot deliver queued
+position events.
+Trace metadata changes do not emit marker events; refresh metadata after mutations.
+Destruction suppresses application callbacks.
+
+`chart.cursorReading` returns the last cursor position. Cursor and marker readings
+share `SmithReading`; `readReflection(gamma, referenceImpedanceOhms = 50)` produces
+the same reading without constructing a chart.
+
+| Fields                                                                               | Units / meaning                                                        |
+| ------------------------------------------------------------------------------------ | ---------------------------------------------------------------------- |
+| `reflectionCoefficient`                                                              | Complex, dimensionless voltage Γ.                                      |
+| `impedanceOhms`, `admittanceSiemens`                                                 | Physical complex Z in Ω and Y in S. Multiply Y by 1000 for mS display. |
+| `phaseDegrees`                                                                       | Phase of Γ in degrees; undefined at Γ = 0.                             |
+| `vswr`, `q`                                                                          | Dimensionless voltage standing-wave ratio and \|X/R\|.                 |
+| `returnLossDb`, `reflectionLossDb`                                                   | dB. Reflection loss is also called mismatch loss.                      |
+| `standingWaveRatioDb`                                                                | 20 log₁₀(VSWR), in dB.                                                 |
+| `attenuationDb`                                                                      | Half the return loss; interpretation described below.                  |
+| `powerReflectionCoefficient`, `powerTransmissionCoefficient`                         | \|Γ\|² and 1 − \|Γ\|².                                                 |
+| `voltageReflectionCoefficientMagnitude`                                              | \|Γ\|.                                                                 |
+| `voltageTransmissionCoefficientMagnitude`, `currentTransmissionCoefficientMagnitude` | \|1 + Γ\| and \|1 − Γ\|, respectively.                                 |
+| `standingWavePeak`, `standingWaveLossCoefficient`                                    | √VSWR and (1 + \|Γ\|²)/(1 − \|Γ\|²).                                   |
+
+Singular Z at Γ = +1 and Y at Γ = −1 are `undefined`. Q is undefined at an open
+or short, and infinite for a nonzero purely reactive impedance. Finite points near
+these limits retain finite readings within the supported numeric range. An exact
+infinite scalar limit is preserved: perfect match gives infinite return loss;
+\|Γ\| = 1 gives infinite VSWR and reflection loss.
+
+For active loads (\|Γ\| > 1), VSWR, standing-wave quantities, reflection loss,
+attenuation, and power transmission are `undefined`. Other quantities remain
+available. Non-finite complex inputs or invalid reference impedances throw
+`RangeError` in the public RF functions. Unrepresentable complex conversion
+results are `undefined`.
+
+## Selecting a marker by frequency
+
+`chart.setMarkerFrequency(markerId, frequencyHz)` selects the nearest measured
+frequency and returns `true`, or `false` if the marker does not exist. It accepts
+finite, non-negative Hz values; other values throw `RangeError`. It works with
+unsorted sweeps and duplicate frequencies. Equal-distance ties choose the earliest
+sample in input order. Requests outside the sweep select the nearest endpoint.
+No interpolation or sample reordering is performed.
+
+Read `chart.getMarker(markerId).frequencyHz` for the actual selected frequency.
+The same queued `Marker` event is emitted as for sample-index selection, and
+comparisons update accordingly. The demo accepts MHz and shows the selected
+measurement frequency; dragging and sample selection keep that field synchronized.
+
+## Calculations without a chart
+
+```ts
+import { Complex, readReflection, impedanceToReflection } from 'smithkit';
+
+const gamma = impedanceToReflection(Complex.from(75, 25), 50)!;
+const reading = readReflection(gamma, 50);
+console.log(reading.impedanceOhms?.toVector()); // Approximately [75, 25].
+console.log(reading.admittanceSiemens?.toVector());
+```
+
+| Function                                                                 | Input and output                                                                                                |
+| ------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------- |
+| `reflectionToImpedance(gamma, referenceImpedanceOhms = 50)`              | Γ → physical Z in Ω.                                                                                            |
+| `impedanceToReflection(impedanceOhms, referenceImpedanceOhms = 50)`      | Physical Z in Ω → Γ.                                                                                            |
+| `reflectionToAdmittance(gamma, referenceImpedanceOhms = 50)`             | Γ → physical Y in S.                                                                                            |
+| `admittanceToReflection(admittanceSiemens, referenceImpedanceOhms = 50)` | Physical Y in S → Γ.                                                                                            |
+| `readReflection(gamma, referenceImpedanceOhms = 50)`                     | Complete `SmithReading`.                                                                                        |
+| `compareMarkerReadings(a, b)`                                            | Compare readings without a chart. Each input needs `frequencyHz`, `reflectionCoefficient`, and `impedanceOhms`. |
+
+Comparison results contain `frequencyDeltaHz`, `impedanceDeltaOhms`, and
+`phaseDeltaDegrees`. Phase differences use B − A wrapped to **[−180°, 180°)**:
+179° → −179° gives +2°; an exact half turn gives −180°. Phase is undefined if
+either Γ is zero or non-finite. Impedance differences are undefined if either Z
+is singular or non-finite. Frequencies must be finite and non-negative. This is
+a point comparison, not sweep phase unwrapping or group delay.
+
+`Complex.from(re, im)` constructs complex numbers. Read components through `re` and `im`. Arithmetic (`add`, `sub`,
+`mul`, `div`, `pow`) returns new values. The class also provides `abs`, `arg`
+(radians), and static functions such as `Complex.conj`, `Complex.sqrt`,
+`Complex.exp`, `Complex.log`, and trigonometric/hyperbolic functions and inverses. `toVector()` returns `[real, imaginary]`; `toString(dp)` formats
+a Cartesian value. See the exported declarations for all operations.
+
+Formatting helpers are independent exports: `formatNumber(value)` (three significant
+digits and SI prefixes), `formatComplex(value, unit?, decimalPlaces?)`, and
+`formatComplexPolar(value, unit?, decimalPlaces?)` (phase in degrees). They work
+without a chart or DOM. Complex formatters default to three fractional digits.
+`formatNumber` includes spacing so you can append a unit, e.g. `formatNumber(1e9) + 'Hz'`.
+
+`reactanceToComponent(reactanceOhms, frequencyHz)` calculates an ideal equivalent
+series component without formatting or constructing a chart:
+
+```ts
+import { reactanceToComponent, formatNumber } from 'smithkit';
+
+const component = reactanceToComponent(-50, 1e9);
+if (component?.kind === 'capacitor') {
+  console.log(formatNumber(component.capacitanceFarads) + 'F'); // 3.18 pF
+} else if (component?.kind === 'inductor') {
+  console.log(formatNumber(component.inductanceHenries) + 'H');
+}
+```
+
+Use `reading.impedanceOhms.im` for the reactance when impedance is defined.
+Zero frequency, zero reactance, and unrepresentable results return `undefined`.
+Non-finite reactance or negative/non-finite frequency throws `RangeError`.
+This is a single-frequency equivalence, not a fitted circuit model.
+
+## Grid layers
+
+Resistance and reactance are initially visible. Conductance, susceptance, Q,
+and VSWR layers start hidden. All controls are under `chart.layers`:
+
+```ts
+chart.layers.resistance.setVisible(false);
+chart.layers.reactance.setVisible(false);
+chart.layers.conductance.setVisible(true);
+chart.layers.susceptance.setVisible(true);
+chart.layers.conductance.setMinorVisible(false);
+chart.layers.susceptance.setStyle({ stroke: '#64748b', textColor: '#2a7f62' });
+chart.layers.vswr.addValue(4);
+chart.layers.vswr.setVisible(true);
+```
+
+The four grid layers support `setVisible`, `setMinorVisible`, and
+`setStyle(Partial<GridStyle>)`. Style fields: `stroke`, `majorWidth`, `minorWidth`,
+`textColor`, `textFontFamily`, `textFontSize`. Widths are positive finite numbers
+in CSS pixels. Font size is a positive finite number in chart units because labels
+scale with the grid geometry. Partial updates retain other settings. Invalid numeric
+styles throw before any property is changed.
+
+`layers.q` and `layers.vswr` support `setVisible`,
+`setStyle({ stroke?, strokeWidth? })`, `addValue`, and `removeValue`.
+Circle stroke widths are positive finite numbers in CSS pixels.
+Q values must be positive and finite; VSWR values must be finite and at least 1.
+Duplicate additions and removal of absent values have no effect.
+
+Grid labels use normalized values; readings use physical units. Strokes default
+to slate gray with 1 px major and 0.6 px minor lines. Stroke widths stay constant
+under zoom; label sizes use SVG user units. Layer controls do not expose drawing
+objects or SVG nodes.
+
+## Parameter scales
+
+Mount `SmithScales` independently so its twelve axes stay outside chart zoom:
+
+```ts
+import { SmithScales, SmithEventType } from 'smithkit';
+
+const scales = new SmithScales();
+scales.draw('#smith-scales'); // Provide a separate mounted container.
+const stopScales = chart.onEvent((event) => {
+  if (event.type === SmithEventType.Cursor || event.type === SmithEventType.Marker) {
+    const gamma = event.data?.reflectionCoefficient ?? null;
+    scales.update(gamma);
+    chart.peripheralScales.update(gamma);
+  }
+});
+
+// On unmount: stopScales(); scales.destroy(); chart.destroy();
+```
+
+`update(Complex | null)` synchronizes indicators, values, tooltips, and accessible
+labels. Null, non-finite, or active-load inputs hide indicators. `draw` accepts a
+selector or `HTMLElement`; `destroy` is idempotent. Scales adapt to container width.
+
+Labels follow the complete Smith chart terminology: **Reflection loss**,
+**Power reflection coefficient**, **Power transmission coefficient**, and separate
+**Voltage transmission coefficient** and **Current transmission coefficient**.
+Ratios are dimensionless; loss/standing-wave dB axes are in dB. Transmission
+indicators depend on Γ phase as well as magnitude.
+
+Attenuation is −10 log₁₀\|Γ\|, half the return loss. Its one-way loss interpretation
+assumes a matched line or attenuator terminated in an open or short: the reflected
+wave traverses it twice. It does not measure insertion loss of an arbitrary load
+from S11 alone. At \|Γ\| = 0.1 it reads 10 dB, while return loss reads 20 dB.
+
+`chart.peripheralScales` supports `setVisible(boolean)` and `update(Complex | null)`.
+Its four rulers zoom with the chart: reflection phase, voltage transmission phase,
+wavelengths toward generator, and wavelengths toward load. Wavelength rulers start
+at the negative real axis, with 0.5 λ per revolution (generator clockwise, load
+counterclockwise). These are electrical-length coordinates modulo 0.5 λ.
+Reflection phase and wavelength coordinates are undefined at perfect match;
+transmission phase is undefined at Γ = −1.
+
+Scale conventions follow the [complete Smith chart reference](https://www.uiyinc.com/assets/The-Complete-Smith-Chart-Black-Magic-Design.jpg)
+and [CERN's Smith chart introduction](https://arxiv.org/abs/1201.4068).
+
+## Reference impedance and renormalization
+
+`chart.renormalize(referenceImpedanceOhms)` changes the positive real reference
+impedance and transforms every loaded Γ to preserve physical Z. Trace/marker IDs,
+names, colors, visibility, frequencies, and selected sample indices are retained.
+Results for all traces are validated before any change; a singular/unrepresentable
+result rejects the operation without changing Z₀ or data. Active marker drags end,
+cursor indicators are cleared, and marker readings are queued with the new values.
+Changing to the current Z₀ has no effect. Mutations after destruction throw.
+
+Two DOM-independent helpers are also exported:
+
+- `renormalizeReflection(gamma, fromOhms, toOhms)` returns the new complex Γ or
+  `undefined` for a singular/unrepresentable result. Exact open and short limits
+  remain Γ = +1 and −1. References must be positive, finite, real ohm values.
+- `renormalizeSamples(samples, fromOhms, toOhms)` returns a new sample array in
+  the same order, preserving frequencies. Invalid samples or a singular result
+  throw `RangeError`; the input is never modified.
+
+For example, a matched 75 Ω load has Γ = 0 at 75 Ω and Γ = 0.2 at 50 Ω.
+Renormalization changes Γ, VSWR, and loss readings; physical impedance stays 75 Ω.
+Simply relabeling the same Γ with a new Z₀ would describe a different load.
+
+The demo exposes chart Z₀ and explicitly renormalizes existing traces when applied.
+Import renormalization is enabled by a labeled checkbox. Disable it to reject
+files whose reference differs from the chart. Complex reference impedances and
+multiport renormalization are outside the supported scope.
+
+## Touchstone import
+
+`parseTouchstone(text)` returns `{ samples, referenceImpedanceOhms }`. It accepts
+one-port Touchstone 1.x, converts RI/MA/DB into Cartesian Γ and all frequencies
+into Hz, and throws for unsupported or invalid input.
+
+```ts
+import { Smith, parseTouchstone } from 'smithkit';
+
+async function showMeasurement(file: File): Promise<Smith> {
+  const { samples, referenceImpedanceOhms } = parseTouchstone(await file.text());
+  const chart = new Smith(referenceImpedanceOhms);
+  chart.draw('#smith');
+  chart.addTrace(samples, { name: file.name });
+  return chart;
+}
+```
+
+Omitted options use Touchstone defaults: GHz, S, MA, 50 Ω. For an existing chart,
+use `renormalizeSamples` when the file reference differs from
+`chart.referenceImpedanceOhms`. The parser itself does not renormalize data.
+Multiport data and Touchstone 2.x are not supported.
+
+## Development and license
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development, testing, release, and demo
+hosting instructions. Licensed under [MIT](LICENSE).
+
+## Numerical limits
+
+`Complex` uses JavaScript binary64 numbers. Multiplication and division scale
+intermediate products to avoid premature overflow and underflow; logarithms,
+square roots, and reciprocals also handle extreme finite components. Results still
+round to binary64: unrepresentable magnitudes become infinity and tiny results
+can underflow to signed zero. Division by zero and reciprocals at zero return
+`[NaN, NaN]`. These operations reject non-finite operands with NaN components.
+The principal logarithm of zero retains its `-Infinity` real limit, and signed
+zeros select the side of square-root and logarithm branch cuts. `pow(z, 0)` is one,
+including zero to the zeroth power; negative powers of zero are undefined.
+
+RF helpers validate finite inputs and use `undefined` for unrepresentable complex
+readings, including an overflowing impedance difference between markers. These
+conventions do not imply arbitrary precision or numerical certification of every
+transcendental operation.

package/dist/lib/Smith.d.ts

@@ -0,0 +1,103 @@
+import { TraceSamples } from './samples.js';
+import type { ChartLayers, PeripheralScales } from './layers.js';
+import type { SmithReading } from './rf.js';
+import type { TraceOptions, TraceUpdateOptions, TraceInfo, MarkerSnapshot, MarkerComparison } from './measurements.js';
+export declare enum SmithEventType {
+    Cursor = "cursor",
+    Marker = "marker",
+    MarkerDragStart = "marker-drag-start",
+    MarkerDragEnd = "marker-drag-end"
+}
+export type SmithEvent = {
+    type: SmithEventType.Cursor;
+    data: SmithReading | undefined;
+} | {
+    type: SmithEventType.Marker | SmithEventType.MarkerDragStart | SmithEventType.MarkerDragEnd;
+    data: MarkerSnapshot;
+};
+export declare class Smith {
+    private referenceOhms;
+    private calcs;
+    private scalers;
+    private transform;
+    private zoomEnabled;
+    private applyingView;
+    private zoomBehavior;
+    private svg;
+    private resizeObserver;
+    private container;
+    private dataContainer;
+    private markerContainer;
+    private reactanceAxis;
+    private constResistance;
+    private constReactance;
+    private constConductance;
+    private constSusceptance;
+    private constSwrCircles;
+    private constQCircles;
+    private cursor;
+    private peripheralScaleRenderer;
+    private data;
+    private destroyed;
+    private mouseGesture;
+    private nextDatasetColor;
+    private nextTraceId;
+    private nextMarkerId;
+    private traceMetadata;
+    private markerIds;
+    private draggedMarkers;
+    private cursorBeforeMarkerDrag;
+    private listeners;
+    readonly layers: ChartLayers;
+    readonly peripheralScales: PeripheralScales;
+    constructor(referenceOhms?: number);
+    draw(target: string | HTMLElement): void;
+    /** Remove this chart and release its event handlers. Safe to call more than once. */
+    destroy(): void;
+    private updateViewportScale;
+    private assertAlive;
+    private createScalers;
+    private cursorMove;
+    private markerDragChanged;
+    private initCursor;
+    /** Last cursor position. Use cursor events to detect pointer leave. */
+    get cursorReading(): SmithReading;
+    private initializeZoom;
+    /** Enable or disable wheel, double-click, and mouse/touch zoom/pan. Keeps the current view. */
+    setZoomEnabled(enabled: boolean): void;
+    private applyView;
+    resetView(): void;
+    private onZoom;
+    private cursorContainer;
+    private drawReactanceAxis;
+    /** Add a named trace with one initial marker. Returns a chart-local, stable ID. */
+    addTrace(values: TraceSamples, options?: TraceOptions): string;
+    /** Detached metadata snapshots; IDs and marker display numbers survive removals. */
+    getTraces(): TraceInfo[];
+    private traceIndex;
+    private markerId;
+    private findMarker;
+    private validateTraceOptions;
+    setTraceOptions(id: string, options: TraceOptions): boolean;
+    /** Replace samples; by default each marker follows its nearest measured frequency. */
+    updateTrace(id: string, values: TraceSamples, options?: TraceUpdateOptions): boolean;
+    removeTrace(id: string): boolean;
+    /** Place a marker on an existing sample; no interpolation is performed. */
+    addMarker(traceId: string, sampleIndex?: number): string | undefined;
+    removeMarker(id: string): boolean;
+    setMarkerSample(id: string, sampleIndex: number): boolean;
+    /** Select the nearest measured frequency; ties choose the earliest input sample. */
+    setMarkerFrequency(id: string, frequencyHz: number): boolean;
+    getMarker(id: string): MarkerSnapshot | undefined;
+    /** Return B − A, or undefined if either marker no longer exists. */
+    compareMarkers(a: string, b: string): MarkerComparison | undefined;
+    /** Current positive real reference impedance, in ohms. */
+    get referenceImpedanceOhms(): number;
+    /** Renormalize all traces while retaining physical impedance, IDs, and selected sample indices. */
+    renormalize(referenceImpedanceOhms: number): void;
+    clearTraces(): void;
+    private createSmithData;
+    /** Subscribe to chart events. The returned function removes this subscription. */
+    onEvent(listener: (event: SmithEvent) => void): () => void;
+    private emit;
+}