spacemap 0.1.17 → 0.1.19

package/index.d.ts

@@ -233,6 +233,9 @@ declare interface CommonOptions {
      *  production CDN serves none: without it a body draws its whole-globe
      *  maps alone. */
     tilesUrl?: string;
+    /** Root of the extrasolar export, for a mirror that serves it. Without it
+     *  the map has no stars. */
+    extrasolarUrl?: 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. */
@@ -242,8 +245,8 @@ declare interface CommonOptions {
      *  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
+     *  a few craft (Buran, Vostok, Lunokhod), which otherwise stay markers, and
+     *  the stars from Gaia, which otherwise stay off the map; 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;
@@ -287,6 +290,7 @@ export declare interface CoreMessages {
     scene_canvas_label: () => string;
     attribution_orbits: () => string;
     attribution_imagery: () => string;
+    attribution_stars: () => string;
     credits_see_all: () => string;
     layer_surface: () => string;
     layer_clouds: () => string;
@@ -619,7 +623,7 @@ export declare class FlatMap {
     /** The moment the map is of. Moves the clouds and, on Earth, the season. */
     setTime(jd: number): void;
     setBody(bodyId: string): Promise<void>;
-    /** Screen pixel for a place, relative to the map's own box. */
+    /** Screen pixel for the visible copy of a place. */
     project(lon: number, lat: number): [number, number] | null;
     /** The place under a pixel of the map's box, or null off the world. */
     unproject(px: number, py: number): LonLat | null;
@@ -940,13 +944,17 @@ export declare interface Host {
      *  data export's host. Empty where none is served: bodies then draw their
      *  whole-globe tiers alone. */
     tilesUrl: string;
+    /** Root of the extrasolar export, which holds the star render nodes and
+     *  the record tiles. Empty where none is served, and the map then has no
+     *  stars. */
+    extrasolarUrl: string;
     /** BCP-47 tag of the reading language: picks localized names and drives Intl. */
     locale: () => string;
     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,
-     *  panoramas and craft models (docs/export-format/textures.md). `open` is
+     *  panoramas, craft models and stars (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
@@ -1085,7 +1093,7 @@ export declare interface LonLat {
 
 /** Every layer, in the order a switcher should offer them: the objects first,
  *  then the chrome drawn around them. */
-export declare const MAP_LAYERS: readonly ["planets", "dwarfPlanets", "moons", "asteroids", "comets", "spacecraft", "satellites", "debris", "orbits", "labels", "halos", "nomenclature", "stars"];
+export declare const MAP_LAYERS: readonly ["planets", "dwarfPlanets", "moons", "asteroids", "comets", "spacecraft", "satellites", "debris", "starfield", "orbits", "labels", "halos", "nomenclature", "stars"];
 
 export declare interface MapEvents {
     focuschange: (e: FocusChange) => void;
@@ -1373,7 +1381,7 @@ export declare interface PanoramaEntry {
      *  `unknown` means the sphere sits at an arbitrary azimuth, so nothing
      *  may be drawn or written as a heading. The full set `export/panoramas.py`
      *  writes — a wider union would erase the literals and stop checking. */
-    orientation?: 'unknown' | 'caption-aligned' | 'matched to an archival sphere' | 'matched to a controlled mosaic';
+    orientation?: 'unknown' | 'caption-aligned' | 'matched to an archival sphere' | 'matched to a controlled mosaic' | 'matched to a terrain model' | 'fitted to the Sun';
     /** `estimated` where the sphere's angular bounds were fitted to a
      *  published flat image rather than read from an archive label. */
     geometry?: 'estimated';
@@ -1853,6 +1861,8 @@ export declare class SimClock {
     private prevScale;
     private stops;
     private settleTimer;
+    /** The promises of {@link jumpTo} that wait for a frame at their date. */
+    private arrivals;
     constructor(initialJd: number, live?: boolean);
     /* Excluded from this release type: tick */
     /* Excluded from this release type: setBoundaryStops */
@@ -1860,9 +1870,12 @@ export declare class SimClock {
     setTimeScale(magnitude: number): void;
     toggleDirection(): void;
     /* Excluded from this release type: setJD */
-    /** Seek, and mark it as a discrete jump so listeners can react to the one
-     *  move rather than to a stream of them. */
-    jumpTo(jd: number): void;
+    /** Move the clock to `jd` in one jump, so that listeners react to it once.
+     *  The promise resolves when a frame shows the bodies at that date. Until
+     *  the data of the date loads, the map shows the date before the jump, and
+     *  the measures answer for that date. */
+    jumpTo(jd: number): Promise<void>;
+    /* Excluded from this release type: placed */
     /** Rest the settled date on where the clock stands now. */
     private settle;
     /** The same, once a drag holds still. A clock still playing is left alone: it
@@ -1877,8 +1890,9 @@ export declare class SimClock {
     get playing(): boolean;
     /** The moment the map is showing. */
     get date(): Date;
-    /** Show another moment, as one deliberate move. */
-    setDate(date: Date): void;
+    /** Move the clock to `date` in one jump. The promise resolves as the promise
+     *  of {@link jumpTo} does. */
+    setDate(date: Date): Promise<void>;
 }
 
 /**
@@ -1922,9 +1936,13 @@ export declare class SpaceMap {
     private canvas;
     private labelLayer;
     private stopWatching;
+    private stopExtrasolarStale;
     private controls;
     private lostPanelTimer;
     private cooperative;
+    /** Whether a click on a star takes the focus. A host's map has no page to
+     *  open for a star, so it is off unless the app turns it on. */
+    private starSelectEnabled;
     private limits;
     private initialFocusPending;
     private pendingFocusId;
@@ -2018,9 +2036,17 @@ export declare class SpaceMap {
      *  the move a click on its label makes. Resolves when the camera comes
      *  round. */
     panTo(target: FeatureTarget): Promise<void>;
-    /** Put the camera somewhere at once, with no flight: what a page restoring a
-     *  stored view wants, where a flight from nowhere would read as a lurch. */
-    jumpTo(target: JumpTarget): this;
+    /**
+     * Put the camera at a place at once, with no flight. Use it to restore a
+     * stored view. A body that the map has not loaded loads first. The promise
+     * resolves one frame after the camera is in its place. It rejects when the
+     * data of the body does not load. A later move stops this move.
+     */
+    jumpTo(target: JumpTarget): Promise<void>;
+    /** Whether `id` is in the scene, with a place at the date it shows. */
+    private placedNow;
+    /** The placement of {@link jumpTo}, on a body in the scene. */
+    private snap;
     /** Where the camera is now. Null before the first frame, and while nothing
      *  is focused. */
     getCamera(): CameraState | null;
@@ -2052,6 +2078,7 @@ export declare class SpaceMap {
     getLimits(): CameraLimits;
     private applyLimits;
     private applyGestures;
+    /* Excluded from this release type: setStarSelectEnabled */
     /** A wheel the page is to keep never reaches the orbit controls. It is not
      *  cancelled, so the page scrolls as it would over any other element. */
     private readonly onWheelCapture;
@@ -2072,6 +2099,7 @@ export declare class SpaceMap {
     private cameraDistance;
     /* Excluded from this release type: focusOnBody */
     /* Excluded from this release type: snapToBody */
+    /* Excluded from this release type: snapToBodyFrom */
     /* Excluded from this release type: snapToBodyFacing */
     /* Excluded from this release type: focusOnFeature */
     /* Excluded from this release type: setFocusTarget */
@@ -2473,7 +2501,7 @@ export declare class Viewport {
     fromScreen(px: number, py: number): [number, number];
     /** Screen pixel for a place, or null where it is not on the map. */
     project(lon: number, lat: number): [number, number] | null;
-    /** Place under a screen pixel, or null where the pixel is off the world. */
+    /** Place under a screen pixel, including repeated copies of the world. */
     unproject(px: number, py: number): [number, number] | null;
     /** How wide the whole world is in pixels — the jump that tells a drawn line
      *  it has crossed the seam rather than moved. */
@@ -2484,6 +2512,8 @@ export declare class Viewport {
      *  the map's own always first. Anything drawn on the map is drawn once per
      *  offset, so a shape near the seam shows on both sides of it. */
     get repeatShifts(): number[];
+    /** Offset that places this world position in the frame. */
+    shiftInFrame(x: number): number;
 }
 
 export declare interface ViewState {