[Map] Replace LatLng by Point

Author: Kocal

src/Map/assets/dist/abstract_map_controller.d.ts

@@ -1,25 +1,25 @@
 import { Controller } from '@hotwired/stimulus';
-export type LatLng = {
+export type Point = {
     lat: number;
     lng: number;
 };
 export type MapView<Options, MarkerOptions, InfoWindowOptions> = {
-    center: LatLng;
+    center: Point;
     zoom: number;
     fitBoundsToMarkers: boolean;
     markers: Array<MarkerDefinition<MarkerOptions, InfoWindowOptions>>;
     options: Options;
 };
 export type MarkerDefinition<MarkerOptions, InfoWindowOptions> = {
-    position: LatLng;
+    position: Point;
     title: string | null;
     infoWindow?: Omit<InfoWindowDefinition<InfoWindowOptions>, 'position'>;
     rawOptions?: MarkerOptions;
 };
 export type InfoWindowDefinition<InfoWindowOptions> = {
     headerContent: string | null;
     content: string | null;
-    position: LatLng;
+    position: Point;
     opened: boolean;
     autoClose: boolean;
     rawOptions?: InfoWindowOptions;
@@ -36,7 +36,7 @@ export default abstract class<MapOptions, Map, MarkerOptions, Marker, InfoWindow
     initialize(): void;
     connect(): void;
     protected abstract doCreateMap({ center, zoom, options, }: {
-        center: LatLng;
+        center: Point;
         zoom: number;
         options: MapOptions;
     }): Map;

src/Map/assets/src/abstract_map_controller.ts

@@ -1,17 +1,17 @@
 import { Controller } from '@hotwired/stimulus';
 
-export type LatLng = { lat: number; lng: number };
+export type Point = { lat: number; lng: number };
 
 export type MapView<Options, MarkerOptions, InfoWindowOptions> = {
-    center: LatLng;
+    center: Point;
     zoom: number;
     fitBoundsToMarkers: boolean;
     markers: Array<MarkerDefinition<MarkerOptions, InfoWindowOptions>>;
     options: Options;
 };
 
 export type MarkerDefinition<MarkerOptions, InfoWindowOptions> = {
-    position: LatLng;
+    position: Point;
     title: string | null;
     infoWindow?: Omit<InfoWindowDefinition<InfoWindowOptions>, 'position'>;
     rawOptions?: MarkerOptions;
@@ -20,7 +20,7 @@ export type MarkerDefinition<MarkerOptions, InfoWindowOptions> = {
 export type InfoWindowDefinition<InfoWindowOptions> = {
     headerContent: string | null;
     content: string | null;
-    position: LatLng;
+    position: Point;
     opened: boolean;
     autoClose: boolean;
     rawOptions?: InfoWindowOptions;
@@ -72,7 +72,7 @@ export default abstract class<
         zoom,
         options,
     }: {
-        center: LatLng;
+        center: Point;
         zoom: number;
         options: MapOptions;
     }): Map;

src/Map/doc/index.rst

@@ -67,9 +67,9 @@ A map is created by calling ``new Map()``. You can configure the center, zoom, a
     use Symfony\Component\HttpFoundation\Response;
     use Symfony\Component\Routing\Attribute\Route;
     use Symfony\UX\Map\InfoWindow;
-    use Symfony\UX\Map\LatLng;
     use Symfony\UX\Map\Map;
     use Symfony\UX\Map\Marker;
+    use Symfony\UX\Map\Point;
     
     final class HomeController extends AbstractController
     {
@@ -78,18 +78,18 @@ A map is created by calling ``new Map()``. You can configure the center, zoom, a
         {
             // 1. Create a new map instance
             $myMap = (new Map());
-                ->center(new LatLng(46.903354, 1.888334))
+                ->center(new Point(46.903354, 1.888334))
                 ->zoom(6)
             ;
     
             // 2. You can add markers, with an optional info window
             $myMap
                 ->addMarker(new Marker(
-                    position: new LatLng(48.8566, 2.3522), 
+                    position: new Point(48.8566, 2.3522), 
                     title: 'Paris'
                 ))
                 ->addMarker(new Marker(
-                    position: new LatLng(45.7640, 4.8357), 
+                    position: new Point(45.7640, 4.8357), 
                     title: 'Lyon',
                     // With an info window
                     infoWindow: new InfoWindow(

src/Map/src/Bridge/Google/README.md

@@ -37,11 +37,11 @@ use Symfony\UX\Map\Bridge\Google\Option\MapTypeControlOptions;
 use Symfony\UX\Map\Bridge\Google\Option\MapTypeControlStyle;
 use Symfony\UX\Map\Bridge\Google\Option\StreetViewControlOptions;
 use Symfony\UX\Map\Bridge\Google\Option\ZoomControlOptions;
-use Symfony\UX\Map\LatLng;
+use Symfony\UX\Map\Point;
 use Symfony\UX\Map\Map;
 
 $map = (new Map())
-    ->center(new LatLng(48.8566, 2.3522))
+    ->center(new Point(48.8566, 2.3522))
     ->zoom(6);
 
 // To configure controls options, and some other options:

src/Map/src/Bridge/Google/assets/dist/map_controller.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="google.maps" />
 import AbstractMapController from '@symfony/ux-map/abstract-map-controller';
-import type { LatLng, MarkerDefinition } from '@symfony/ux-map/abstract-map-controller';
+import type { Point, MarkerDefinition } from '@symfony/ux-map/abstract-map-controller';
 import type { LoaderOptions } from '@googlemaps/js-api-loader';
 type MapOptions = Pick<google.maps.MapOptions, 'mapId' | 'gestureHandling' | 'backgroundColor' | 'disableDoubleClickZoom' | 'zoomControl' | 'zoomControlOptions' | 'mapTypeControl' | 'mapTypeControlOptions' | 'streetViewControl' | 'streetViewControlOptions' | 'fullscreenControl' | 'fullscreenControlOptions'>;
 export default class extends AbstractMapController<MapOptions, google.maps.Map, google.maps.marker.AdvancedMarkerElement, google.maps.InfoWindow> {
@@ -10,7 +10,7 @@ export default class extends AbstractMapController<MapOptions, google.maps.Map,
     providerOptionsValue: Pick<LoaderOptions, 'apiKey' | 'id' | 'language' | 'region' | 'nonce' | 'retries' | 'url' | 'version'>;
     connect(): Promise<void>;
     protected doCreateMap({ center, zoom, options, }: {
-        center: LatLng;
+        center: Point;
         zoom: number;
         options: MapOptions;
     }): google.maps.Map;

src/Map/src/Bridge/Google/assets/src/map_controller.ts

@@ -8,7 +8,7 @@
  */
 
 import AbstractMapController from '@symfony/ux-map/abstract-map-controller';
-import type { LatLng, MarkerDefinition } from '@symfony/ux-map/abstract-map-controller';
+import type { Point, MarkerDefinition } from '@symfony/ux-map/abstract-map-controller';
 import type { LoaderOptions } from '@googlemaps/js-api-loader';
 import { Loader } from '@googlemaps/js-api-loader';
 
@@ -67,7 +67,7 @@ export default class extends AbstractMapController<
         zoom,
         options,
     }: {
-        center: LatLng;
+        center: Point;
         zoom: number;
         options: MapOptions;
     }): google.maps.Map {

src/Map/src/Bridge/Google/tests/GoogleRendererTest.php

@@ -14,9 +14,9 @@
 use Symfony\UX\Map\Bridge\Google\GoogleOptions;
 use Symfony\UX\Map\Bridge\Google\Renderer\GoogleRenderer;
 use Symfony\UX\Map\InfoWindow;
-use Symfony\UX\Map\LatLng;
 use Symfony\UX\Map\Map;
 use Symfony\UX\Map\Marker;
+use Symfony\UX\Map\Point;
 use Symfony\UX\Map\Test\RendererTestCase;
 use Symfony\UX\StimulusBundle\Helper\StimulusHelper;
 
@@ -25,7 +25,7 @@ class GoogleRendererTest extends RendererTestCase
     public function provideTestRenderMap(): iterable
     {
         $map = (new Map())
-            ->center(new LatLng(48.8566, 2.3522))
+            ->center(new Point(48.8566, 2.3522))
             ->zoom(12);
 
         yield 'simple map, with minimum options' => [
@@ -44,8 +44,8 @@ public function provideTestRenderMap(): iterable
             'expected_render' => '<div data-controller="symfony--ux-map-google--map" data-symfony--ux-map-google--map-provider-options-value="&#x7B;&quot;apiKey&quot;&#x3A;&quot;api_key&quot;&#x7D;" data-symfony--ux-map-google--map-view-value="&#x7B;&quot;center&quot;&#x3A;&#x7B;&quot;lat&quot;&#x3A;48.8566,&quot;lng&quot;&#x3A;2.3522&#x7D;,&quot;zoom&quot;&#x3A;12,&quot;fitBoundsToMarkers&quot;&#x3A;false,&quot;options&quot;&#x3A;&#x7B;&quot;mapId&quot;&#x3A;null,&quot;gestureHandling&quot;&#x3A;&quot;auto&quot;,&quot;backgroundColor&quot;&#x3A;null,&quot;disableDoubleClickZoom&quot;&#x3A;false,&quot;zoomControlOptions&quot;&#x3A;&#x7B;&quot;position&quot;&#x3A;22&#x7D;,&quot;mapTypeControlOptions&quot;&#x3A;&#x7B;&quot;mapTypeIds&quot;&#x3A;&#x5B;&#x5D;,&quot;position&quot;&#x3A;14,&quot;style&quot;&#x3A;0&#x7D;,&quot;streetViewControlOptions&quot;&#x3A;&#x7B;&quot;position&quot;&#x3A;22&#x7D;,&quot;fullscreenControlOptions&quot;&#x3A;&#x7B;&quot;position&quot;&#x3A;20&#x7D;&#x7D;,&quot;markers&quot;&#x3A;&#x5B;&#x7B;&quot;position&quot;&#x3A;&#x7B;&quot;lat&quot;&#x3A;48.8566,&quot;lng&quot;&#x3A;2.3522&#x7D;,&quot;title&quot;&#x3A;&quot;Paris&quot;,&quot;infoWindow&quot;&#x3A;null&#x7D;,&#x7B;&quot;position&quot;&#x3A;&#x7B;&quot;lat&quot;&#x3A;48.8566,&quot;lng&quot;&#x3A;2.3522&#x7D;,&quot;title&quot;&#x3A;&quot;Lyon&quot;,&quot;infoWindow&quot;&#x3A;&#x7B;&quot;headerContent&quot;&#x3A;null,&quot;content&quot;&#x3A;&quot;Lyon&quot;,&quot;position&quot;&#x3A;null,&quot;opened&quot;&#x3A;false,&quot;autoClose&quot;&#x3A;true&#x7D;&#x7D;&#x5D;&#x7D;"></div>',
             'renderer' => new GoogleRenderer(new StimulusHelper(null), apiKey: 'api_key'),
             'map' => (clone $map)
-                ->addMarker(new Marker(new LatLng(48.8566, 2.3522), 'Paris'))
-                ->addMarker(new Marker(new LatLng(48.8566, 2.3522), 'Lyon', infoWindow: new InfoWindow(content: 'Lyon'))),
+                ->addMarker(new Marker(new Point(48.8566, 2.3522), 'Paris'))
+                ->addMarker(new Marker(new Point(48.8566, 2.3522), 'Lyon', infoWindow: new InfoWindow(content: 'Lyon'))),
         ];
 
         yield 'with controls enabled' => [

src/Map/src/Bridge/Leaflet/README.md

@@ -15,11 +15,11 @@ You can use the `LeafletOptions` class to configure your `Map`::
 ```php
 use Symfony\UX\Map\Bridge\Leaflet\LeafletOptions;
 use Symfony\UX\Map\Bridge\Leaflet\Option\TileLayer;
-use Symfony\UX\Map\LatLng;
+use Symfony\UX\Map\Point;
 use Symfony\UX\Map\Map;
 
 $map = (new Map())
-    ->center(new LatLng(48.8566, 2.3522))
+    ->center(new Point(48.8566, 2.3522))
     ->zoom(6);
 
 $leafletOptions = (new LeafletOptions())

src/Map/src/Bridge/Leaflet/assets/dist/map_controller.d.ts

@@ -1,5 +1,5 @@
 import AbstractMapController from '@symfony/ux-map/abstract-map-controller';
-import type { LatLng, MarkerDefinition } from '@symfony/ux-map/abstract-map-controller';
+import type { Point, MarkerDefinition } from '@symfony/ux-map/abstract-map-controller';
 import 'leaflet/dist/leaflet.min.css';
 import { type Map as LeafletMap, Marker, type Popup } from 'leaflet';
 import type { MapOptions as LeafletMapOptions, MarkerOptions, PopupOptions } from 'leaflet';
@@ -12,8 +12,8 @@ type MapOptions = Pick<LeafletMapOptions, 'center' | 'zoom'> & {
 };
 export default class extends AbstractMapController<MapOptions, typeof LeafletMap, MarkerOptions, Marker, Popup, PopupOptions> {
     connect(): void;
-    protected doCreateMap({ center, zoom, options, }: {
-        center: LatLng;
+    protected doCreateMap({ center, zoom, options }: {
+        center: Point;
         zoom: number;
         options: MapOptions;
     }): LeafletMap;

src/Map/src/Bridge/Leaflet/assets/dist/map_controller.js

@@ -13,7 +13,7 @@ class map_controller extends AbstractMapController {
         });
         super.connect();
     }
-    doCreateMap({ center, zoom, options, }) {
+    doCreateMap({ center, zoom, options }) {
         const map$1 = map(this.element, {
             ...options,
             center,

src/Map/src/Bridge/Leaflet/assets/src/map_controller.ts

@@ -1,5 +1,5 @@
 import AbstractMapController from '@symfony/ux-map/abstract-map-controller';
-import type { LatLng, MarkerDefinition } from '@symfony/ux-map/abstract-map-controller';
+import type { Point, MarkerDefinition } from '@symfony/ux-map/abstract-map-controller';
 import 'leaflet/dist/leaflet.min.css';
 import {
     map as createMap,
@@ -35,11 +35,7 @@ export default class extends AbstractMapController<
         super.connect();
     }
 
-    protected doCreateMap({
-        center,
-        zoom,
-        options,
-    }: { center: LatLng; zoom: number; options: MapOptions }): LeafletMap {
+    protected doCreateMap({ center, zoom, options }: { center: Point; zoom: number; options: MapOptions }): LeafletMap {
         const map = createMap(this.element, {
             ...options,
             center,

src/Map/src/Bridge/Leaflet/tests/LeafletRendererTest.php

@@ -13,9 +13,9 @@
 
 use Symfony\UX\Map\Bridge\Leaflet\Renderer\LeafletRenderer;
 use Symfony\UX\Map\InfoWindow;
-use Symfony\UX\Map\LatLng;
 use Symfony\UX\Map\Map;
 use Symfony\UX\Map\Marker;
+use Symfony\UX\Map\Point;
 use Symfony\UX\Map\Test\RendererTestCase;
 use Symfony\UX\StimulusBundle\Helper\StimulusHelper;
 
@@ -24,7 +24,7 @@ class LeafletRendererTest extends RendererTestCase
     public function provideTestRenderMap(): iterable
     {
         $map = (new Map())
-            ->center(new LatLng(48.8566, 2.3522))
+            ->center(new Point(48.8566, 2.3522))
             ->zoom(12);
 
         yield 'simple map' => [
@@ -37,8 +37,8 @@ public function provideTestRenderMap(): iterable
             'expected_render' => '<div data-controller="symfony--ux-map-leaflet--map" data-symfony--ux-map-leaflet--map-provider-options-value="&#x7B;&#x7D;" data-symfony--ux-map-leaflet--map-view-value="&#x7B;&quot;center&quot;&#x3A;&#x7B;&quot;lat&quot;&#x3A;48.8566,&quot;lng&quot;&#x3A;2.3522&#x7D;,&quot;zoom&quot;&#x3A;12,&quot;fitBoundsToMarkers&quot;&#x3A;false,&quot;options&quot;&#x3A;&#x7B;&quot;tileLayer&quot;&#x3A;&#x7B;&quot;url&quot;&#x3A;&quot;https&#x3A;&#x5C;&#x2F;&#x5C;&#x2F;tile.openstreetmap.org&#x5C;&#x2F;&#x7B;z&#x7D;&#x5C;&#x2F;&#x7B;x&#x7D;&#x5C;&#x2F;&#x7B;y&#x7D;.png&quot;,&quot;attribution&quot;&#x3A;&quot;&#x5C;u00a9&#x20;&lt;a&#x20;href&#x3D;&#x5C;&quot;https&#x3A;&#x5C;&#x2F;&#x5C;&#x2F;www.openstreetmap.org&#x5C;&#x2F;copyright&#x5C;&quot;&gt;OpenStreetMap&lt;&#x5C;&#x2F;a&gt;&quot;,&quot;options&quot;&#x3A;&#x7B;&#x7D;&#x7D;&#x7D;,&quot;markers&quot;&#x3A;&#x5B;&#x7B;&quot;position&quot;&#x3A;&#x7B;&quot;lat&quot;&#x3A;48.8566,&quot;lng&quot;&#x3A;2.3522&#x7D;,&quot;title&quot;&#x3A;&quot;Paris&quot;,&quot;infoWindow&quot;&#x3A;null&#x7D;,&#x7B;&quot;position&quot;&#x3A;&#x7B;&quot;lat&quot;&#x3A;48.8566,&quot;lng&quot;&#x3A;2.3522&#x7D;,&quot;title&quot;&#x3A;&quot;Lyon&quot;,&quot;infoWindow&quot;&#x3A;&#x7B;&quot;headerContent&quot;&#x3A;null,&quot;content&quot;&#x3A;&quot;Lyon&quot;,&quot;position&quot;&#x3A;null,&quot;opened&quot;&#x3A;false,&quot;autoClose&quot;&#x3A;true&#x7D;&#x7D;&#x5D;&#x7D;"></div>',
             'renderer' => new LeafletRenderer(new StimulusHelper(null)),
             'map' => (clone $map)
-                ->addMarker(new Marker(new LatLng(48.8566, 2.3522), 'Paris'))
-                ->addMarker(new Marker(new LatLng(48.8566, 2.3522), 'Lyon', infoWindow: new InfoWindow(content: 'Lyon'))),
+                ->addMarker(new Marker(new Point(48.8566, 2.3522), 'Paris'))
+                ->addMarker(new Marker(new Point(48.8566, 2.3522), 'Lyon', infoWindow: new InfoWindow(content: 'Lyon'))),
         ];
     }
 }

src/Map/src/InfoWindow.php

@@ -21,7 +21,7 @@
     public function __construct(
         private ?string $headerContent = null,
         private ?string $content = null,
-        private ?LatLng $position = null,
+        private ?Point $position = null,
         private bool $opened = false,
         private bool $autoClose = true,
     ) {

src/Map/src/Map.php

@@ -23,7 +23,7 @@ final class Map
     public function __construct(
         private readonly ?string $rendererName = null,
         private ?MapOptionsInterface $options = null,
-        private ?LatLng $center = null,
+        private ?Point $center = null,
         private ?float $zoom = null,
         private bool $fitBoundsToMarkers = false,
         /**
@@ -38,7 +38,7 @@ public function getRendererName(): ?string
         return $this->rendererName;
     }
 
-    public function center(LatLng $center): self
+    public function center(Point $center): self
     {
         $this->center = $center;
 

src/Map/src/Marker.php

@@ -19,7 +19,7 @@
 final readonly class Marker
 {
     public function __construct(
-        private LatLng $position,
+        private Point $position,
         private ?string $title = null,
         private ?InfoWindow $infoWindow = null,
     ) {

src/Map/src/LatLng.php renamed to src/Map/src/Point.php

@@ -18,7 +18,7 @@
  *
  * @author Hugo Alliaume <hugo@alliau.me>
  */
-final readonly class LatLng
+final readonly class Point
 {
     public function __construct(
         public float $latitude,

src/Map/tests/InfoWindowTest.php

@@ -13,7 +13,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\UX\Map\InfoWindow;
-use Symfony\UX\Map\LatLng;
+use Symfony\UX\Map\Point;
 
 class InfoWindowTest extends TestCase
 {
@@ -22,7 +22,7 @@ public function testToArray(): void
         $infoWindow = new InfoWindow(
             headerContent: 'Paris',
             content: 'Capitale de la France, est une grande ville européenne et un centre mondial de l\'art, de la mode, de la gastronomie et de la culture.',
-            position: new LatLng(48.8566, 2.3522),
+            position: new Point(48.8566, 2.3522),
             opened: true,
             autoClose: false,
         );