spacemap 0.1.11 → 0.1.13

package/index.d.ts

@@ -227,18 +227,25 @@ declare interface CommonOptions {
      *  origin does not serve pictures; a mirror that serves both sets this to
      *  the same place as `dataUrl`. */
     imagesUrl?: string;
+    /** Root of the live tracking feed, for a mirror that writes its own. */
+    liveUrl?: string;
+    /** Root of the surface tile pyramids, for a mirror that serves them. The
+     *  production CDN serves none: without it a body draws its whole-globe
+     *  maps alone. */
+    tilesUrl?: string;
     /** BCP-47 tag that picks localized names; English when omitted. */
     locale?: string;
     /** Replaces the English wording the map renders itself, one key at a time. */
     messages?: Partial<CoreMessages>;
-    /** Draw the imagery whose licence forbids commercial reuse — off by
-     *  default, because only the page knows whether it is a commercial one.
-     *  Turning it on covers the Uranus map, which otherwise renders in its
-     *  fallback colour, and the Huygens descent panorama of Titan, which is
-     *  otherwise a place on the map with no sphere to open; the page accepts
-     *  each one's terms by asking for it, and the credit line naming its
-     *  author is a condition of them, not a courtesy. Some maps are ours for
-     *  spacemap.co alone and this does not reach them. */
+    /** Draw the imagery and models whose licence forbids commercial reuse —
+     *  off by default, because only the page knows whether it is a commercial
+     *  one. Turning it on covers the Uranus map, which otherwise renders in
+     *  its fallback colour, the Huygens descent panorama of Titan, which is
+     *  otherwise a place on the map with no sphere to open, and the models of
+     *  a few craft (Buran, Vostok, Lunokhod), which otherwise stay markers;
+     *  the page accepts each one's terms by asking for it, and the credit line
+     *  naming its author is a condition of them, not a courtesy. Some maps are
+     *  ours for spacemap.co alone and this does not reach them. */
     includeNonCommercial?: boolean;
 }
 
@@ -901,11 +908,12 @@ export declare interface Host {
     messages: CoreMessages;
     /** Link target of a body's scene label. */
     bodyHref: (id: string, name: string) => string;
-    /** How far down the `distribution` ladder this embed may draw surface maps
-     *  (docs/export-format/textures.md). `open` is the maps anyone may serve,
-     *  `non-commercial` adds those whose licence bars commercial reuse, and
-     *  `site-only` adds those cleared for spacemap.co alone. A bare embed gets
-     *  `open`: it cannot accept a licence for the page it sits on. */
+    /** How far down the `distribution` ladder this embed may draw surface maps,
+     *  panoramas and craft models (docs/export-format/textures.md). `open` is
+     *  what anyone may serve, `non-commercial` adds works whose licence bars
+     *  commercial reuse, and `site-only` adds those cleared for spacemap.co
+     *  alone. A bare embed gets `open`: it cannot accept a licence for the page
+     *  it sits on. */
     textures: TextureDistribution;
 }
 
@@ -2133,6 +2141,19 @@ export declare interface SpaceMapOptions {
  */
 export declare function subsolarPoint(id: string, date: Date): Promise<LonLat | null>;
 
+/**
+ * The part of the light of the Sun that reaches `id` at `date`, from 0 to 1.
+ * It is 1 in full sunlight and 0 when all of the body is in the shadow of
+ * another. Between the two, a part of its sunlit face is in shadow.
+ *
+ * Only the bodies of its own system can be in the way. These are the body it
+ * orbits, and the planet and the moons that orbit the same body. Each is a
+ * ball of the radius the map draws it with. The value is a mean over 1024
+ * points of the sunlit face. Null and rejection are those of
+ * {@link subsolarPoint}.
+ */
+export declare function sunlight(id: string, date: Date): Promise<number | null>;
+
 /** A place on (or above) the body's surface, turning with it. */
 export declare interface SurfaceAnchor {
     body: string;
@@ -2341,8 +2362,9 @@ export declare type SystemMapView = {
 /** Small bodies inside Jupiter's orbit, or from it outward. */
 export declare type SystemMapZone = 'inner' | 'outer';
 
-/** Who may serve a surface map, widest first. A body whose map this embed may
- *  not draw renders in its fallback colour, as an untextured body does. */
+/** Who may serve a work, widest first. A body whose map this embed may not
+ *  draw renders in its fallback colour, as an untextured body does; a craft
+ *  whose model it may not draw stays a marker. */
 declare type TextureDistribution = 'open' | 'non-commercial' | 'site-only';
 
 /**