Merge branch 'develop' into update-from-template-merged

Author: xdev-gh-bot

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+github: Leaflet
+open_collective: leafletjs

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -15,9 +15,9 @@ body:
     attributes:
       label: "Checklist"
       options:
-        - label: "I am able to reproduce the bug with the [latest version](https://github.com/xdev-software/template-placeholder/releases/latest)"
+        - label: "I am able to reproduce the bug with the [latest version](https://github.com/xdev-software/vaadin-maps-leaflet-flow/releases/latest)"
           required: true
-        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/template-placeholder/issues) or [closed](https://github.com/xdev-software/template-placeholder/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
+        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/vaadin-maps-leaflet-flow/issues) or [closed](https://github.com/xdev-software/vaadin-maps-leaflet-flow/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
           required: true
         - label: "I have taken the time to fill in all the required details. I understand that the bug report will be dismissed otherwise."
           required: true

.github/ISSUE_TEMPLATE/config.yml

@@ -1,4 +1,7 @@
 contact_links:
+  - name: 🍃 Leaflet docs
+    url: https://leafletjs.com/reference.html
+    about: "Consolidate this when you have questions about Leaflet itself (and not our Vaadin component)"
   - name: 💬 Contact support
     url: https://xdev.software/en/services/support
     about: "If you need support as soon as possible or/and you can't wait for any pull request"

.github/ISSUE_TEMPLATE/enhancement.yml

@@ -13,7 +13,7 @@ body:
     attributes:
       label: "Checklist"
       options:
-        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/template-placeholder/issues) or [closed](https://github.com/xdev-software/template-placeholder/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
+        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/vaadin-maps-leaflet-flow/issues) or [closed](https://github.com/xdev-software/vaadin-maps-leaflet-flow/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
           required: true
         - label: "I have taken the time to fill in all the required details. I understand that the feature request will be dismissed otherwise."
           required: true

.github/ISSUE_TEMPLATE/question.yml

@@ -12,7 +12,7 @@ body:
     attributes:
       label: "Checklist"
       options:
-        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/template-placeholder/issues) or [closed](https://github.com/xdev-software/template-placeholder/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
+        - label: "I made sure that there are *no existing issues* - [open](https://github.com/xdev-software/vaadin-maps-leaflet-flow/issues) or [closed](https://github.com/xdev-software/vaadin-maps-leaflet-flow/issues?q=is%3Aissue+is%3Aclosed) - which I could contribute my information to."
           required: true
         - label: "I have taken the time to fill in all the required details. I understand that the question will be dismissed otherwise."
           required: true

.github/workflows/no-response.yml

@@ -0,0 +1,26 @@
+name: No Response
+
+on:
+  workflow_dispatch:
+  issue_comment:
+    types: [created]
+  schedule:
+    - cron: '5 5 * * *'
+
+jobs:
+  noResponse:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+    steps:
+      - uses: actions/stale@v9
+        with:
+          days-before-issue-stale: 7
+          days-before-issue-close: 3
+          stale-issue-label: "stale"
+          only-labels: "waiting-for-response"
+          labels-to-remove-when-unstale: "waiting-for-response"
+          stale-issue-message: "This issue will be closed soon because there has been no further activity."
+          days-before-pr-stale: -1
+          days-before-pr-close: -1
+          repo-token: ${{ secrets.GITHUB_TOKEN }}

.run/Run Demo.run.xml

@@ -1,7 +1,7 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Run Demo" type="Application" factoryName="Application">
     <option name="MAIN_CLASS_NAME" value="software.xdev.vaadin.Application" />
-    <module name="template-placeholder-demo" />
+    <module name="vaadin-maps-leaflet-flow-demo" />
     <option name="WORKING_DIRECTORY" value="$MODULE_DIR$" />
     <extension name="coverage">
       <pattern>

CHANGELOG.md

@@ -0,0 +1,101 @@
+## 4.6.0
+* Changed all occurrences of ``Integer`` and ``Double`` to ``Number`` for improved compatibility with Leaflet's API
+* Updated OpenStreetMap's Tile-Server address to ``tile.openstreetmap.org`` [openstreetmap/operations#737](https://github.com/openstreetmap/operations/issues/737)
+
+## 4.5.0
+* Added support for [WMS](https://leafletjs.com/reference.html#tilelayer-wms) #486
+* Updated dependencies
+
+## 4.4.0
+* Added support for [GeoJSON](https://leafletjs.com/reference.html#geojson) and [FeatureGroup](https://leafletjs.com/reference.html#featuregroup) #438
+* Add "draggable" property to LMarkerOptions #413 (thanks to @ChristianHoesel)
+
+## 4.3.0
+* Updated to Vaadin 24.4
+* Deduplicated ``tLMapZoomPanOptions``
+
+## 4.2.1
+* Handle ``LEvented#off`` in the same way as ``LEvented#on``
+  * Fix incorrect formatting leading to JS error
+* Updated dependencies
+
+## 4.2.0
+* Fixed some invalid built JavaScript commands #330
+* Add basic support for CRS #333
+* Added a few new showcase demos
+* Updated dependencies
+
+## 4.1.1
+* ⚠️ GroupId changed from ``com.xdev-software`` to ``software.xdev``
+* Updated dependencies
+
+## 4.1.0
+* Provide a workaround that fixes a problem where certain methods didn't work instantly after the map was created #305
+* Moved some container specific methods to ``MapContainer``
+
+## 4.0.1
+* Added shortcut method ``invokeSelfReturn`` #282
+* Updated dependencies
+
+## 4.0.0
+⚠️<i>This release contains breaking changes</i>
+
+* The complete API got reworked and now has the [same structure as Leaflet](https://leafletjs.com/reference.html).
+* Added lots of new Leaflet APIs - currently around 90% of the Leaflet API are implemented. These include the most useful bits:
+  * GeoLocation
+  * A lot of new methods for Map
+  * Tooltips & Popups
+  * Image, Video and SVG-Overlays
+  * Rectangles
+  * Controls for Scale, Layers, ...
+  * and much more
+* Abstracted the elements similar to how this is done inside Leaflet itself so that they can easily be extended
+* The API only supports sending instructions to the client. Retrieving client side data is not supported as data integrity can't be guaranteed (client-side data can be modified by users).
+  * Event listeners can still be registered but this needs to be done manually. A example is available in the demo.
+* All Leaflet elements are now tracked on the client and on the server and can therefore be modified/reused (using ``LComponentManagementRegistry``).
+  * Before it was only possible to create an element and then send it to the client
+  * However keep in mind when creating a lot of elements that you may have to free up memory on the client (manually)
+* Integrated default Leaflet resources
+
+## 3.0.2
+* Added support for Polyline #266 (thanks to @blitzdose)
+
+## 3.0.1
+* Fixed ``divIcon`` being displayed incorrectly [due to a default ``iconSize`` of ``12px``](https://github.com/Leaflet/Leaflet/issues/4238) #246
+* Updated dependencies
+  * Updated leaflet to [``1.9.4``](https://github.com/Leaflet/Leaflet/blob/b6b56f6e707142c177fad2f67827a5007e56736a/CHANGELOG.md#194-2023-05-18) #247
+
+## 3.0.0
+⚠️<i>This release contains breaking changes</i>
+
+* Adds support for Vaadin 24+, drops support for Vaadin 23<br/>
+  <i>If you are still using Vaadin 23, use the ``2.x`` versions.</i>
+  * Requires Java 17+
+
+## 2.0.4
+* Added method ``centerAndZoom`` in ``LMap``
+* Fixed a problem where an invalid ``iconSize`` was transferred to leaflet which caused a client side exception (#199)
+* Updated various dependencies
+
+## 2.0.3
+* Updated dependencies
+* Fixed problem with setting lon/lan in LMarker
+* Added constructors for LMap
+
+## 2.0.2
+* Updated dependencies
+
+## 2.0.1
+* Updated dependencies
+  * Vaadin 23.2
+
+## 2.0.0
+⚠️<i>This release contains breaking changes</i>
+
+* Update to Vaadin 23
+  * Removed deprecated polymer-connector - replaced by ``executeJs``
+* Fixed a problem where the map was not rendered/aligned correctly
+* Don't load anything from remote servers that are not under control of the user
+* Shrunk the jar
+* Removed default leafletmap tile layer; has to be set manually due to usage policy
+* Updated dependency versions

CONTRIBUTING.md

@@ -47,10 +47,10 @@ Bigger changes may require a complete restart.
   * [Vaadin automatically reloads the UI on each restart](https://vaadin.com/docs/latest/configuration/live-reload/spring-boot).<br/>
   You can control this behavior with the ``vaadin.devmode.liveReload.enabled`` property (default: ``true``).
 
-## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/template-placeholder/release.yml?branch=master)](https://github.com/xdev-software/template-placeholder/actions/workflows/release.yml)
+## Releasing [![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/vaadin-maps-leaflet-flow/release.yml?branch=master)](https://github.com/xdev-software/vaadin-maps-leaflet-flow/actions/workflows/release.yml)
 
 Before releasing:
-* Consider doing a [test-deployment](https://github.com/xdev-software/template-placeholder/actions/workflows/test-deploy.yml?query=branch%3Adevelop) before actually releasing.
+* Consider doing a [test-deployment](https://github.com/xdev-software/vaadin-maps-leaflet-flow/actions/workflows/test-deploy.yml?query=branch%3Adevelop) before actually releasing.
 * Check the [changelog](CHANGELOG.md)
 
 If the ``develop`` is ready for release, create a pull request to the ``master``-Branch and merge the changes

README.md

@@ -1,24 +1,58 @@
-[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0?logo=vaadin)](https://vaadin.com/directory/component/template-placeholder)
-[![Latest version](https://img.shields.io/maven-central/v/software.xdev/template-placeholder?logo=apache%20maven)](https://mvnrepository.com/artifact/software.xdev/template-placeholder)
-[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/template-placeholder/check-build.yml?branch=develop)](https://github.com/xdev-software/template-placeholder/actions/workflows/check-build.yml?query=branch%3Adevelop)
-[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=xdev-software_template-placeholder&metric=alert_status)](https://sonarcloud.io/dashboard?id=xdev-software_template-placeholder)
+[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0?logo=vaadin)](https://vaadin.com/directory/component/leafletmap-for-vaadin)
+[![Latest version](https://img.shields.io/maven-central/v/software.xdev/vaadin-maps-leaflet-flow?logo=apache%20maven)](https://mvnrepository.com/artifact/software.xdev/vaadin-maps-leaflet-flow)
+[![Build](https://img.shields.io/github/actions/workflow/status/xdev-software/vaadin-maps-leaflet-flow/check-build.yml?branch=develop)](https://github.com/xdev-software/vaadin-maps-leaflet-flow/actions/workflows/check-build.yml?query=branch%3Adevelop)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=xdev-software_vaadin-maps-leaflet-flow&metric=alert_status)](https://sonarcloud.io/dashboard?id=xdev-software_vaadin-maps-leaflet-flow)
 ![Vaadin 24+](https://img.shields.io/badge/Vaadin%20Platform/Flow-24+-00b4f0)
 
-# template-placeholder
-A Vaadin Template Repo
+# vaadin-maps-leaflet-flow
+A Vaadin Flow Java API for [Leaflet](https://leafletjs.com/)
 
 ![demo](assets/demo.png)
 
+## Usage
+
+This API wraps the Leaflet API in a Vaadin friendly way.<br/>It uses a similar structure (classes, methods) as the [Leaflet JavaScript API](https://leafletjs.com/reference.html).
+
+To get started it's recommended to have a look at the [demo](./vaadin-maps-leaflet-flow-demo), notably the [minimalistic example](./vaadin-maps-leaflet-flow-demo/src/main/java/software/xdev/vaadin/maps/leaflet/flow/demo/MinimalisticDemo.java).
+
+> [!NOTE]
+> **The API only supports sending instructions to the client**<br/>
+> Due to data integrity retrieving client-side data (that can be modified by users) is not supported.
+> 
+> Event listeners can still be registered but this needs to be done manually. An example is available [in the demo](./vaadin-maps-leaflet-flow-demo/src/main/java/software/xdev/vaadin/maps/leaflet/flow/demo/EventDemo.java).
+> 
+> <details><summary>The following code snippet is a simplification of an even more <a href="./vaadin-maps-leaflet-flow-demo/src/main/java/software/xdev/vaadin/maps/leaflet/flow/demo/ComplexDemo.java#L251">complex example</a> which sends (unvalidated!) client side data back to the server (click to expand)</summary>
+>
+> ```java
+> this.map.on("click", "e => document.getElementById('" + ID + "').$server.mapClicked(e.latlng.lat, e.latng.lng)");
+> ...
+> @ClientCallable
+> public void mapClicked(double lat, double lng)
+> {
+>   LOG.info("Map clicked - lat: {}, lng: {}", lat, lng);
+> }
+> ```
+> </details>
 
 ## Installation
-[Installation guide for the latest release](https://github.com/xdev-software/template-placeholder/releases/latest#Installation)
+[Installation guide of the latest release](https://github.com/xdev-software/vaadin-maps-leaflet-flow/releases/latest#Installation)
+
+#### Static resources
+Please note that Leaflet uses a few default icons for various components (e.g. Markers).<br/>
+These are also shipped with the library and can be found inside [``META-INF/resources``](./vaadin-maps-leaflet-flow/src/main/resources/META-INF/resources/).<br/>
+You might have to fine tune your security configuration to allow these.
+
+#### Compatibility with Vaadin
+| Vaadin version | vaadin-maps-leaflet-flow version |
+| --- | --- |
+| Vaadin 24+ (latest) | ``3+`` |
 
 ### Spring-Boot
 * You may have to include ``software/xdev`` inside [``vaadin.allowed-packages``](https://vaadin.com/docs/latest/integrations/spring/configuration#configure-the-scanning-of-packages)
 
 ## Run the Demo
 * Checkout the repo
-* Run ``mvn install && mvn -f template-placeholder-demo spring-boot:run``
+* Run ``mvn install && mvn -f vaadin-maps-leaflet-flow-demo spring-boot:run``
 * Open http://localhost:8080
 
 <details>
@@ -34,4 +68,4 @@ If you need support as soon as possible and you can't wait for any pull request,
 See the [contributing guide](./CONTRIBUTING.md) for detailed instructions on how to get started with our project.
 
 ## Dependencies and Licenses
-View the [license of the current project](LICENSE) or the [summary including all dependencies](https://xdev-software.github.io/template-placeholder/dependencies)
+View the [license of the current project](LICENSE) or the [summary including all dependencies](https://xdev-software.github.io/vaadin-maps-leaflet-flow/dependencies)