spacemap 0.1.18 → 0.1.20

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,8 @@ export declare interface CoreMessages {
     scene_canvas_label: () => string;
     attribution_orbits: () => string;
     attribution_imagery: () => string;
+    attribution_stars: () => string;
+    attribution_constellations: () => string;
     credits_see_all: () => string;
     layer_surface: () => string;
     layer_clouds: () => string;
@@ -619,7 +624,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 +945,20 @@ 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;
+    /** Link target of a collection page's scene label, or of a figure of the
+     *  sky culture `slug`. */
+    groupHref: (slug: string, name: string, figure?: string | null) => 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 +1097,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;
@@ -1093,6 +1105,12 @@ export declare interface MapEvents {
     camera: (view: CameraState) => void;
     /** A nomenclature label was clicked; carries what a fly-to needs. */
     featureselect: (e: FeatureSelect) => void;
+    /** A constellation's name was clicked; `slug` is its collection page. */
+    constellationselect: (e: {
+        slug: string;
+        figure: string;
+        name: string;
+    }) => void;
     /** User-promoted bodies that can be cleared (the focused one excluded). */
     userpromoted: (count: number) => void;
     contextlost: () => void;
@@ -1315,6 +1333,18 @@ export declare interface OutOfRangeNotice {
     } | null;
 }
 
+/** The sky of a page. It leaves the reader's own layer settings alone. */
+export declare interface PageSky {
+    /** The culture to draw. */
+    culture: string;
+    /** The figure to aim at, by its `slug`. */
+    figure: string | null;
+    /** Aim at once: the page opened the map. */
+    opening: boolean;
+    /** The reader turned the layer off on this page. */
+    hidden: boolean;
+}
+
 /** The product id, which names one panorama and no other. A stop held for
  *  days leaves several mosaics sharing a time and a place, so the time and
  *  place together do not. */
@@ -1777,11 +1807,22 @@ export declare interface SamplesOptions {
  * this structurally; an embed passes its own or takes the default. One per
  * page, registered through {@link setSceneSettings}: the tier and quality
  * helpers run deep in material code with no map instance at hand.
+ *
+ * A field added after a release is optional, so a host's own object stays
+ * valid. {@link defaultSceneSettings} shows the default of each.
  */
 export declare interface SceneSettings {
     resolvedReducedMotion: boolean;
     viewMode: 'map' | 'immersive';
     showClouds: boolean;
+    showConstellations?: boolean;
+    /** Key of the sky culture the constellation layer draws. */
+    constellationCulture?: string;
+    /** What a constellation or culture page shows of the sky, for that view. */
+    pageSky?: PageSky | null;
+    /** The constellation layer hides the asteroids, comets and probes, and the
+     *  cloud of Earth satellites, which bury its faint figures. */
+    clearSky?: boolean;
     showAtmospheres: boolean;
     atmosphereQuality: AtmosphereQualityTier;
     atmosphereAutoTier: ResolvedAtmosphereTier | null;
@@ -1836,9 +1877,13 @@ export declare interface ShapeStyle {
 /**
  * Simulation clock. Advances Julian Date by real elapsed time × timeScale;
  * timeScale === 0 means paused. `play()` re-resumes the previous non-zero scale.
+ *
+ * The clock holds only dates that a `Date` holds. A seek past them stops it at
+ * the end of that range.
  */
 export declare class SimClock {
     jd: number;
+    /* Excluded from this release type: askedJd */
     timeScale: number;
     direction: 1 | -1;
     /* Excluded from this release type: seeked */
@@ -1857,6 +1902,8 @@ export declare class SimClock {
     private arrivals;
     constructor(initialJd: number, live?: boolean);
     /* Excluded from this release type: tick */
+    /** Put the clock on `jd`, or on the nearest date it can hold. */
+    private move;
     /* Excluded from this release type: setBoundaryStops */
     /** Caller passes the unsigned magnitude; direction is applied here. */
     setTimeScale(magnitude: number): void;
@@ -1875,6 +1922,7 @@ export declare class SimClock {
     private settleAfterPause;
     /* Excluded from this release type: sweepTo */
     pause(): void;
+    /* Excluded from this release type: hold */
     play(): void;
     /** Back to wall-clock time; live again only if playback is at 1×, since a
      *  paused or fast clock drifts off it at once. */
@@ -1928,9 +1976,14 @@ 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 tripPins;
     private limits;
     private initialFocusPending;
     private pendingFocusId;
@@ -2031,6 +2084,7 @@ export declare class SpaceMap {
      * data of the body does not load. A later move stops this move.
      */
     jumpTo(target: JumpTarget): Promise<void>;
+    /* Excluded from this release type: haloOnScreen */
     /** 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. */
@@ -2066,6 +2120,8 @@ export declare class SpaceMap {
     getLimits(): CameraLimits;
     private applyLimits;
     private applyGestures;
+    /* Excluded from this release type: setStarSelectEnabled */
+    /* Excluded from this release type: setTripPins */
     /** 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;
@@ -2086,7 +2142,9 @@ 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: tripView */
     /* Excluded from this release type: focusOnFeature */
     /* Excluded from this release type: setFocusTarget */
     /** Where the camera is and what it orbits, as anchors a host can store,
@@ -2487,7 +2545,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. */
@@ -2498,6 +2556,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 {