Merge pull request #4 from ionic-team/development

chore: prepare to release version `1.0.0`

Author: alexgerardojacinto

CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.0.0]
+
+### 2025-01-10
+- Feat: Add implementation for `getCurrentPosition`, `watchPosition`, and `clearWatch` on both Android and iOS.

README.md

@@ -24,6 +24,6 @@
 
 This project has two packages:
 
-1. the cordova plugin, `com.outsystems.plugins.osgeolocation`
+1. the cordova plugin, `com.outsystems.plugins.geolocation`
 2. a wrapper consumed by the OutSystems' low-code module, `outsystems-wrapper`
 

packages/cordova-plugin/android/OSGeolocation.kt

@@ -1,4 +1,4 @@
-package com.outsystems.plugins.osgeolocation
+package com.outsystems.plugins.geolocation
 
 import com.google.android.gms.location.LocationServices
 import com.google.gson.Gson
@@ -16,9 +16,9 @@ import org.json.JSONObject
 import android.Manifest
 import android.content.pm.PackageManager
 import androidx.activity.result.contract.ActivityResultContracts
-import com.outsystems.plugins.osgeolocation.controller.OSGLOCController
-import com.outsystems.plugins.osgeolocation.model.OSGLOCException
-import com.outsystems.plugins.osgeolocation.model.OSGLOCLocationOptions
+import io.ionic.libs.iongeolocationlib.controller.IONGLOCController
+import io.ionic.libs.iongeolocationlib.model.IONGLOCException
+import io.ionic.libs.iongeolocationlib.model.IONGLOCLocationOptions
 import kotlinx.coroutines.cancel
 import kotlinx.coroutines.flow.MutableSharedFlow
 
@@ -27,7 +27,7 @@ import kotlinx.coroutines.flow.MutableSharedFlow
  */
 class OSGeolocation : CordovaPlugin() {
 
-    private lateinit var controller: OSGLOCController
+    private lateinit var controller: IONGLOCController
     private val gson by lazy { Gson() }
 
     // for permissions
@@ -54,7 +54,7 @@ class OSGeolocation : CordovaPlugin() {
             }
         }
 
-        this.controller = OSGLOCController(
+        this.controller = IONGLOCController(
             LocationServices.getFusedLocationProviderClient(cordova.context),
             activityLauncher
         )
@@ -100,7 +100,7 @@ class OSGeolocation : CordovaPlugin() {
 
         coroutineScope.launch {
             handleLocationPermission(callbackContext) {
-                val locationOptions = OSGLOCLocationOptions(
+                val locationOptions = IONGLOCLocationOptions(
                     options.getLong(TIMEOUT),
                     options.getLong(MAXIMUM_AGE),
                     options.getBoolean(ENABLE_HIGH_ACCURACY))
@@ -133,7 +133,7 @@ class OSGeolocation : CordovaPlugin() {
 
         coroutineScope.launch {
             handleLocationPermission(callbackContext) {
-                val locationOptions = OSGLOCLocationOptions(
+                val locationOptions = IONGLOCLocationOptions(
                     timeout = options.getLong(TIMEOUT),
                     maximumAge = options.getLong(MAXIMUM_AGE),
                     enableHighAccuracy = options.getBoolean(ENABLE_HIGH_ACCURACY),
@@ -167,32 +167,32 @@ class OSGeolocation : CordovaPlugin() {
         callbackContext: CallbackContext
     ) {
         when (exception) {
-            is OSGLOCException.OSGLOCRequestDeniedException -> {
+            is IONGLOCException.IONGLOCRequestDeniedException -> {
                 callbackContext.sendError(OSGeolocationErrors.LOCATION_ENABLE_REQUEST_DENIED)
             }
 
-            is OSGLOCException.OSGLOCSettingsException -> {
+            is IONGLOCException.IONGLOCSettingsException -> {
                 callbackContext.sendError(OSGeolocationErrors.LOCATION_SETTINGS_ERROR)
             }
 
-            is OSGLOCException.OSGLOCInvalidTimeoutException -> {
+            is IONGLOCException.IONGLOCInvalidTimeoutException -> {
                 callbackContext.sendError(OSGeolocationErrors.INVALID_TIMEOUT)
             }
 
-            is OSGLOCException.OSGLOCGoogleServicesException -> {
+            is IONGLOCException.IONGLOCGoogleServicesException -> {
                 if (exception.resolvable) {
                     callbackContext.sendError(OSGeolocationErrors.GOOGLE_SERVICES_RESOLVABLE)
                 } else {
                     callbackContext.sendError(OSGeolocationErrors.GOOGLE_SERVICES_ERROR)
                 }
             }
 
-            is OSGLOCException.OSGLOCLocationRetrievalTimeoutException -> {
+            is IONGLOCException.IONGLOCLocationRetrievalTimeoutException -> {
                 callbackContext.sendError(OSGeolocationErrors.GET_LOCATION_TIMEOUT)
             }
 
             else -> {
-                callbackContext.sendError(OSGeolocationErrors.GET_LOCATION_GENERAL)
+                callbackContext.sendError(OSGeolocationErrors.POSITION_UNAVAILABLE)
             }
         }
     }

packages/cordova-plugin/android/OSGeolocationErrors.kt

@@ -1,4 +1,4 @@
-package com.outsystems.plugins.osgeolocation
+package com.outsystems.plugins.geolocation
 
 /**
  * Object with plugin errors
@@ -14,54 +14,39 @@ object OSGeolocationErrors {
         val message: String
     )
 
-    val GOOGLE_SERVICES_RESOLVABLE = ErrorInfo(
-        code = formatErrorCode(1),
-        message = "Google Play Services error user resolvable."
-    )
-
-    val GOOGLE_SERVICES_ERROR = ErrorInfo(
+    val POSITION_UNAVAILABLE = ErrorInfo(
         code = formatErrorCode(2),
-        message = "Google Play Services error."
+        message = "There was en error trying to obtain the location."
     )
 
-    val INVALID_INPUT_GET_POSITION = ErrorInfo(
+    val LOCATION_PERMISSIONS_DENIED = ErrorInfo(
         code = formatErrorCode(3),
-        message = "The input parameters for GetLocation aren't valid."
+        message = "Location permission request was denied."
     )
 
-    val INVALID_INPUT_WATCH_POSITION = ErrorInfo(
+    val INVALID_INPUT_GET_POSITION = ErrorInfo(
         code = formatErrorCode(4),
-        message = "The input parameters for WatchPosition aren't valid."
+        message = "The 'GetLocation' input parameters aren't valid."
     )
 
-    val INVALID_INPUT_CLEAR_WATCH = ErrorInfo(
+    val INVALID_INPUT_WATCH_POSITION = ErrorInfo(
         code = formatErrorCode(5),
-        message = "The input parameters for ClearWatch aren't valid."
+        message = "The 'WatchPosition' input parameters aren't valid."
     )
 
-    val GET_LOCATION_TIMEOUT = ErrorInfo(
+    val INVALID_INPUT_CLEAR_WATCH = ErrorInfo(
         code = formatErrorCode(6),
-        message = "Could not obtain location in time. Try with a higher timeout."
-    )
-
-    val GET_LOCATION_GENERAL = ErrorInfo(
-        code = formatErrorCode(7),
-        message = "There was en error trying to obtain the location."
+        message = "The 'ClearWatch' input parameters aren't valid."
     )
-
-    val LOCATION_PERMISSIONS_DENIED = ErrorInfo(
-        code = formatErrorCode(8),
-        message = "Location permission request was denied."
-    )
-
+    
     val LOCATION_ENABLE_REQUEST_DENIED = ErrorInfo(
         code = formatErrorCode(9),
-        message = "Request to enable location denied."
+        message = "Request to enable location was denied."
     )
 
-    val LOCATION_SETTINGS_ERROR = ErrorInfo(
+    val GET_LOCATION_TIMEOUT = ErrorInfo(
         code = formatErrorCode(10),
-        message = "Location settings error."
+        message = "Could not obtain location in time. Try with a higher timeout."
     )
 
     val INVALID_TIMEOUT = ErrorInfo(
@@ -71,12 +56,26 @@ object OSGeolocationErrors {
 
     val WATCH_ID_NOT_FOUND = ErrorInfo(
         code = formatErrorCode(12),
-        message = "WatchId not found"
+        message = "WatchId not found."
     )
 
     val WATCH_ID_NOT_PROVIDED = ErrorInfo(
         code = formatErrorCode(13),
         message = "WatchId needs to be provided."
     )
 
+    val GOOGLE_SERVICES_RESOLVABLE = ErrorInfo(
+        code = formatErrorCode(14),
+        message = "Google Play Services error user resolvable."
+    )
+
+    val GOOGLE_SERVICES_ERROR = ErrorInfo(
+        code = formatErrorCode(15),
+        message = "Google Play Services error."
+    )
+
+    val LOCATION_SETTINGS_ERROR = ErrorInfo(
+        code = formatErrorCode(16),
+        message = "Location settings error."
+    )
 }

packages/cordova-plugin/android/OSGeolocationPermissionEvents.kt

@@ -1,4 +1,4 @@
-package com.outsystems.plugins.osgeolocation
+package com.outsystems.plugins.geolocation
 
 /**
  * Sealed class containing the Location permission events

packages/cordova-plugin/android/android-lib-debug.aar

@@ -17,10 +17,7 @@ allprojects {
 }
 
 dependencies{
-
-    //implementation "com.github.outsystems:osgeolocationlib-android:1.0.0@aar"
-    implementation (files("libs/android-lib-debug.aar"))
-
+    implementation("io.ionic.libs:iongeolocation-android:1.0.0")
     implementation("androidx.browser:browser:1.8.0")
     implementation("com.google.android.gms:play-services-auth:21.2.0")
     implementation("com.google.android.gms:play-services-location:21.3.0")

packages/cordova-plugin/android/build.gradle

@@ -1,7 +1,7 @@
-import OSGeolocationLib
+import IONGeolocationLib
 
-extension OSGLOCConfigurationModel {
-    static func createWithAccuracy(_ isHighAccuracyEnabled: Bool) -> OSGLOCConfigurationModel {
+extension IONGLOCConfigurationModel {
+    static func createWithAccuracy(_ isHighAccuracyEnabled: Bool) -> IONGLOCConfigurationModel {
         let minimumDistance = isHighAccuracyEnabled ?
             Constants.MinimumDistance.highAccuracy :
             Constants.MinimumDistance.lowAccuracy

packages/cordova-plugin/ios/OSGLOCConfigurationModel+Accuracy.swift renamed to packages/cordova-plugin/ios/IONGLOCConfigurationModel+Accuracy.swift

@@ -1,6 +1,6 @@
-import OSGeolocationLib
+import IONGeolocationLib
 
-extension OSGLOCPositionModel {
+extension IONGLOCPositionModel {
     func toResultDictionary() -> [String: Double] {
         [
             Constants.Position.altitude: altitude,

packages/cordova-plugin/ios/OSGLOCPositionModel+JSONTransformer.swift renamed to packages/cordova-plugin/ios/IONGLOCPositionModel+JSONTransformer.swift

@@ -1,4 +1,4 @@
-import OSGeolocationLib
+import IONGeolocationLib
 
 private enum OSGeolocationCallbackType {
     case location
@@ -56,7 +56,7 @@ final class OSGeolocationCallbackManager {
         commandDelegate.send(result, callbackId: callbackId)
     }
 
-    func sendSuccess(with position: OSGLOCPositionModel) {
+    func sendSuccess(with position: IONGLOCPositionModel) {
         createPluginResult(status: .ok, message: position.toResultDictionary())
     }