space-data-module-sdk 0.8.16 → 0.8.17

package/docs/module-publication-standard.html

@@ -54,7 +54,7 @@
 <li><a href="./families/effects.html"><span>Effects</span><span class="tag tag-planned">planned</span></a></li>
 </ul>
 <h2>Estimation, data and logic</h2><ul>
-<li><a href="./families/estimation.html"><span>Estimation</span><span class="tag tag-experimental">experimental</span></a></li>
+<li><a href="./families/estimation.html"><span>Estimation</span><span class="tag tag-shipped">shipped</span></a></li>
 <li><a href="./families/data-source.html"><span>Data source</span><span class="tag tag-shipped">shipped</span></a></li>
 <li><a href="./families/analytics.html"><span>Analytics</span><span class="tag tag-experimental">experimental</span></a></li>
 <li><a href="./families/scheduler.html"><span>Scheduler</span><span class="tag tag-planned">planned</span></a></li>

package/docs/node-red-default-node-parity.html

@@ -54,7 +54,7 @@
 <li><a href="./families/effects.html"><span>Effects</span><span class="tag tag-planned">planned</span></a></li>
 </ul>
 <h2>Estimation, data and logic</h2><ul>
-<li><a href="./families/estimation.html"><span>Estimation</span><span class="tag tag-experimental">experimental</span></a></li>
+<li><a href="./families/estimation.html"><span>Estimation</span><span class="tag tag-shipped">shipped</span></a></li>
 <li><a href="./families/data-source.html"><span>Data source</span><span class="tag tag-shipped">shipped</span></a></li>
 <li><a href="./families/analytics.html"><span>Analytics</span><span class="tag tag-experimental">experimental</span></a></li>
 <li><a href="./families/scheduler.html"><span>Scheduler</span><span class="tag tag-planned">planned</span></a></li>

package/docs/propagator-abi.md

@@ -110,6 +110,56 @@ shipping both is expected, and they must agree exactly (see
 `plugin_init_omm` REPLACES the element set. `plugin_ingest_omm_one` APPENDS
 and returns its handle — see [identity](#identity).
 
+### Ephemeris ingest
+
+| Export | Signature | Returns |
+|---|---|---|
+| `plugin_init_ephemeris` | `int32_t(const uint8_t* bytes, size_t len, uint32_t format)` | entities initialized (>0), or a negative [error code](#error-codes) |
+
+`format` is an `OrbProEphemerisFormat` member (`AUTO` = identify from the
+bytes). This is the ONLY legal door for an ephemeris container. It exists
+because `plugin_init` is bound to packed `OrbProOMMRecord` and MUST refuse a
+length that is not a whole multiple of that struct — so a DAF, a Code-500
+record stream or an STK `.e` body has no entry point through it, and passing
+one anyway is a size-lock violation dressed as an ingest. Do not smuggle
+ephemeris bytes through `plugin_init` as fake OMM records.
+
+An ephemeris provider is a propagator like any other. It exports
+`plugin_init_ephemeris` INSTEAD of the OMM/element ingest verbs, and is
+otherwise held to every rule on this page: `plugin_propagate` and
+`plugin_propagate_batch` agree exactly, output is **ECEF metres** (§[Frames](#frames)),
+padding bytes are zero, `plugin_destroy` really releases, and every failure
+carries its own code. The consumer seam does not change — the host still
+resolves it by name and drives it through `PropagatedPositionProperty`.
+
+Three obligations are specific to this verb:
+
+- **The frame is DECLARED, and this is the one family that may exit
+  non-ECEF.** Every other provider outputs ECEF because it computes in a frame
+  of its own choosing and the host cannot know which. An ephemeris container is
+  different: it states its frame outright (a `REF_FRAME` keyword, a DAF frame
+  code, an STK `CoordinateSystem`, SP3's terrestrial frame), and rotating a
+  J2000 kernel to ECEF so the consumer can rotate it straight back is two
+  interpolated rotations added to an answer that was already exact. So an
+  ephemeris provider emits the container's own frame and SAYS SO in
+  `StateVector.reference_frame`, set through
+  `orbpro_state_set_reference_frame()` — never by assigning the field, which
+  leaves the padding bytes stale.
+
+  The frame it names must be a member of the ABI's own `ReferenceFrame` roster,
+  translated by NAMED TOKEN. A native frame integer never crosses this seam:
+  five incompatible `ReferenceFrame` vocabularies meet here and `ECI == 0`,
+  `TEME == 0` and `FIXED == 0` all collide. A container whose declared frame
+  has no member on the roster is `UNSUPPORTED_FORMAT`, not a guess.
+- **Interpolation is declared, not implied.** A container that states its own
+  interpolation rule (SPK segment type, OEM `INTERPOLATION`/`INTERPOLATION_DEGREE`,
+  STK `InterpolationMethod`) is evaluated by THAT rule. A module that silently
+  substitutes its own is not reading the file, it is fitting one.
+- **Ingest is streamed, not slurped.** A multi-hundred-megabyte kernel that
+  loads on native WasmEdge and dies in the browser is a runtime-shaped branch.
+  Read the container by record and declare `initialMemoryBytes` /
+  `maximumMemoryBytes` rather than inheriting a per-lane default.
+
 ### Batch and introspection
 
 | Export | Signature | Returns |
@@ -348,6 +398,8 @@ the degradation ladder (transient → skip; fatal → respawn; exhausted → lat
 | `-4` | BAD_INPUT | malformed or short input buffer |
 | `-5` | NOT_CONVERGED | the solve failed to converge |
 | `-6` | UNPHYSICAL | the elements describe no closed orbit |
+| `-7` | UNSUPPORTED_FORMAT | the ephemeris container is not one this module reads, or `AUTO` could not identify it |
+| `-8` | EPOCH_OUT_OF_RANGE | the requested epoch lies outside every segment the loaded ephemeris covers |
 
 Rules that are not negotiable:
 

package/docs/protect-and-sign.html

@@ -54,7 +54,7 @@
 <li><a href="./families/effects.html"><span>Effects</span><span class="tag tag-planned">planned</span></a></li>
 </ul>
 <h2>Estimation, data and logic</h2><ul>
-<li><a href="./families/estimation.html"><span>Estimation</span><span class="tag tag-experimental">experimental</span></a></li>
+<li><a href="./families/estimation.html"><span>Estimation</span><span class="tag tag-shipped">shipped</span></a></li>
 <li><a href="./families/data-source.html"><span>Data source</span><span class="tag tag-shipped">shipped</span></a></li>
 <li><a href="./families/analytics.html"><span>Analytics</span><span class="tag tag-experimental">experimental</span></a></li>
 <li><a href="./families/scheduler.html"><span>Scheduler</span><span class="tag tag-planned">planned</span></a></li>

package/docs/protocol-installation.html

@@ -54,7 +54,7 @@
 <li><a href="./families/effects.html"><span>Effects</span><span class="tag tag-planned">planned</span></a></li>
 </ul>
 <h2>Estimation, data and logic</h2><ul>
-<li><a href="./families/estimation.html"><span>Estimation</span><span class="tag tag-experimental">experimental</span></a></li>
+<li><a href="./families/estimation.html"><span>Estimation</span><span class="tag tag-shipped">shipped</span></a></li>
 <li><a href="./families/data-source.html"><span>Data source</span><span class="tag tag-shipped">shipped</span></a></li>
 <li><a href="./families/analytics.html"><span>Analytics</span><span class="tag tag-experimental">experimental</span></a></li>
 <li><a href="./families/scheduler.html"><span>Scheduler</span><span class="tag tag-planned">planned</span></a></li>

package/docs/provider-access-abi.md

@@ -12,8 +12,33 @@ Nothing in the guest ABI names an engine, a tile scheme, or a vendor. The same
 three imports serve a browser engine's live quadtree cache, a host-side tile
 store, and a deterministic test fixture.
 
+## What this port is NOT
+
+Stated because it was read the other way and a consumer nearly built on it:
+this is a **raster tile** port. `sdm_provider_tile_desc_t.kind` has exactly two
+members — terrain and imagery — and every `acquire` operation (`tile`,
+`profile`, `region`) is geospatial. There is no `kind`, no `encoding` and no
+operation that describes a DAF record, an ephemeris block, a tracking-data
+message or any other non-raster container.
+
+A module that reads bytes which are not tiles does **not** use this port. It
+takes those bytes on a declared input port of its own method surface, as
+`data-source/oem-source-iss` does (`pluginFamily: "data_source"`,
+`capabilities: []`, `externalInterfaces: []`), and an ephemeris container
+reaches a propagator through `plugin_init_ephemeris` — see
+[the propagator ABI](./propagator-abi.md#ephemeris-ingest). Stretching a tile
+descriptor over a record stream would be an ABI-shaped lie, which is the exact
+failure this SDK exists to prevent.
+
+Scope note on the family matrix: `docs/harness-family-matrix.md` lists
+data-source as covered by "a conformance kit and a reference module". No
+data-source conformance kit exists — `src/conformance/index.js` freezes
+`CONFORMANCE_FAMILIES` to `["propagator"]`, which is today the only harnessed
+family with a kit. Read the matrix row as the reference-module claim only.
+
 ## Table of contents
 
+- [What this port is NOT](#what-this-port-is-not)
 - [Doctrine](#doctrine)
 - [Capability](#capability)
 - [The import set](#the-import-set)

package/docs/publication-submission.html

@@ -54,7 +54,7 @@
 <li><a href="./families/effects.html"><span>Effects</span><span class="tag tag-planned">planned</span></a></li>
 </ul>
 <h2>Estimation, data and logic</h2><ul>
-<li><a href="./families/estimation.html"><span>Estimation</span><span class="tag tag-experimental">experimental</span></a></li>
+<li><a href="./families/estimation.html"><span>Estimation</span><span class="tag tag-shipped">shipped</span></a></li>
 <li><a href="./families/data-source.html"><span>Data source</span><span class="tag tag-shipped">shipped</span></a></li>
 <li><a href="./families/analytics.html"><span>Analytics</span><span class="tag tag-experimental">experimental</span></a></li>
 <li><a href="./families/scheduler.html"><span>Scheduler</span><span class="tag tag-planned">planned</span></a></li>

package/docs/secrets-capability.html

@@ -54,7 +54,7 @@
 <li><a href="./families/effects.html"><span>Effects</span><span class="tag tag-planned">planned</span></a></li>
 </ul>
 <h2>Estimation, data and logic</h2><ul>
-<li><a href="./families/estimation.html"><span>Estimation</span><span class="tag tag-experimental">experimental</span></a></li>
+<li><a href="./families/estimation.html"><span>Estimation</span><span class="tag tag-shipped">shipped</span></a></li>
 <li><a href="./families/data-source.html"><span>Data source</span><span class="tag tag-shipped">shipped</span></a></li>
 <li><a href="./families/analytics.html"><span>Analytics</span><span class="tag tag-experimental">experimental</span></a></li>
 <li><a href="./families/scheduler.html"><span>Scheduler</span><span class="tag tag-planned">planned</span></a></li>

package/docs/testing-harness.html

@@ -54,7 +54,7 @@
 <li><a href="./families/effects.html"><span>Effects</span><span class="tag tag-planned">planned</span></a></li>
 </ul>
 <h2>Estimation, data and logic</h2><ul>
-<li><a href="./families/estimation.html"><span>Estimation</span><span class="tag tag-experimental">experimental</span></a></li>
+<li><a href="./families/estimation.html"><span>Estimation</span><span class="tag tag-shipped">shipped</span></a></li>
 <li><a href="./families/data-source.html"><span>Data source</span><span class="tag tag-shipped">shipped</span></a></li>
 <li><a href="./families/analytics.html"><span>Analytics</span><span class="tag tag-experimental">experimental</span></a></li>
 <li><a href="./families/scheduler.html"><span>Scheduler</span><span class="tag tag-planned">planned</span></a></li>

package/docs/tri-runtime-parity-gate.html

@@ -54,7 +54,7 @@
 <li><a href="./families/effects.html"><span>Effects</span><span class="tag tag-planned">planned</span></a></li>
 </ul>
 <h2>Estimation, data and logic</h2><ul>
-<li><a href="./families/estimation.html"><span>Estimation</span><span class="tag tag-experimental">experimental</span></a></li>
+<li><a href="./families/estimation.html"><span>Estimation</span><span class="tag tag-shipped">shipped</span></a></li>
 <li><a href="./families/data-source.html"><span>Data source</span><span class="tag tag-shipped">shipped</span></a></li>
 <li><a href="./families/analytics.html"><span>Analytics</span><span class="tag tag-experimental">experimental</span></a></li>
 <li><a href="./families/scheduler.html"><span>Scheduler</span><span class="tag tag-planned">planned</span></a></li>

package/docs/tri-runtime-parity.html

@@ -54,7 +54,7 @@
 <li><a href="./families/effects.html"><span>Effects</span><span class="tag tag-planned">planned</span></a></li>
 </ul>
 <h2>Estimation, data and logic</h2><ul>
-<li><a href="./families/estimation.html"><span>Estimation</span><span class="tag tag-experimental">experimental</span></a></li>
+<li><a href="./families/estimation.html"><span>Estimation</span><span class="tag tag-shipped">shipped</span></a></li>
 <li><a href="./families/data-source.html"><span>Data source</span><span class="tag tag-shipped">shipped</span></a></li>
 <li><a href="./families/analytics.html"><span>Analytics</span><span class="tag tag-experimental">experimental</span></a></li>
 <li><a href="./families/scheduler.html"><span>Scheduler</span><span class="tag tag-planned">planned</span></a></li>