@projektemacher/storymapjs 0.10.7 → 0.10.8

package/dist/navplace-properties.json

@@ -0,0 +1,40 @@
+{
+    "@context": {
+        "@version": 1.1,
+        "xsd": "http://www.w3.org/2001/XMLSchema#",
+        "storymap_navplace": "https://christianmahnke.de/iiif/storymap#",
+        "name": "storymap_navplace:navplaceName",
+        "zoom": {
+            "@id": "storymap_navplace:navplaceZoom",
+            "@type": "xsd:integer"
+        },
+        "line": {
+            "@id": "storymap_navplace:navplaceLine",
+            "@type": "xsd:boolean"
+        },
+        "icon": {
+            "@id": "storymap_navplace:navplaceIcon",
+            "@type": "@id"
+        },
+        "iconSize": {
+            "@id": "storymap_navplace:navplaceIconSize",
+            "@container": "@list"
+        },
+        "image": {
+            "@id": "storymap_navplace:navplaceImage",
+            "@type": "@id"
+        },
+        "use_custom_marker": {
+            "@id": "storymap_navplace:navplaceUseCustomMarker",
+            "@type": "xsd:boolean"
+        },
+        "popup": {
+            "@id": "storymap_navplace:navplacePopup",
+            "@type": "xsd:boolean"
+        },
+        "audioBadge": {
+            "@id": "storymap_navplace:navplaceAudioBadge",
+            "@type": "xsd:boolean"
+        }
+    }
+}

package/docs/migration-from-knightlab.md

@@ -82,6 +82,26 @@ element, ... }` to configure the underlying OpenLayers map; `element`
 | `relative_date: true` (moment.js)             | removed — format dates in the story text                                                                                                                         |
 | `font_css: "stock:<name>"` (or a path)        | paths now resolve against the page URL (not the library location), plus the font files ship via `@fontsource-utils/scss`; no separate font CSS link needed       |
 
+## A story with no map
+
+`map_type: "none"` runs the storymap as text and media only. Nothing is
+constructed: no `ol/Map`, no tile layer, no tile consent row, and the overview
+control is hidden. The slider panel takes the full width, because there is no
+map behind it to fade over.
+
+This is the shape a photo essay or a transcript-led story wants, and it is the
+one the map engine's unconditional construction used to make impossible. Note
+that `map_type: ""` and an absent `map_type` both still mean OpenStreetMap, and
+`map_type: null` now falls back to that default instead of throwing out of the
+constructor — absence is not reinterpreted, so no existing document changes
+meaning. Map-derived accessors (`getBaseLayer()`, `getMarkers()`, …) return
+their neutral values, and the map setters are no-ops.
+
+| Old                                        | New                                   |
+| ------------------------------------------ | ------------------------------------- |
+| a text-only story with a dummy `map_type`  | `map_type: "none"`                    |
+| `map_type: null` (crashed the constructor) | normalised to the default, `""` → OSM |
+
 ## Removed globals and exports
 
 | Removed                           | Replacement                                           |
@@ -97,9 +117,27 @@ element, ... }` to configure the underlying OpenLayers map; `element`
 
 | Removed                               | Replacement                                                                                                                                                                                                                  |
 | ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `vine` media type (service shut down) | vine URLs fall back to the `website` iframe — use another media source for those slides                                                                                                                                      |
+| `vine` media type (service shut down) | vine URLs fall back to the `website` iframe — or paste the provider's `<iframe>` snippet into the slide text (sanitized, https-only); use another media source for those slides                                              |
 | Juxtapose `frame/?uid=` embed URLs    | the `juxtapose.knightlab.com/frame/?uid=` host is dead — use the published format `https://cdn.knightlab.com/libs/juxtapose/latest/embed/index.html?uid=...` (note: this keeps a Knight Lab CDN dependency for those slides) |
 | Twitter `@nickname` rendering         | tweets from `x.com` URLs are now parsed too (fixes `@undefined` nicknames); no migration needed                                                                                                                              |
+| Ricoh360/theta360 embeds (#391)       | service no longer available (won't fix) — paste the provider's `<iframe>` snippet into the slide text if the service returns                                                                                                 |
+
+Extra media per slide (#358, partial): each slide still has one primary
+`media` item, but an `<iframe>` embed snippet pasted into the slide `text`
+field now renders sanitized (scripts, event handlers and non-https sources
+dropped) — use this for a second video/map/embed or as the migration path
+for removed media types:
+
+```html
+<p>Extra footage:</p>
+<iframe
+    src="https://example.com/embed/123"
+    width="560"
+    height="315"
+    frameborder="0"
+    allowfullscreen
+></iframe>
+```
 
 `map_type: "zoomify"` is supported again (legacy): the image pyramid renders
 via the storymap data's `zoomify` options (`path`, `width`, `height`), using a
@@ -113,12 +151,180 @@ storymap JSON sources.
 ## Map engine: Leaflet → OpenLayers
 
 - `storymap.map` now exposes the **OpenLayers `Map`** instance instead of a
-  Leaflet map. Port any direct Leaflet calls (e.g. `setView`, `flyTo`) to the
-  OpenLayers API (`getView().animate(...)`, ...).
+  Leaflet map. Port any direct Leaflet calls to the OpenLayers API (table
+  below). It is `null` until the map has been built.
 - Markers are DOM overlays (`.vco-mapmarker` / `.vco-mapmarker-active`) like
   before; the mini map is an OpenLayers `OverviewMap` control.
 - New basemap options: vector styles via `map_type: "osm:<style>"` (OpenFreeMap)
   or a Mapbox style JSON URL.
+- All OL types (`Map`, `View`, `Layer`, `Source`, `Feature`, ...) are
+  re-exported, so a consumer can type its own overlays without depending on
+  `ol` directly.
+
+### Direct Leaflet calls → OpenLayers
+
+Both maps are reachable from the same place (`storymap.map`), so only the
+call syntax changes:
+
+| Leaflet                                    | OpenLayers                                                                |
+| ------------------------------------------ | ------------------------------------------------------------------------- |
+| `map.getCenter()`                          | `map.getView().getCenter()` — panel-shifted, see below                    |
+| `map.getZoom()`                            | `map.getView().getZoom()`                                                 |
+| `map.setView(c, z)` / `map.fitBounds(b)`   | `map.getView().fit(extent, { size: map.getSize() })`                      |
+| `map.panTo(c)` / `map.flyTo(c, z)`         | `map.getView().animate({ center: c, duration: 300 })`                     |
+| `map.setZoom(z)`                           | `map.getView().setZoom(z)` (or `.animate({ zoom: z })`)                   |
+| `map.getSize()` / `map.getBounds()`        | `map.getSize()` / `map.getView().calculateExtent(map.getSize())`          |
+| `map.on("moveend", fn)`                    | `map.on("moveend", fn)` (same event names; `movestart`/`move` also exist) |
+| `L.tileLayer(url, opts).addTo(map)`        | `new TileLayer({ source: new XYZ({ url, attributions }) }).setMap(map)`   |
+| `L.control.attribution` / `L.control.zoom` | OL `Attribution` / `Zoom` controls (pass them via `map_options.controls`) |
+| `map.getPane("overlayPane")`               | `map.getOverlayContainer()` (markers are DOM siblings, not OL features)   |
+| `map.invalidateSize()`                     | `map.updateSize()`                                                        |
+| `map.remove()`                             | `map.setTarget(undefined); map.dispose();` (or `storymap.dispose()`)      |
+
+The exposed center is deliberately panel-shifted: in landscape the view is
+offset so the visible map sits left of the slide panel, which means
+`getView().getCenter()` does **not** equal the current slide's location.
+That is a display concern, not a data one — read the location from the
+slide, not from the view. There is intentionally no offset-aware getter;
+an earlier `_getMapCenter(offset)` parameter promised that correction and
+never applied it, so it was removed rather than left to mislead.
+| `map.options.crs` / `map.getPixelOrigin()` | `map.getView().getProjection()` / `map.getPixelFromCoordinate(coord)` |
+
+Marker positions are still DOM elements, so `marker.getLatLng()` has no
+equivalent — read the slide data (`storymap.data.stlides[n].location`) or use
+`storymap._map.getMarker(n).latLon()`.
+
+### Map and marker methods
+
+The map/marker methods of the original viewer are still there with the same
+names and behaviour (`storymap._map.<method>()`, `marker.<method>()`); the OL
+engine implements them as thin wrappers over `storymap.map`. Two methods are
+deprecated no-ops and one is gone:
+
+| Original method                                                                                           | Status                                                                                                                                                                                                                               |
+| --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `updateDisplay`, `goTo`, `panTo`, `zoomTo`, `viewTo`                                                      | unchanged                                                                                                                                                                                                                            |
+| `getBoundsZoom`, `markerOverview`, `calculateMarkerZooms`                                                 | unchanged (`getBoundsZoom()` now returns `number \| undefined` instead of a falsy value)                                                                                                                                             |
+| `createMiniMap`, `createMarkers`, `createMarker`                                                          | unchanged                                                                                                                                                                                                                            |
+| `setMapOffset`, `calculateMinMaxZoom`, `updateMinMaxZoom`, `initialMapLocation`                           | unchanged                                                                                                                                                                                                                            |
+| `show()` / `hide()` (map and marker)                                                                      | **deprecated no-ops** — they were already empty in the original viewer. Style `.vco-mapmarker` or use `marker.active(false)`                                                                                                         |
+| `map.addTo(container)` / `map.removeFrom(container)`                                                      | unchanged — inherited from the `DomMixed` mixin: append/remove the map container and fire `added`/`removed`. The engine override re-targets and re-measures the OpenLayers viewport, so a move into a differently sized parent works |
+| `marker.createPopup()`                                                                                    | **deprecated no-op** — it never did anything upstream either (empty base body, commented-out Leaflet body), so the `map_popup` option that called it had no effect. Still accepted, still inert                                      |
+| `marker.addTo()`, `marker.removeFrom()`, `marker.updateDisplay()`, `marker.active()`, `marker.location()` | unchanged                                                                                                                                                                                                                            |
+
+Marker helpers that Leaflet provided on the marker object (`getLatLng`,
+`setIcon`, `bindPopup`) are gone; use `marker.latLon()`, the
+`.vco-mapmarker` element and your own DOM/CSS.
+
+## Reaching the map, layers and markers
+
+`storymap.map` is the raw `ol/Map` (typed as `OlMap | null` — it is set during
+construction, so check it before first use in an async setup). Everything the
+viewer keeps internally is available through accessors on `storymap` (and on
+`storymap._map` for the engine methods):
+
+| Accessor                                                     | Returns                                                            |
+| ------------------------------------------------------------ | ------------------------------------------------------------------ |
+| `getBaseLayer()`                                             | the base tile/vector layer                                         |
+| `getOverlayLayers()` / `getOverlayLayer(i)`                  | overlay layers / one by index (`null` if out of range)             |
+| `getOverlayCount()`                                          | number of overlays                                                 |
+| `setOverlayVisible(i, on)` / `setOverlayOpacity(i, opacity)` | show/hide and fade one overlay                                     |
+| `getMinimap()`                                               | the `OverviewMap` control, or its inner map via `getOverviewMap()` |
+| `getLine()` / `getLineActive()`                              | the full and the travelled route `VectorLayer`                     |
+| `getMarker(n)` / `getMarkers()`                              | one marker or all of them, in slide order                          |
+| `setExtraAttributions(html)`                                 | extra attribution HTML, listed after the source credits            |
+| `isImageSpace()`                                             | whether the map is a IIIF image in image space (see below)         |
+
+`tile_source_factory` may return a full `ol/layer/Layer` (not just a source)
+anywhere a layer is built, so custom layers can carry their own opacity,
+z-index and events. A custom layer without a source (Allmaps'
+`WarpedMapLayer`) passes through untouched; source reads go through a
+capability check, so it simply skips the tile-grid fits.
+
+The viewer reserves three z-index ranges and custom layers should stay out
+of them: **0** for the base tiles, **1..n** for the stacked `overlays[]`
+entries in order, and **10/11** for the full and travelled route lines. A
+custom layer with no explicit z-index lands wherever OpenLayers puts it,
+which is above the lines — set one explicitly if the layer must sit inside
+the stack.
+
+### Image space vs. georeferenced
+
+`map_type: "iiif"` is a mercator map by default. With `map_as_image: true` the
+image _is_ the map: the view projection becomes `EPSG:4326`, the view is
+fitted to the image extent and marker locations are pixel offsets into the
+image rather than lat/lon. Ask `storymap.isImageSpace()` instead of testing
+`map_type` — georeferenced IIIF (a manifest with `navPlace` regions) is an
+ordinary mercator map, and `map_bbox` with a georeferenced layer is one too.
+
+### Knowing when the imagery is there
+
+Tile and image sources attach asynchronously, so `loaded` can fire before the
+imagery exists. Listen for `imageready`, which fires once a source is ready and
+carries `{ source, kind, layer }` (`kind` is `"iiif"`, `"zoomify"` or
+`"tiles"`); it is re-fired on the `storymap` as well:
+
+```js
+storymap.on("imageready", ({ kind, source }) => {
+    console.log("imagery ready", kind, source);
+});
+```
+
+### Tearing a storymap down
+
+Call `storymap.dispose()` when the embedding view goes away (SPA route change,
+dialog close). It clears the timers and the resize observer, removes the
+`window`/`document` listeners, cancels running slide animations, disposes the
+slider and the OpenLayers map, and sets `storymap.map` to `null`. Calling it
+twice is safe; the instance is unusable afterwards.
+
+## Custom map providers
+
+Any slippy-map tile URL works as `map_type` — pass the template verbatim
+(including `{z}/{x}/{y}`), relative or absolute:
+
+```js
+new StoryMap("embed", data, {
+    map_type: "https://tiles.example.org/base/{z}/{x}/{y}.png",
+});
+```
+
+Mapbox style JSON URLs render as vector tile layers; OpenLayers
+`Map`/`View` pass-through stays available via `options.map_options`
+(`controls` replaces the defaults, `interactions` are added to the
+viewer's own pan/zoom set, `view` merges over the computed default).
+
+For source classes the templates cannot express (WMS, authenticated or
+gridded sources), use the `tile_source_factory` option. It is consulted
+for every base, overlay and minimap layer before the built-in
+`map_type` handling — return a `TileLayer` (or a bare `Source`, which
+is wrapped in one), or `null`/`undefined` to fall through:
+
+```js
+import TileLayer from "ol/layer/Tile";
+import TileWMS from "ol/source/TileWMS";
+
+new StoryMap("embed", data, {
+    map_type: "wms:flood",
+    tile_source_factory: (map_type, { createDefault }) =>
+        map_type.startsWith("wms:")
+            ? new TileLayer({
+                  source: new TileWMS({
+                      url: "https://geoserver.example.org/wms",
+                      params: { LAYERS: map_type.slice(4) },
+                      crossOrigin: "anonymous",
+                  }),
+              })
+            : createDefault(),
+});
+```
+
+Custom sources must carry their own attributions (via the returned
+source or the `attribution` option) — only the built-in `osm*` types
+are credited automatically. `tile_source_factory` is constructor- and
+runtime-only (functions cannot ride storymap JSON) and also applies to
+`overlays[]` entries, whose `map_type` values go through the same
+factory.
 
 ## Data and tooling
 
@@ -126,14 +332,28 @@ storymap JSON sources.
   (`schema/storymap.schema.json`); invalid documents are reported to the
   console at load time.
 - IIIF Presentation 3 manifests are accepted directly as storymap sources.
-- The StoryMap IIIF extension context changed to
-  `https://christianmahnke.de/iiif/storymap` — manifests produced with the old
-  `https://example.org/ns/storymap/v1` context need re-converting
-  (`scripts/convert-to-iiif.mjs`).
+  The map settings map onto `storymap:` terms of a map configuration service
+  (IIIF has no basemap or tile-layer vocabulary of its own), and the
+  geospatial parts use the native extensions where they exist: `navPlace`
+  Points for slide locations, a `navPlace` Polygon for the story extent
+  (`map_bbox`), an IIIF Image API Selector for `location.region`, and the
+  Georeference Extension for placed rasters. A georeferenced layer is
+  manifest-only (the legacy format cannot express ground control points); see
+  [docs/storymap-as-iiif-manifest.md](storymap-as-iiif-manifest.md#geo-referenced-layers).
 - The editor, staging/backend infrastructure, AWS/GitHub hosting scripts and the
   Python authoring server are gone — this is a viewer-only library.
 
-## Events (unchanged)
+## Events (unchanged, plus two new ones)
 
-`change` (with `current_slide`), `loaded`, `title`, `dataloaded`,
+`change` (with `current_slide`, and now also `current_id` — the slide's
+`uniqueid`, for deep-linking), `loaded`, `title`, `dataloaded`,
 `fontLoaded`, plus the listener map in the constructor — all work as before.
+`markerAdded`/`markerRemoved` still fire on the map object, and `imageready`
+is new (see above).
+
+Two additions for IIIF tours: `await storymap.loadAnnotations()` fetches a
+manifest's externally referenced annotation pages and appends them as stops,
+then fires `annotationsloaded` with `{ stops, searchService, failed }`. A
+slide's stable identity is available as `storymap.getSlideId(index)`, which
+is what the `#slide-N` hash and the `iiif-content` deep link resolve
+through.