ROU-12774: Fix TerraDraw dispose crash and TypeScript type errors (#260)

* Fixing the way dispose of the tool is made

* Remove extra space

* Suppress S7764 rule in sonar cloud

This rule is not relevant for our project, as this rule is intended to improve portability, consistency, and testing across different JavaScript environments (browsers, Web Workers, and Node.js).

* Use window for better type reference

* Fix type of return configs

* Fix type for compiler (OS.coordinates)

* Bump version of OutSystems Maps

* Remove unnecessary code

* Lint over the code

* Fixing the way removal of a tool is made

* Text typo

* Invoking stop only if the enabled

Author: rugoncalves

README.md

@@ -1,4 +1,4 @@
-# OutSystems Maps · v2.3.0
+# OutSystems Maps · v2.3.1
 
 ![GitHub License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg) ![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)
 

gulp/DefaultSpecs.js

@@ -19,7 +19,7 @@ const constants = {
 
 // Store the default project specifications
 const specs = {
-	version: '2.3.0',
+	version: '2.3.1',
 	name: 'OutSystems Maps',
 	description: '',
 	url: 'Website:\n • ' + constants.websiteUrl,

package.json

@@ -1,6 +1,6 @@
 {
   "name": "outsystems-maps",
-  "version": "2.3.0",
+  "version": "2.3.1",
   "description": "OutSystems Maps",
   "author": "UI Components Team",
   "license": "BSD-3-Clause",

sonar-project.properties

@@ -15,4 +15,11 @@ sonar.sources=src
 sonar.exclusions=**/node_modules/**,**/dist/**,**/*.min.js
 
 # JavaScript/TypeScript settings
-sonar.javascript.lcov.reportPaths=coverage/lcov.info
+sonar.javascript.lcov.reportPaths=coverage/lcov.info
+
+# Suppress S7764 (prefer globalThis over window) project-wide.
+# Runtime-injected browser globals are declared via `interface Window` augmentation
+# in Global.d.ts — `window.x` is the only access pattern TypeScript resolves correctly.
+sonar.issue.ignore.multicriteria=e1
+sonar.issue.ignore.multicriteria.e1.ruleKey=typescript:S7764
+sonar.issue.ignore.multicriteria.e1.resourceKey=**/*.ts

src/OSFramework/Maps/Constants.ts

@@ -1,7 +1,7 @@
 // eslint-disable-next-line @typescript-eslint/no-unused-vars
 namespace OSFramework.Maps.Constants {
 	/* OutSystems Maps Version */
-	export const OSMapsVersion = '2.3.0';
+	export const OSMapsVersion = '2.3.1';
 
 	/**
 	 * Maps Set OutSystems platform in use (O11/ODC).

src/Providers/DrawingTools/TerraDraw/Configuration/DrawConfig.ts

@@ -8,6 +8,6 @@ namespace Provider.DrawingTools.TerraDraw.Configuration {
 		public allowDrag: boolean;
 		public uniqueId: string;
 
-		public abstract getProviderConfig(): unknown[];
+		public abstract getProviderConfig(): unknown;
 	}
 }

src/Providers/DrawingTools/TerraDraw/Configuration/DrawFilledShapeConfig.ts

@@ -17,7 +17,7 @@ namespace Provider.DrawingTools.TerraDraw.Configuration {
 		 *   strokeWeight  → styles.outlineWidth
 		 *   strokeOpacity → styles.outlineOpacity
 		 */
-		public getProviderConfig(): unknown[] {
+		public getProviderConfig(): unknown {
 			return {
 				styles: {
 					fillColor: this.fillColor ?? '#aaaaaa',
@@ -26,7 +26,7 @@ namespace Provider.DrawingTools.TerraDraw.Configuration {
 					outlineWidth: this.strokeWeight ?? 2,
 					outlineOpacity: this.strokeOpacity ?? 1,
 				},
-			} as unknown as unknown[];
+			};
 		}
 	}
 }

src/Providers/DrawingTools/TerraDraw/Configuration/DrawMarkerConfig.ts

@@ -14,12 +14,12 @@ namespace Provider.DrawingTools.TerraDraw.Configuration {
 	export class DrawMarkerConfig extends DrawConfig {
 		public iconUrl: string;
 
-		public getProviderConfig(): unknown[] {
+		public getProviderConfig(): unknown {
 			return {
 				styles: {
 					markerUrl: this.iconUrl ?? '',
 				},
-			} as unknown as unknown[];
+			};
 		}
 	}
 }

src/Providers/DrawingTools/TerraDraw/Configuration/DrawPolylineConfig.ts

@@ -12,14 +12,14 @@ namespace Provider.DrawingTools.TerraDraw.Configuration {
 	 *   strokeOpacity → styles.lineStringOpacity
 	 */
 	export class DrawPolylineConfig extends DrawBasicShapeConfig {
-		public getProviderConfig(): unknown[] {
+		public getProviderConfig(): unknown {
 			return {
 				styles: {
 					lineStringColor: this.strokeColor ?? '#555555',
 					lineStringWidth: this.strokeWeight ?? 2,
 					lineStringOpacity: this.strokeOpacity ?? 1,
 				},
-			} as unknown as unknown[];
+			};
 		}
 	}
 }

src/Providers/DrawingTools/TerraDraw/DrawingTools.ts

@@ -35,7 +35,7 @@ namespace Provider.DrawingTools.TerraDraw {
 
 			// Always include a select mode so the user can deselect drawing without reloading
 			modes.push(
-				new globalThis.terraDraw.TerraDrawSelectMode({
+				new window.terraDraw.TerraDrawSelectMode({
 					flags: {
 						circle: { feature: { draggable: true } },
 						linestring: {
@@ -67,14 +67,14 @@ namespace Provider.DrawingTools.TerraDraw {
 		 * support hot-swapping modes, so the entire instance must be replaced.
 		 */
 		private _buildTerraDraw(): void {
-			if (this._provider) {
+			if (this._provider?.enabled) {
 				this._provider.stop();
 			}
 
-			this._provider = new globalThis.terraDraw.TerraDraw({
+			this._provider = new window.terraDraw.TerraDraw({
 				adapter: this._getAdapter(),
 				modes: this._buildModes(),
-			}) as TerraDrawProviderCompatible;
+			});
 
 			this._provider.on('finish', (id, context) => this._onFinish(id, context));
 
@@ -93,7 +93,7 @@ namespace Provider.DrawingTools.TerraDraw {
 
 		private _getAdapter(): TerraDrawGoogleMapsAdapter {
 			if (this.config.providerType === OSFramework.Maps.Enum.ProviderType.Google) {
-				return new globalThis.terraDrawGoogleMapsAdapter.TerraDrawGoogleMapsAdapter({
+				return new window.terraDrawGoogleMapsAdapter.TerraDrawGoogleMapsAdapter({
 					map: this.map.provider as google.maps.Map,
 					lib: google.maps,
 					coordinatePrecision: 9,
@@ -196,9 +196,9 @@ namespace Provider.DrawingTools.TerraDraw {
 		}
 
 		public changeProperty(propertyName: string, value: unknown): void {
-			const propValue = OSFramework.Maps.Enum.OS_Config_DrawingTools[propertyName];
 			super.changeProperty(propertyName, value);
 			if (this.isReady) {
+				const propValue = OSFramework.Maps.Enum.OS_Config_DrawingTools[propertyName];
 				if (propValue === OSFramework.Maps.Enum.OS_Config_DrawingTools.position) {
 					const modeNames = this.tools.map((t) => t.type);
 					this._ui?.refresh(modeNames, value as string);
@@ -208,10 +208,13 @@ namespace Provider.DrawingTools.TerraDraw {
 
 		public dispose(): void {
 			if (this.isReady) {
-				// Resets the mouse icon to its default state. 
-				// This prevents the tool's custom mouse icon from persisting after the provider is destroyed.
-				this._provider.setMode(Constants.ModeName.Select);
-				this._provider.stop();
+				// If the provider is not enabled, it means that it was never started.
+				if (this.provider.enabled) {
+					// Resets the mouse icon to its default state.
+					// This prevents the tool's custom mouse icon from persisting after the provider is destroyed.
+					this._provider.setMode(Constants.ModeName.Select);
+					this._provider.stop();
+				}
 				this._ui?.dispose();
 			}
 			this._provider = undefined;
@@ -235,10 +238,12 @@ namespace Provider.DrawingTools.TerraDraw {
 			tool && this._modeToTool.delete(tool.type);
 
 			if (this.isReady) {
-				// Resets the mouse icon to its default state. 
-				// This prevents the tool's custom mouse icon from persisting after the provider is destroyed.
-				this._provider.setMode(Constants.ModeName.Select);
-
+				// If the provider is not enabled, it means that it was never started.
+				if (this.provider.enabled) {
+					// Resets the mouse icon to its default state.
+					// This prevents the tool's custom mouse icon from persisting after the provider is destroyed.
+					this._provider.setMode(Constants.ModeName.Select);
+				}
 				this._buildTerraDraw();
 
 				this._provider.start();