@panoramax/web-viewer 3.2.3 → 4.0.0

package/.gitlab-ci.yml

@@ -40,6 +40,9 @@ viewer-publish-develop-tag:
     cache:
         paths:
             - node_modules
+    artifacts:
+        paths:
+            - build
     variables:
         CI: 1
     script:
@@ -54,17 +57,21 @@ viewer-publish-develop-tag:
 # Develop publishing on Gitlab Pages
 pages:
     stage: deploy
+    needs:
+        - viewer-publish-develop-tag
     only:
       - develop
-    image: node:16
+    image: python:3-bookworm
+    variables:
+        PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip"
     cache:
         paths:
-            - node_modules
-    variables:
-        CI: 1
+            - .cache/pip
     script:
-        - npm install --legacy-peer-deps
-        - npm run build
+        - >
+            cp mkdocs.yml mkdocs_dev.yml && sed -i 's|^site_url.*|site_url: https://viewer.geovisio.fr/docs|' mkdocs_dev.yml
+        - pip3 install mkdocs-material
+        - mkdocs build -d build/docs -f mkdocs_dev.yml
     artifacts:
         paths:
             - build

package/CHANGELOG.md

@@ -8,9 +8,56 @@ Before _2.0.0_, Viewer was embed in the [API repository](https://gitlab.com/pano
 
 ## [Unreleased]
 
+## [4.0.0] - 2025-04-03
+
+Major changes are introduced by this new version, please [check out the migration guide](https://docs.panoramax.fr/web-viewer/tutorials/migrate_v4/) for more details.
+
+### Added
+
+- `endpoint` parameter can be changed dynamically.
+- Develop version of docs are available at [viewer.geovisio.fr/docs](https://viewer.geovisio.fr/docs/), stable version stays at [docs.panoramax.fr](https://docs.panoramax.fr/web-viewer/).
+- New languages: 🇸🇪 Swedish, 🇯🇵 Japanese and 🇳🇱 Dutch.
+- Loader features a progress bar, and adopts a new look.
+- Viewer map filter by date input checks if min date is lower than max date, and eventually inverts if necessary.
+- Viewer map center, zoom, background and theme are stored in `localStorage` to permit restoring map position at load. This position is used __only if no URL parameter is set__ for these settings.
+- New main component: `<pnx-photo-viewer>` for showing up only picture (without any map). This leads classic viewer `<pnx-viewer>` to not allow removing its map anymore.
+- `ready` events for API, Map & Photo components.
+- Player widget size adapts based on container height at load.
+- Display origin instance in picture legend.
+
+### Changed
+
+- All code is managed using _Web components_ (with [Lit JS](https://lit.dev/)), and should be initialized through DOM instead of class constructors.
+- Code is splitted in more components, classes and packages.
+- Events are moved nearer their dedicated component (map, photo). The `addEventListener` can still be called on parent component using a sub-component prefix (like `map:moveend` to pass event from Viewer to its Map).
+- Styles are manage through common JS or CSS files.
+- Viewer widgets can be fine-tuned using web component slots.
+- Parameters between URL and component attributes are finer managed to avoid conflicts.
+- Documentation of API reference is more extensive and uses MkDocs features for clarity.
+- URL parameters are now stored in _search_ part (`?`) instead of _hash_ part (`#`). An automatic URL transform is operated if older format is detected.
+- Updated PSV to 5.12.1, MapLibre GL to 5.3.0.
+- Improved address search result display.
+- Switched font to [Atkinson Next](https://www.brailleinstitute.org/freefont) for improved readability.
+- Changed picture type selector to a three-buttons input (All/Classic/360).
+- Shortcut for date selection in viewer also reset end date.
+- For 360° pictures not looking forward (in movement direction), viewer now looks in direction of movement instead of capture direction.
+- When available, viewer display picture capture date according to timezone where it was captured (instead of user web browser local time).
+
+### Fixed
+
+- `nav=none` URL parameter was documented but not usable (code supported `nav=pic` instead). Now both `none & pic` values are supported to disable moving around picture.
+- Long-loading sequences in Editor where reaching 15s timeout, this constraint has been dropped.
+- Cropped panorama with tiles were not rendering correctly.
+- Regional languages were not correctly handled (underscore used instead of `-`).
+
+### Removed
+
+- `focus=meta` isn't available anymore as URL setting, as picture metadata shows up directly on picture side.
+
 ## [3.2.3] - 2025-02-10
 
 ### Added
+
 - In viewer, when map is expanded, a double-click somewhere else than a picture makes previous picture unselected. Viewer can also be programmatically called to unselect a picture.
 
 ### Changed
@@ -491,7 +538,8 @@ Empty release to follow the API's minor version
 - [A Photo Sphere Viewer under Chrome issue](https://github.com/mistic100/Photo-Sphere-Viewer/issues/937) was making classic pictures not visible
 
 
-[Unreleased]: https://gitlab.com/panoramax/clients/web-viewer/-/compare/3.2.3...develop
+[Unreleased]: https://gitlab.com/panoramax/clients/web-viewer/-/compare/4.0.0...develop
+[4.0.0]: https://gitlab.com/panoramax/clients/web-viewer/-/compare/3.2.3...4.0.0
 [3.2.3]: https://gitlab.com/panoramax/clients/web-viewer/-/compare/3.2.2...3.2.3
 [3.2.2]: https://gitlab.com/panoramax/clients/web-viewer/-/compare/3.2.1...3.2.2
 [3.2.1]: https://gitlab.com/panoramax/clients/web-viewer/-/compare/3.2.0...3.2.1

package/CODE_OF_CONDUCT.md

@@ -60,7 +60,7 @@ representative at an online or offline event.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at panieravide@riseup.net
+reported to the community leaders responsible for enforcement at panoramax@panoramax.fr
 
 All complaints will be reviewed and investigated promptly and fairly.
 

package/README.md

@@ -24,7 +24,7 @@ Its features includes:
 
 Our [documentation](https://gitlab.com/panoramax/clients/web-viewer/-/tree/develop/docs) will help you install, configure and use the Panoramax viewer.
 
-If at some point you're lost or need help, you can contact us through [issues](https://gitlab.com/panoramax/clients/web-viewer/-/issues) or by [email](mailto:panieravide@riseup.net).
+If at some point you're lost or need help, you can contact us through [issues](https://gitlab.com/panoramax/clients/web-viewer/-/issues) or by [email](mailto:panoramax@panoramax.fr).
 
 
 ## Contributing

package/build/editor.html

@@ -1 +1,10 @@
-<!doctype html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1,shrink-to-fit=no"><title>Panoramax Editor</title><style>#editor{position:relative;width:95%;margin:2.5%;height:400px}#editor.fullpage{position:fixed;top:0;bottom:0;left:0;right:0;height:unset;width:unset;margin:0}</style><script defer="defer" src="index.js"></script><link href="index.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><div id="editor" class="fullpage"></div><script>var editor;window.onload=()=>{editor=new Panoramax.Editor("editor","https://panoramax.openstreetmap.fr/api",{selectedSequence:"ecfe4b2c-0acd-4d3a-a10d-c3e6818755c8",selectedPicture:"329af5c6-4761-4a6d-9c1e-674fd6daa8b6",background:"aerial",raster:{type:"raster",tiles:["https://data.geopf.fr/wmts?SERVICE=WMTS&REQUEST=GetTile&VERSION=1.0.0&LAYER=ORTHOIMAGERY.ORTHOPHOTOS&STYLE=normal&FORMAT=image/jpeg&TILEMATRIXSET=PM_0_21&TILEMATRIX={z}&TILEROW={y}&TILECOL={x}"],minzoom:0,maxzoom:21,attribution:"&copy; IGN",tileSize:256}})}</script></body></html>
+<!doctype html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1,shrink-to-fit=no"><title>Panoramax Editor</title><style>#editor{position:relative;width:95%;margin:2.5%;height:400px}#editor.fullpage{position:fixed;inset:0;height:unset;width:unset;margin:0}</style><script defer="defer" src="index.js"></script><link href="index.css" rel="stylesheet"></head><body><noscript>You need to enable JavaScript to run this app.</noscript><pnx-editor id="editor" class="fullpage" endpoint="https://panoramax.openstreetmap.fr/api" sequence="ecfe4b2c-0acd-4d3a-a10d-c3e6818755c8" picture="329af5c6-4761-4a6d-9c1e-674fd6daa8b6" background="aerial" raster='{
+    type: "raster",
+    tiles: [
+      "https://data.geopf.fr/wmts?SERVICE=WMTS&REQUEST=GetTile&VERSION=1.0.0&LAYER=ORTHOIMAGERY.ORTHOPHOTOS&STYLE=normal&FORMAT=image/jpeg&TILEMATRIXSET=PM_0_21&TILEMATRIX={z}&TILEROW={y}&TILECOL={x}"
+    ],
+    minzoom: 0,
+    maxzoom: 21,
+    attribution: "&copy; IGN",
+    tileSize: 256
+  }'></pnx-editor></body></html>