spacemap 0.1.11 → 0.1.13

package/README.md

@@ -16,14 +16,15 @@ The code is MPL-2.0. The data and imagery the map fetches keep the terms of
 their sources, which is why the credit line the map draws is not removable:
 these license require attribution.
 
-Every surface map and panorama is ranked by its terms, and the SDK draws only
-what a page may use:
+Every surface map, panorama and spacecraft model is ranked by its terms, and
+the SDK draws only what a page may use:
 
-- **Open** imagery is free for any use, commercial included. It is the default
-  and all a map draws unless asked otherwise.
-- **Non-commercial** imagery is licensed for educational and non-commercial
-  use: the Uranus map, and the Huygens descent panorama of Titan. A page that
-  is not commercial turns it on:
+- **Open** imagery and models are free for any use, commercial included. They
+  are the default and all a map draws unless asked otherwise.
+- **Non-commercial** imagery and models are licensed for educational and
+  non-commercial use: the Uranus map, the Huygens descent panorama of Titan,
+  and the models of a few craft, most of them Soviet (Buran, Vostok, Lunokhod,
+  Salyut 1). A page that is not commercial turns them on:
 
   ```js
   const map = await createMap({ container: '#map', includeNonCommercial: true });
@@ -31,7 +32,9 @@ what a page may use:
 
   Asking for it is accepting its terms, and the credit line naming each author
   is part of those terms. Without the flag Uranus renders in a flat fallback
-  colour, and the Huygens stop is a place on Titan with no panorama to open.
+  colour, the Huygens stop is a place on Titan with no panorama to open, and
+  those craft stay markers with no model. Mir is the exception: it has an open
+  model too, and the map draws that one.
 
 - **Site-only** imagery is licensed to spacemap.co alone and never reaches the
   SDK.
@@ -44,7 +47,7 @@ your page:
 ```html
 <div id="map" style="height: 500px"></div>
 <script type="module">
-	import { createMap } from 'https://cdn.jsdelivr.net/npm/spacemap@0.1.11/dist/spacemap.js';
+	import { createMap } from 'https://cdn.jsdelivr.net/npm/spacemap@0.1.13/dist/spacemap.js';
 	const map = await createMap({ container: '#map' });
 </script>
 ```
@@ -184,6 +187,26 @@ moons and small bodies as the map does. Spacecraft are not placed, and a
 satellite of Earth only near the present: those need the map. A failed
 download rejects.
 
+`sunlight` is a fourth, with no map form. It says how much of the Sun's light
+reaches a body, which is how to know that the map will draw it in eclipse:
+
+```js
+import { sunlight } from 'spacemap';
+
+// Enceladus goes into the shadow of Saturn.
+await sunlight('naif-602', new Date('2026-10-08T04:19:00Z')); // 1
+await sunlight('naif-602', new Date('2026-10-08T04:20:00Z')); // 0.6
+await sunlight('naif-602', new Date('2026-10-08T04:21:00Z')); // 0
+```
+
+It is 1 in full sunlight and 0 when the whole body is in the shadow of another;
+between the two, that share of its sunlit face is lit. The bodies of its own
+system are what can be in the way: the body it orbits, and the planet and moons
+that orbit the same body. Each is a ball of the radius the map draws it with,
+and the shadow is the one the map shades with. The answer is a mean over 1024
+points of the sunlit face, so a shadow smaller than a thousandth of that face
+can be missed: a small moon's on its planet, say.
+
 ### Drawing on it
 
 Everything you draw is put somewhere by an **anchor**, and the anchor is what