Merge pull request #172 from OutSystems/ROU-4763

ROU-4763: Add ability to to GoogleMaps to add localization by setting the language and region
OutSystems · Apr 3, 2024 · 1d4f0eb · 1d4f0eb
2 parents 327f50a + e2835cc
commit 1d4f0eb
Show file tree

Hide file tree

Showing 13 changed files with 46 additions and 5 deletions.
diff --git a/src/OSFramework/Maps/Configuration/IConfigurationSearchPlaces.ts b/src/OSFramework/Maps/Configuration/IConfigurationSearchPlaces.ts
@@ -7,6 +7,7 @@ namespace OSFramework.Maps.Configuration {
 	export interface IConfigurationSearchPlaces extends IConfiguration {
 		apiKey: string;
 		countries: Array<string>;
+		localization: OSFramework.Maps.OSStructures.OSMap.Localization;
 		searchArea: OSStructures.OSMap.BoundsString;
 		searchType: Enum.SearchTypes;
 	}

diff --git a/src/OSFramework/Maps/Enum/ErrorCodes.ts b/src/OSFramework/Maps/Enum/ErrorCodes.ts
@@ -17,8 +17,10 @@ namespace OSFramework.Maps.Enum {
 	export enum ErrorCodes {
 		// Error Codes - CONFiguration errors - Any error related with missing or wrong configuration of the application.
 		CFG_APIKeyAlreadySetMap = 'MAPS-CFG-01001',
+		CFG_LocalizationAlreadySetMap = 'MAPS-CFG-01003',
 		CFG_APIKeyAlreadySetStaticMap = 'MAPS-CFG-02001',
 		CFG_CantChangeParamsStaticMap = 'MAPS-CFG-02002',
+		CFG_LocalizationAlreadySetStaticMap = 'MAPS-CFG-02003',
 		CFG_InvalidPolylineShapeLocations = 'MAPS-CFG-05001',
 		CFG_InvalidPolygonShapeLocations = 'MAPS-CFG-05002',
 		CFG_InvalidCircleShapeCenter = 'MAPS-CFG-05003',

diff --git a/src/OSFramework/Maps/Enum/OS_Config_Map.ts b/src/OSFramework/Maps/Enum/OS_Config_Map.ts
@@ -8,6 +8,7 @@ namespace OSFramework.Maps.Enum {
 		apiKey,
 		height,
 		center,
+		localization,
 		markerClustererActive,
 		markerClustererMaxZoom,
 		markerClustererMinClusterSize,

diff --git a/src/OSFramework/Maps/Enum/OS_Config_SearchPlaces.ts b/src/OSFramework/Maps/Enum/OS_Config_SearchPlaces.ts
@@ -5,6 +5,7 @@ namespace OSFramework.Maps.Enum {
 	 */
 	export enum OS_Config_SearchPlaces {
 		apiKey,
+		localization,
 		countries,
 		searchArea,
 		searchType,

diff --git a/src/OSFramework/Maps/Enum/OS_Config_StaticMap.ts b/src/OSFramework/Maps/Enum/OS_Config_StaticMap.ts
@@ -5,6 +5,7 @@ namespace OSFramework.Maps.Enum {
 	 */
 	export enum OS_Config_StaticMap {
 		apiKey,
+		localization,
 		height,
 		center,
 		type,

diff --git a/src/OSFramework/Maps/OSStructures/OSMap.Offset.ts b/src/OSFramework/Maps/OSStructures/OSMap.Offset.ts
@@ -4,4 +4,8 @@ namespace OSFramework.Maps.OSStructures.OSMap {
 		public offsetX: number;
 		public offsetY: number;
 	}
+	export class Localization {
+		public language: string;
+		public region: string;
+	}
 }
diff --git a/src/Providers/Maps/Google/Configuration/OSMap/GoogleMapConfig.ts b/src/Providers/Maps/Google/Configuration/OSMap/GoogleMapConfig.ts
@@ -9,6 +9,7 @@ namespace Provider.Maps.Google.Configuration.OSMap {
 		public autoZoomOnShapes: boolean;
 		public center: string | OSFramework.Maps.OSStructures.OSMap.Coordinates;
 		public height: string;
+		public localization: OSFramework.Maps.OSStructures.OSMap.Localization;
 		public markerClusterer: OSFramework.Maps.Configuration.IConfigurationMarkerClusterer;
 		public offset: OSFramework.Maps.OSStructures.OSMap.Offset;
 		public respectUserZoom: boolean;

diff --git a/src/Providers/Maps/Google/Configuration/OSMap/GoogleStaticMapConfig.ts b/src/Providers/Maps/Google/Configuration/OSMap/GoogleStaticMapConfig.ts
@@ -7,6 +7,7 @@ namespace Provider.Maps.Google.Configuration.OSMap {
 		public apiKey: string;
 		public center: string | OSFramework.Maps.OSStructures.OSMap.Coordinates;
 		public height: string;
+		public localization: OSFramework.Maps.OSStructures.OSMap.Localization;
 		public type: OSFramework.Maps.Enum.OSMap.Type;
 		public uniqueId: string;
 		public zoom: OSFramework.Maps.Enum.OSMap.Zoom;

diff --git a/src/Providers/Maps/Google/Configuration/SearchPlaces/SearchPlacesConfig.ts b/src/Providers/Maps/Google/Configuration/SearchPlaces/SearchPlacesConfig.ts
@@ -8,6 +8,7 @@ namespace Provider.Maps.Google.Configuration.SearchPlaces {
 	{
 		public apiKey: string;
 		public countries: Array<string>;
+		public localization: OSFramework.Maps.OSStructures.OSMap.Localization;
 		public searchArea: OSFramework.Maps.OSStructures.OSMap.BoundsString;
 		public searchType: OSFramework.Maps.Enum.SearchTypes;
 

diff --git a/src/Providers/Maps/Google/OSMap/OSMap.ts b/src/Providers/Maps/Google/OSMap/OSMap.ts
@@ -273,7 +273,7 @@ namespace Provider.Maps.Google.OSMap {
 			 * 1) Add the script from GoogleAPIS to the header of the page
 			 * 2) Creates the Map via GoogleMap API
 			 */
-			SharedComponents.InitializeScripts(this.config.apiKey, this._scriptCallback);
+			SharedComponents.InitializeScripts(this.config.apiKey, this.config.localization, this._scriptCallback);
 		}
 
 		public buildFeatures(): void {
@@ -326,7 +326,9 @@ namespace Provider.Maps.Google.OSMap {
 
 		public changeProperty(propertyName: string, propertyValue: unknown): void {
 			const propValue = OSFramework.Maps.Enum.OS_Config_Map[propertyName];
+
 			super.changeProperty(propertyName, propertyValue);
+
 			if (this.isReady) {
 				switch (propValue) {
 					case OSFramework.Maps.Enum.OS_Config_Map.apiKey:
@@ -342,6 +344,14 @@ namespace Provider.Maps.Google.OSMap {
 						return this.features.center.updateCenter(propertyValue as string);
 					case OSFramework.Maps.Enum.OS_Config_Map.offset:
 						return this.features.offset.setOffset(JSON.parse(propertyValue as string));
+					case OSFramework.Maps.Enum.OS_Config_Map.localization:
+						// Trigger an error to alert the user that the localization can only be set one time
+						this.mapEvents.trigger(
+							OSFramework.Maps.Event.OSMap.MapEventType.OnError,
+							this,
+							OSFramework.Maps.Enum.ErrorCodes.CFG_LocalizationAlreadySetMap
+						);
+						return;
 					case OSFramework.Maps.Enum.OS_Config_Map.zoom:
 						return this.features.zoom.setLevel(propertyValue as OSFramework.Maps.Enum.OSMap.Zoom);
 					case OSFramework.Maps.Enum.OS_Config_Map.type:

diff --git a/src/Providers/Maps/Google/OSMap/StaticMap.ts b/src/Providers/Maps/Google/OSMap/StaticMap.ts
@@ -102,7 +102,9 @@ namespace Provider.Maps.Google.OSMap {
 				'&size=' +
 				this._size.width +
 				'x' +
-				this._size.height;
+				this._size.height +
+				(this.config.localization.language !== '' ? `&language=${this.config.localization.language}` : '') +
+				(this.config.localization.region !== '' ? `&region=${this.config.localization.region}` : '');
 			image.onerror = () => {
 				// Check if needed
 				this.mapEvents.trigger(

diff --git a/src/Providers/Maps/Google/SearchPlaces/SearchPlaces.ts b/src/Providers/Maps/Google/SearchPlaces/SearchPlaces.ts
@@ -196,7 +196,7 @@ namespace Provider.Maps.Google.SearchPlaces {
 			 * 1) Add the script from GoogleAPIS to the header of the page
 			 * 2) Creates the SearchPlaces via GoogleMap API
 			 */
-			SharedComponents.InitializeScripts(this.config.apiKey, this._scriptCallback);
+			SharedComponents.InitializeScripts(this.config.apiKey, this.config.localization, this._scriptCallback);
 		}
 
 		public changeProperty(propertyName: string, propertyValue: unknown): void {
@@ -212,6 +212,14 @@ namespace Provider.Maps.Google.SearchPlaces {
 							);
 						}
 						return;
+					case OSFramework.Maps.Enum.OS_Config_SearchPlaces.localization:
+						// Trigger an error to alert the user that the localization can only be set one time
+						this.searchPlacesEvents.trigger(
+							OSFramework.Maps.Event.SearchPlaces.SearchPlacesEventType.OnError,
+							this,
+							OSFramework.Maps.Enum.ErrorCodes.CFG_LocalizationAlreadySetMap
+						);
+						return;
 					case OSFramework.Maps.Enum.OS_Config_SearchPlaces.searchArea:
 						// eslint-disable-next-line no-case-declarations
 						const searchArea = this._buildSearchArea(propertyValue as string);

diff --git a/src/Providers/Maps/Google/SharedComponents/MapsAndSearchPlaces.ts b/src/Providers/Maps/Google/SharedComponents/MapsAndSearchPlaces.ts
@@ -5,7 +5,11 @@
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 namespace Provider.Maps.Google.SharedComponents {
 	let googleMapsLoadPromise = undefined;
-	export function InitializeScripts(apiKey: string, cb: () => void): void {
+	export function InitializeScripts(
+		apiKey: string,
+		localization: OSFramework.Maps.OSStructures.OSMap.Localization,
+		cb: () => void
+	): void {
 		if (typeof google === 'object' && typeof google.maps === 'object') {
 			cb();
 		} else {
@@ -23,14 +27,18 @@ namespace Provider.Maps.Google.SharedComponents {
 						resolve(0);
 						googleMapsLoadPromise = undefined;
 					};
+
 					const script = document.createElement('script');
+
 					script.src =
 						`${OSFramework.Maps.Helper.Constants.googleMapsApiMap}?` +
 						`key=${apiKey}` +
 						`&libraries=${OSFramework.Maps.Helper.Constants.gmlibraries}` +
 						`&v=${OSFramework.Maps.Helper.Constants.gmversion}` +
 						`&loading=async` +
-						`&callback=GMCB`;
+						`&callback=GMCB` +
+						(localization.language !== '' ? `&language=${localization.language}` : '') +
+						(localization.region !== '' ? `&region=${localization.region}` : '');
 					script.async = true;
 					script.defer = true;
 					script.id = OSFramework.Maps.Helper.Constants.googleMapsScript;
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,6 +5,7 @@ namespace OSFramework.Maps.Enum { @@
     	 */
     	export enum OS_Config_StaticMap {
     		apiKey,
+    		localization,
     		height,
     		center,
     		type,
@@ Expand Down @@