@projektemacher/storymapjs 0.10.7 → 0.10.8

package/schema/storymap.schema.json

@@ -10,31 +10,70 @@
             "type": "object",
             "required": ["slides"],
             "properties": {
-                "language": { "type": "string" },
+                "language": {
+                    "type": "string"
+                },
                 "map_type": {
-                    "type": "string",
-                    "description": "Basemap type: osm:<style>, osm (classic raster), mapbox://styles/<user>/<style>, stadia:<style>, stamen:<style> (deprecated, remapped), tile URL template or style JSON URL (absolute https://... or relative ./tiles/{z}/{x}/{y}.png, /tiles/{z}/...), iiif, ch-watercolor, zoomify (legacy image pyramid, needs the zoomify options)."
+                    "description": "Basemap type, or \"none\" for a storymap with no map at all. A keyword: \"\" (the default, OpenStreetMap), osm:<style>, osm (classic raster), mapbox://styles/<user>/<style>, stadia:<style>, stamen:<style> (deprecated, remapped), iiif, ch-watercolor, zoomify (legacy image pyramid, needs the zoomify options). Or a tile URL template or style JSON URL (absolute https://... or relative ./tiles/{z}/{x}/{y}.png, /tiles/{z}/...).",
+                    "anyOf": [
+                        {
+                            "type": "string",
+                            "enum": [
+                                "",
+                                "none",
+                                "osm",
+                                "iiif",
+                                "stamen",
+                                "stadia",
+                                "ch-watercolor",
+                                "zoomify"
+                            ]
+                        },
+                        {
+                            "type": "string",
+                            "pattern": "^(?:osm|stadia|mapbox|ch|esri|stamen)(?::|$)|\\{|/|\\.json$"
+                        }
+                    ]
                 },
                 "zoomify": {
                     "anyOf": [
                         {
                             "type": "object",
                             "properties": {
-                                "path": { "type": "string" },
-                                "width": { "type": "number" },
-                                "height": { "type": "number" },
-                                "tolerance": { "type": "number" },
-                                "attribution": { "type": "string" }
+                                "path": {
+                                    "type": "string"
+                                },
+                                "width": {
+                                    "type": "number"
+                                },
+                                "height": {
+                                    "type": "number"
+                                },
+                                "tolerance": {
+                                    "type": "number"
+                                },
+                                "attribution": {
+                                    "type": "string"
+                                }
                             }
                         },
-                        { "type": "boolean" }
+                        {
+                            "type": "boolean"
+                        }
                     ]
                 },
-                "map_as_image": { "type": "boolean" },
-                "map_mini": { "type": "boolean" },
-                "map_subdomains": { "type": "string" },
-                "map_access_token": { "type": "string" },
-                "map_background_color": { "type": "string" },
+                "map_as_image": {
+                    "type": "boolean"
+                },
+                "map_mini": {
+                    "type": "boolean"
+                },
+                "map_access_token": {
+                    "type": "string"
+                },
+                "map_background_color": {
+                    "type": "string"
+                },
                 "map_options": {
                     "type": "object",
                     "description": "OpenLayers passthrough options (view, controls, interactions); element replaces the map container"
@@ -43,39 +82,176 @@
                     "anyOf": [
                         {
                             "type": "array",
-                            "items": { "type": "number" },
+                            "items": {
+                                "type": "number"
+                            },
                             "minItems": 4,
                             "maxItems": 4
                         },
-                        { "type": "null" }
+                        {
+                            "type": "null"
+                        }
                     ]
                 },
                 "map_area": {
                     "type": "string",
                     "enum": ["full", "left"]
                 },
-                "consent_required": { "type": "boolean" },
+                "overview_extent": {
+                    "anyOf": [
+                        {
+                            "type": "array",
+                            "items": {
+                                "type": "number"
+                            },
+                            "minItems": 4,
+                            "maxItems": 4
+                        },
+                        {
+                            "type": "null"
+                        }
+                    ],
+                    "description": "Constrain the minimap overview to this lon/lat bounding box [west, south, east, north]; null (default) leaves it unconstrained"
+                },
+                "keyboard": {
+                    "type": "boolean",
+                    "description": "Navigate slides with the arrow keys anywhere on the page (default false)"
+                },
+                "overlays": {
+                    "type": "array",
+                    "description": "Raster layers stacked above the base map and below the route lines",
+                    "items": {
+                        "type": "object",
+                        "properties": {
+                            "map_type": {
+                                "type": "string",
+                                "description": "Any map_type the tile layer factory accepts. Omit when the entry carries a georeference instead."
+                            },
+                            "opacity": {
+                                "type": "number",
+                                "minimum": 0,
+                                "maximum": 1
+                            },
+                            "visible": {
+                                "type": "boolean"
+                            },
+                            "attribution": {
+                                "type": "string"
+                            },
+                            "className": {
+                                "type": "string",
+                                "description": "CSS class of the layer container, isolating it from the shared ol-layer canvas (e.g. for blend modes)"
+                            },
+                            "blendMode": {
+                                "type": "string"
+                            },
+                            "extent": {
+                                "type": "array",
+                                "items": {
+                                    "type": "number"
+                                },
+                                "minItems": 4,
+                                "maxItems": 4,
+                                "description": "Clip the layer to this lon/lat bounding box [west, south, east, north] (mercator maps)"
+                            },
+                            "georeference": {
+                                "type": "object",
+                                "description": "A IIIF Georeference Extension annotation body plus the image it places. In a IIIF manifest this is a motivation: \"georeferencing\" annotation whose target embeds the image and whose body is the FeatureCollection of ground control points.",
+                                "required": ["url", "width", "height", "body"],
+                                "properties": {
+                                    "url": {
+                                        "type": "string",
+                                        "description": "IIIF Image API service base, or a full-size image URL"
+                                    },
+                                    "width": {
+                                        "type": "number",
+                                        "exclusiveMinimum": 0,
+                                        "description": "Image width in pixels (the resourceCoords space)"
+                                    },
+                                    "height": {
+                                        "type": "number",
+                                        "exclusiveMinimum": 0,
+                                        "description": "Image height in pixels"
+                                    },
+                                    "body": {
+                                        "type": "object",
+                                        "description": "The Georeference Extension annotation body, verbatim: a GeoJSON FeatureCollection of ground control points pairing properties.resourceCoords (image pixels) with geometry.coordinates (WGS84 lon/lat), optionally with a transformation hint.",
+                                        "required": ["type", "features"],
+                                        "properties": {
+                                            "type": {
+                                                "const": "FeatureCollection"
+                                            },
+                                            "transformation": {
+                                                "type": "object"
+                                            },
+                                            "features": {
+                                                "type": "array",
+                                                "minItems": 1
+                                            }
+                                        }
+                                    }
+                                }
+                            }
+                        },
+                        "anyOf": [
+                            {
+                                "required": ["map_type"]
+                            },
+                            {
+                                "required": ["georeference"]
+                            }
+                        ]
+                    }
+                },
+                "consent_required": {
+                    "type": "boolean"
+                },
                 "map_center_offset": {
                     "type": "object",
                     "properties": {
-                        "left": { "type": "number" },
-                        "top": { "type": "number" }
+                        "left": {
+                            "type": "number"
+                        },
+                        "top": {
+                            "type": "number"
+                        }
                     }
                 },
-                "map_popup": { "type": "boolean" },
-                "use_custom_markers": { "type": "boolean" },
-                "zoom_distance": { "type": "number" },
-                "calculate_zoom": { "type": "boolean" },
-                "less_bounce": { "type": "boolean" },
-                "line_follows_path": { "type": "boolean" },
-                "show_lines": { "type": "boolean" },
-                "show_history_line": { "type": "boolean" },
-                "line_color": { "type": "string" },
-                "line_color_inactive": { "type": "string" },
-                "line_weight": { "type": "number" },
-                "line_opacity": { "type": "number", "minimum": 0, "maximum": 1 },
-                "line_dash": { "type": "string" },
-                "line_join": { "type": "string" },
+                "use_custom_markers": {
+                    "type": "boolean"
+                },
+                "calculate_zoom": {
+                    "type": "boolean"
+                },
+                "line_follows_path": {
+                    "type": "boolean"
+                },
+                "show_lines": {
+                    "type": "boolean"
+                },
+                "show_history_line": {
+                    "type": "boolean"
+                },
+                "line_color": {
+                    "type": "string"
+                },
+                "line_color_inactive": {
+                    "type": "string"
+                },
+                "line_weight": {
+                    "type": "number"
+                },
+                "line_opacity": {
+                    "type": "number",
+                    "minimum": 0,
+                    "maximum": 1
+                },
+                "line_dash": {
+                    "type": "string"
+                },
+                "line_join": {
+                    "type": "string"
+                },
                 "iiif": {
                     "type": "object",
                     "required": ["url"],
@@ -84,47 +260,105 @@
                             "type": "string",
                             "description": "URL of the IIIF Image API info.json document"
                         },
-                        "attribution": { "type": "string" }
+                        "attribution": {
+                            "type": "string"
+                        }
                     }
                 },
-                "font_css": { "type": "string" },
-                "call_to_action": { "type": "boolean" },
-                "call_to_action_text": { "type": "string" },
-                "fullscreen": { "type": "boolean" },
-                "show_overview": { "type": "boolean" },
-                "show_back_to_start": { "type": "boolean" },
-                "show_progress": { "type": "boolean" },
-                "show_distance": { "type": "boolean" },
-                "marker_labels": { "type": "boolean" },
-                "text_align": { "type": "string" },
-                "text_color": { "type": "string" },
-                "text_background_color": { "type": "string" },
-                "nocache": { "type": "boolean" },
+                "font_css": {
+                    "type": "string"
+                },
+                "call_to_action": {
+                    "type": "boolean"
+                },
+                "call_to_action_text": {
+                    "type": "string"
+                },
+                "fullscreen": {
+                    "type": "boolean"
+                },
+                "show_overview": {
+                    "type": "boolean"
+                },
+                "show_back_to_start": {
+                    "type": "boolean"
+                },
+                "show_progress": {
+                    "type": "boolean"
+                },
+                "show_distance": {
+                    "type": "boolean"
+                },
+                "marker_labels": {
+                    "type": "boolean"
+                },
+                "text_align": {
+                    "type": "string",
+                    "enum": ["left", "center", "right"],
+                    "description": "Default horizontal alignment for slide text"
+                },
+                "text_color": {
+                    "type": "string"
+                },
+                "text_background_color": {
+                    "type": "string"
+                },
+                "nocache": {
+                    "type": "boolean"
+                },
                 "autoplay": {
                     "type": "number",
-                    "description": "Seconds per slide; 0 disables autoplay"
+                    "description": "Milliseconds per slide; 0 (the default) disables autoplay"
+                },
+                "autoplay_media": {
+                    "type": "boolean",
+                    "default": false,
+                    "description": "When autoplaying, wait for the slide media to end before advancing; the autoplay timer stays as the fallback."
+                },
+                "trackResize": {
+                    "type": "boolean"
+                },
+                "duration": {
+                    "type": "number"
                 },
-                "trackResize": { "type": "boolean" },
-                "dragging": { "type": "boolean" },
-                "duration": { "type": "number" },
                 "map_overview_center": {
                     "anyOf": [
                         {
                             "type": "object",
                             "properties": {
-                                "lat": { "type": "number" },
-                                "lon": { "type": "number" }
+                                "lat": {
+                                    "type": "number"
+                                },
+                                "lon": {
+                                    "type": "number"
+                                }
                             }
                         },
-                        { "type": "null" }
+                        {
+                            "type": "null"
+                        }
                     ]
                 },
-                "api_key_flickr": { "type": "string" },
-                "attribution": { "type": "string" },
-                "start_at_slide": { "type": "integer", "minimum": 0 },
+                "api_key_flickr": {
+                    "type": "string"
+                },
+                "attribution": {
+                    "type": "string"
+                },
+                "start_at_slide": {
+                    "type": "integer",
+                    "minimum": 0
+                },
                 "slides": {
                     "type": "array",
-                    "items": { "$ref": "#/$defs/slide" }
+                    "items": {
+                        "$ref": "#/$defs/slide"
+                    }
+                },
+                "layout": {
+                    "type": "string",
+                    "enum": ["landscape", "portrait"],
+                    "description": "Force a layout instead of deriving it from the container width. \"portrait\" is what the viewer picks at or below skinny_size."
                 }
             }
         }
@@ -137,8 +371,16 @@
                     "type": "string",
                     "description": "'overview' marks the map overview slide"
                 },
-                "date": { "type": ["string", "object", "null"] },
-                "group": { "type": "string" },
+                "date": {
+                    "type": ["string", "object", "null"]
+                },
+                "group": {
+                    "type": "string"
+                },
+                "language": {
+                    "type": "string",
+                    "description": "The language tag this slide's text is in. A IIIF manifest states text as a language map; the reader picks the viewer's configured language and reports which one it used, so a host can offer a language switch. Absent for language-neutral (none) text."
+                },
                 "location": {
                     "type": "object",
                     "properties": {
@@ -150,46 +392,157 @@
                             "type": "number",
                             "description": "Longitude, or horizontal position in image pixels for image maps"
                         },
-                        "zoom": { "type": "number" },
-                        "line": { "type": "boolean" },
-                        "name": { "type": "string" },
-                        "icon": { "type": "string", "format": "uri" },
+                        "region": {
+                            "type": "array",
+                            "items": {
+                                "type": "number"
+                            },
+                            "minItems": 4,
+                            "maxItems": 4,
+                            "description": "Image region [x, y, w, h] in image pixels (IIIF xywh convention) for image maps; the view fits the region on navigation"
+                        },
+                        "zoom": {
+                            "type": "number"
+                        },
+                        "line": {
+                            "type": "boolean"
+                        },
+                        "name": {
+                            "type": "string"
+                        },
+                        "icon": {
+                            "type": "string",
+                            "format": "uri"
+                        },
                         "iconSize": {
                             "type": "array",
-                            "items": { "type": "number" },
+                            "items": {
+                                "type": "number"
+                            },
                             "minItems": 1,
                             "maxItems": 2
                         },
-                        "image": { "type": "string", "format": "uri" },
-                        "use_custom_marker": { "type": "boolean" }
+                        "image": {
+                            "type": "string",
+                            "format": "uri"
+                        },
+                        "use_custom_marker": {
+                            "type": "boolean"
+                        }
                     }
                 },
                 "media": {
                     "type": "object",
                     "properties": {
-                        "url": { "type": ["string", "null"] },
-                        "caption": { "type": ["string", "null"] },
-                        "credit": { "type": ["string", "null"] },
-                        "thumb": { "type": "string" },
-                        "mediatype": { "type": ["object", "null"] }
+                        "url": {
+                            "type": ["string", "null"]
+                        },
+                        "caption": {
+                            "type": ["string", "null"]
+                        },
+                        "credit": {
+                            "type": ["string", "null"]
+                        },
+                        "thumb": {
+                            "type": "string"
+                        },
+                        "alt": {
+                            "type": "string"
+                        },
+                        "srcset": {
+                            "type": "string"
+                        },
+                        "sizes": {
+                            "type": "string"
+                        },
+                        "subtitles": {
+                            "type": ["string", "null"],
+                            "format": "uri",
+                            "description": "WebVTT subtitle file for an audio or video slide, rendered as a <track kind=\"subtitles\">."
+                        },
+                        "mediatype": {
+                            "type": ["object", "null"]
+                        }
                     }
                 },
                 "text": {
                     "type": "object",
                     "properties": {
-                        "headline": { "type": "string" },
-                        "text": { "type": "string" },
-                        "date": { "type": ["string", "object", "null"] }
+                        "headline": {
+                            "type": "string"
+                        },
+                        "text": {
+                            "type": "string"
+                        },
+                        "date": {
+                            "type": ["string", "object", "null"]
+                        },
+                        "text_align": {
+                            "type": "string",
+                            "enum": ["left", "center", "right"],
+                            "description": "Horizontal alignment of this slide's text block"
+                        }
                     }
                 },
+                "marker": {
+                    "type": ["object", "null"],
+                    "description": "Per-slide marker presentation. location.icon/iconSize/image/use_custom_marker and location.name remain supported as legacy spellings; marker.* wins when present. In a IIIF manifest these arrive in the navPlace Feature properties instead.",
+                    "properties": {
+                        "icon": {
+                            "type": "string",
+                            "format": "uri"
+                        },
+                        "iconSize": {
+                            "type": "array",
+                            "items": {
+                                "type": "number"
+                            }
+                        },
+                        "image": {
+                            "type": "string",
+                            "format": "uri"
+                        },
+                        "label": {
+                            "type": "string"
+                        },
+                        "popup": {
+                            "type": "boolean"
+                        },
+                        "audioBadge": {
+                            "type": "boolean"
+                        }
+                    }
+                },
+                "narration": {
+                    "type": ["object", "null"],
+                    "description": "Spoken narration for this slide, played through a dedicated audio element. Storymap JSON only: in a IIIF manifest the closest spelling is a Sound body, which currently lands in media.url rather than here.",
+                    "properties": {
+                        "url": {
+                            "type": "string",
+                            "format": "uri"
+                        }
+                    },
+                    "required": ["url"]
+                },
                 "background": {
                     "type": ["object", "string"],
                     "properties": {
-                        "url": { "type": ["string", "null"], "format": "uri" },
-                        "color": { "type": ["string", "null"] }
+                        "url": {
+                            "type": ["string", "null"],
+                            "format": "uri"
+                        },
+                        "color": {
+                            "type": ["string", "null"]
+                        },
+                        "opacity": {
+                            "type": "number",
+                            "description": "Background image opacity, 0-1"
+                        }
                     }
                 },
-                "uniqueid": { "type": "string" }
+                "uniqueid": {
+                    "type": "string"
+                }
             }
         }
     }

package/src/animation/easings.ts

@@ -4,11 +4,18 @@
  *
  * - d3-ease (BSD-3): polynomial and exponential easings
  * - bezier-easing (MIT, by the KeySpline author): cubic-bezier sampling
+ *
+ * This module is the single source of the viewer's animation curves. There is
+ * deliberately no matching SCSS variable: the widget animates through
+ * OpenLayers view animations and the Web Animations API, not CSS transitions,
+ * so a stylesheet curve could only drift out of sync with these. The two
+ * stylesheets used to carry `$animation-ease: cubic-bezier(0.77, 0, 0.175, 1)`
+ * which nothing referenced, and which matched none of the curves below.
  */
 import { easeExpOut, easePoly } from "d3-ease";
 import bezierEasing from "bezier-easing";
 
-/** Acceleration until halfway, then deceleration (quintic). */
+/** Acceleration until halfway, then deceleration (quintic). The default glide. */
 export const easeInOutQuint = easePoly.exponent(5);
 
 /** Strong exponential ease-out. */