@inoxialabs/react-native-nitro-location-geocoder 1.0.0 → 1.0.1

package/README.md

@@ -5,10 +5,10 @@
 ## Features
 
 - Reverse geocoding on iOS and Android.
-- Locale-aware lookups using language tags such as `en`, `es`, or `es-PE`.
-- Small, typed API with a normalized result shape.
-- No backend dependency and no device location permission requirement.
-- Stable generic errors for unavailable geocoders, empty results, invalid coordinates, timeouts, and native geocoder failures.
+- Locale-aware lookups using language tags. For example: `en`, `es`, or `es-PE`.
+- Small, typed API with a normalized result shape.
+- No backend dependency and no device location permission requirement.
+- Stable generic errors for unavailable geocoders, empty results, invalid coordinates, timeouts, and native geocoder failures.
 
 ## Supported platforms
 
@@ -29,7 +29,7 @@ Peer dependencies:
 
 - `react`
 - `react-native`
-- `react-native-nitro-modules` `^0.35.0`
+- `react-native-nitro-modules` `^0.35.0 || ^0.36.0`
 
 On iOS, install pods after adding the package:
 
@@ -64,12 +64,12 @@ Returns `Promise<LocationGeocoderResult>`.
 
 Parameters:
 
-- `latitude`: required `number`
-- `longitude`: required `number`
-- `locale`: required `string`
-
-`locale` accepts a language tag such as `en`, `es`, or `es-PE`. Passing `''` uses the platform default locale, but the argument itself is still required.
-Latitude must be finite and between `-90` and `90`. Longitude must be finite and between `-180` and `180`.
+- `latitude`: required `number`
+- `longitude`: required `number`
+- `locale`: required `string`
+
+`locale` accepts a language tag such as `en`, `es`, or `es-PE`. Passing `''` uses the platform default locale, but the argument itself is still required.
+Latitude must be finite and between `-90` and `90`. Longitude must be finite and between `-180` and `180`.
 
 ### `LocationGeocoderResult`
 
@@ -88,15 +88,15 @@ All fields are always present. When the platform geocoder cannot provide a field
 
 ## Platform behavior
 
-- iOS uses `CLGeocoder`.
-- Android uses `android.location.Geocoder`.
-- Calls are independent. Starting one reverse-geocode request does not cancel another request.
-- Requests time out after 10 seconds with `GEOCODER_TIMEOUT`.
-- The module rejects with `INVALID_COORDINATES` when latitude or longitude is outside the valid coordinate range.
-- The module rejects with `NO_RESULTS` when no address is found.
-- Android rejects with `UNAVAILABLE` when the platform geocoder is not available.
-- iOS wraps native geocoder failures as `GEOCODER_FAILED: <platform message>`.
-- Android wraps native geocoder failures as `GEOCODER_FAILED` or `GEOCODER_FAILED: <platform message>`.
+- iOS uses `CLGeocoder`.
+- Android uses `android.location.Geocoder`.
+- Calls are independent. Starting one reverse-geocode request does not cancel another request.
+- Requests time out after 10 seconds with `GEOCODER_TIMEOUT`.
+- The module rejects with `INVALID_COORDINATES` when latitude or longitude is outside the valid coordinate range.
+- The module rejects with `NO_RESULTS` when no address is found.
+- Android rejects with `UNAVAILABLE` when the platform geocoder is not available.
+- iOS wraps native geocoder failures as `GEOCODER_FAILED: <platform message>`.
+- Android wraps native geocoder failures as `GEOCODER_FAILED` or `GEOCODER_FAILED: <platform message>`.
 
 ## Notes
 

package/android/src/main/java/com/margelo/nitro/locationgeocoder/HybridLocationGeocoder.kt

@@ -1,18 +1,18 @@
 package com.margelo.nitro.locationgeocoder
 
-import android.location.Address
-import android.location.Geocoder
-import android.os.Build
-import androidx.annotation.RequiresApi
-import com.facebook.proguard.annotations.DoNotStrip
-import com.margelo.nitro.NitroModules
-import com.margelo.nitro.core.Promise
-import java.io.IOException
-import java.util.Locale
-import java.util.concurrent.CountDownLatch
-import java.util.concurrent.TimeUnit
-import java.util.concurrent.atomic.AtomicReference
-
+import android.location.Address
+import android.location.Geocoder
+import android.os.Build
+import androidx.annotation.RequiresApi
+import com.facebook.proguard.annotations.DoNotStrip
+import com.margelo.nitro.NitroModules
+import com.margelo.nitro.core.Promise
+import java.io.IOException
+import java.util.Locale
+import java.util.concurrent.CountDownLatch
+import java.util.concurrent.TimeUnit
+import java.util.concurrent.atomic.AtomicReference
+
 @DoNotStrip
 class HybridLocationGeocoder : HybridLocationGeocoderSpec() {
 
@@ -26,55 +26,55 @@ class HybridLocationGeocoder : HybridLocationGeocoderSpec() {
         return Locale.forLanguageTag(normalized)
     }
 
-    private fun createGeocoder(locale: String): Geocoder {
-        return Geocoder(context, getLocale(locale))
-    }
-
-    private fun isValidCoordinate(latitude: Double, longitude: Double): Boolean {
-        return latitude.isFinite() &&
-            longitude.isFinite() &&
-            latitude >= -90.0 &&
-            latitude <= 90.0 &&
-            longitude >= -180.0 &&
-            longitude <= 180.0
-    }
-
-    private fun geocoderFailed(message: String?): Exception {
-        val normalized = message?.trim()?.takeIf { it.isNotEmpty() }
-        return Exception(if (normalized == null) "GEOCODER_FAILED" else "GEOCODER_FAILED: $normalized")
-    }
-
-    override fun reverseGeocode(
-        latitude: Double,
-        longitude: Double,
-        locale: String
-    ): Promise<LocationGeocoderResult> {
-        return Promise.async {
-            if (!isValidCoordinate(latitude, longitude)) {
-                throw Exception("INVALID_COORDINATES")
-            }
-
-            if (!Geocoder.isPresent()) {
-                throw Exception("UNAVAILABLE")
-            }
-
-            val address = try {
-                if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
-                    reverseGeocodeApi33(latitude, longitude, locale)
-                } else {
-                    reverseGeocodeLegacy(latitude, longitude, locale)
-                }
-            } catch (error: IllegalArgumentException) {
-                throw Exception("INVALID_COORDINATES")
-            } catch (error: IOException) {
-                throw geocoderFailed(error.message)
-            } catch (error: InterruptedException) {
-                Thread.currentThread().interrupt()
-                throw geocoderFailed(error.message)
-            } ?: throw Exception("NO_RESULTS")
-
-            mapAddress(address)
-        }
+    private fun createGeocoder(locale: String): Geocoder {
+        return Geocoder(context, getLocale(locale))
+    }
+
+    private fun isValidCoordinate(latitude: Double, longitude: Double): Boolean {
+        return latitude.isFinite() &&
+            longitude.isFinite() &&
+            latitude >= -90.0 &&
+            latitude <= 90.0 &&
+            longitude >= -180.0 &&
+            longitude <= 180.0
+    }
+
+    private fun geocoderFailed(message: String?): Exception {
+        val normalized = message?.trim()?.takeIf { it.isNotEmpty() }
+        return Exception(if (normalized == null) "GEOCODER_FAILED" else "GEOCODER_FAILED: $normalized")
+    }
+
+    override fun reverseGeocode(
+        latitude: Double,
+        longitude: Double,
+        locale: String
+    ): Promise<LocationGeocoderResult> {
+        return Promise.async {
+            if (!isValidCoordinate(latitude, longitude)) {
+                throw Exception("INVALID_COORDINATES")
+            }
+
+            if (!Geocoder.isPresent()) {
+                throw Exception("UNAVAILABLE")
+            }
+
+            val address = try {
+                if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
+                    reverseGeocodeApi33(latitude, longitude, locale)
+                } else {
+                    reverseGeocodeLegacy(latitude, longitude, locale)
+                }
+            } catch (error: IllegalArgumentException) {
+                throw Exception("INVALID_COORDINATES")
+            } catch (error: IOException) {
+                throw geocoderFailed(error.message)
+            } catch (error: InterruptedException) {
+                Thread.currentThread().interrupt()
+                throw geocoderFailed(error.message)
+            } ?: throw Exception("NO_RESULTS")
+
+            mapAddress(address)
+        }
     }
 
     @RequiresApi(Build.VERSION_CODES.TIRAMISU)
@@ -88,15 +88,15 @@ class HybridLocationGeocoder : HybridLocationGeocoderSpec() {
             override fun onGeocode(addresses: MutableList<Address>) {
                 resultRef.set(addresses.firstOrNull())
                 latch.countDown()
-            }
-
-            override fun onError(errorMessage: String?) {
-                errorRef.set(geocoderFailed(errorMessage))
-                latch.countDown()
-            }
-        })
-
-        val completed = latch.await(10, TimeUnit.SECONDS)
+            }
+
+            override fun onError(errorMessage: String?) {
+                errorRef.set(geocoderFailed(errorMessage))
+                latch.countDown()
+            }
+        })
+
+        val completed = latch.await(10, TimeUnit.SECONDS)
         if (!completed) {
             throw Exception("GEOCODER_TIMEOUT")
         }

package/ios/HybridLocationGeocoder.swift

@@ -2,91 +2,91 @@ import Foundation
 import CoreLocation
 import NitroModules
 
-class HybridLocationGeocoder: HybridLocationGeocoderSpec {
-
-    private let timeoutSeconds: TimeInterval = 10
-
-    private func preferredLocale(_ locale: String) -> Locale? {
-        let normalized = locale.trimmingCharacters(in: .whitespacesAndNewlines)
+class HybridLocationGeocoder: HybridLocationGeocoderSpec {
+
+    private let timeoutSeconds: TimeInterval = 10
+
+    private func preferredLocale(_ locale: String) -> Locale? {
+        let normalized = locale.trimmingCharacters(in: .whitespacesAndNewlines)
         if normalized.isEmpty {
             return nil
         }
-        return Locale(identifier: normalized)
-    }
-
-    private func isValidCoordinate(latitude: Double, longitude: Double) -> Bool {
-        latitude.isFinite &&
-            longitude.isFinite &&
-            latitude >= -90 &&
-            latitude <= 90 &&
-            longitude >= -180 &&
-            longitude <= 180
-    }
-
-    func reverseGeocode(latitude: Double, longitude: Double, locale: String) throws -> Promise<LocationGeocoderResult> {
-        let promise = Promise<LocationGeocoderResult>()
-
-        guard isValidCoordinate(latitude: latitude, longitude: longitude) else {
-            promise.reject(withError: RuntimeError.error(withMessage: "INVALID_COORDINATES"))
-            return promise
-        }
-
-        let geocoder = CLGeocoder()
-        var didComplete = false
-        var timeoutWorkItem: DispatchWorkItem?
-
-        func reject(_ message: String) {
-            if didComplete {
-                return
-            }
-            didComplete = true
-            timeoutWorkItem?.cancel()
-            promise.reject(withError: RuntimeError.error(withMessage: message))
-        }
-
-        func resolve(_ result: LocationGeocoderResult) {
-            if didComplete {
-                return
-            }
-            didComplete = true
-            timeoutWorkItem?.cancel()
-            promise.resolve(withResult: result)
-        }
-
-        timeoutWorkItem = DispatchWorkItem {
-            reject("GEOCODER_TIMEOUT")
-            geocoder.cancelGeocode()
-        }
-        if let timeoutWorkItem = timeoutWorkItem {
-            DispatchQueue.main.asyncAfter(
-                deadline: .now() + .milliseconds(Int(timeoutSeconds * 1000)),
-                execute: timeoutWorkItem
-            )
-        }
-
-        let location = CLLocation(latitude: latitude, longitude: longitude)
-        geocoder.reverseGeocodeLocation(location, preferredLocale: preferredLocale(locale)) { placemarks, error in
-            if let error = error {
-                reject("GEOCODER_FAILED: \(error.localizedDescription)")
-                return
-            }
-
-            guard let placemark = placemarks?.first else {
-                reject("NO_RESULTS")
-                return
-            }
-
+        return Locale(identifier: normalized)
+    }
+
+    private func isValidCoordinate(latitude: Double, longitude: Double) -> Bool {
+        latitude.isFinite &&
+            longitude.isFinite &&
+            latitude >= -90 &&
+            latitude <= 90 &&
+            longitude >= -180 &&
+            longitude <= 180
+    }
+
+    func reverseGeocode(latitude: Double, longitude: Double, locale: String) throws -> Promise<LocationGeocoderResult> {
+        let promise = Promise<LocationGeocoderResult>()
+
+        guard isValidCoordinate(latitude: latitude, longitude: longitude) else {
+            promise.reject(withError: RuntimeError.error(withMessage: "INVALID_COORDINATES"))
+            return promise
+        }
+
+        let geocoder = CLGeocoder()
+        var didComplete = false
+        var timeoutWorkItem: DispatchWorkItem?
+
+        func reject(_ message: String) {
+            if didComplete {
+                return
+            }
+            didComplete = true
+            timeoutWorkItem?.cancel()
+            promise.reject(withError: RuntimeError.error(withMessage: message))
+        }
+
+        func resolve(_ result: LocationGeocoderResult) {
+            if didComplete {
+                return
+            }
+            didComplete = true
+            timeoutWorkItem?.cancel()
+            promise.resolve(withResult: result)
+        }
+
+        timeoutWorkItem = DispatchWorkItem {
+            reject("GEOCODER_TIMEOUT")
+            geocoder.cancelGeocode()
+        }
+        if let timeoutWorkItem = timeoutWorkItem {
+            DispatchQueue.main.asyncAfter(
+                deadline: .now() + .milliseconds(Int(timeoutSeconds * 1000)),
+                execute: timeoutWorkItem
+            )
+        }
+
+        let location = CLLocation(latitude: latitude, longitude: longitude)
+        geocoder.reverseGeocodeLocation(location, preferredLocale: preferredLocale(locale)) { placemarks, error in
+            if let error = error {
+                reject("GEOCODER_FAILED: \(error.localizedDescription)")
+                return
+            }
+
+            guard let placemark = placemarks?.first else {
+                reject("NO_RESULTS")
+                return
+            }
+
             let result = LocationGeocoderResult(
                 countryCode: placemark.isoCountryCode ?? "",
                 country: placemark.country ?? "",
                 locality: placemark.locality ?? "",
                 administrativeArea: placemark.administrativeArea ?? "",
-                subAdministrativeArea: placemark.subAdministrativeArea ?? "",
-                subLocality: placemark.subLocality ?? ""
-            )
-            resolve(result)
-        }
-
-        return promise
+                subAdministrativeArea: placemark.subAdministrativeArea ?? "",
+                subLocality: placemark.subLocality ?? ""
+            )
+            resolve(result)
+        }
+
+        return promise
     }
 }

package/nitrogen/generated/.gitattributes

@@ -1 +1 @@
-** linguist-generated=true
+** linguist-generated=true

package/nitrogen/generated/android/NitroLocationGeocoder+autolinking.cmake

@@ -1,81 +1,81 @@
-#
-# NitroLocationGeocoder+autolinking.cmake
-# This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
-# https://github.com/mrousavy/nitro
-# Copyright © Marc Rousavy @ Margelo
-#
-
-# This is a CMake file that adds all files generated by Nitrogen
-# to the current CMake project.
-#
-# To use it, add this to your CMakeLists.txt:
-# ```cmake
-# include(${CMAKE_SOURCE_DIR}/../nitrogen/generated/android/NitroLocationGeocoder+autolinking.cmake)
-# ```
-
-# Define a flag to check if we are building properly
-add_definitions(-DBUILDING_NITROLOCATIONGEOCODER_WITH_GENERATED_CMAKE_PROJECT)
-
-# Enable Raw Props parsing in react-native (for Nitro Views)
-add_definitions(-DRN_SERIALIZABLE_STATE)
-
-# Add all headers that were generated by Nitrogen
-include_directories(
-  "../nitrogen/generated/shared/c++"
-  "../nitrogen/generated/android/c++"
-  "../nitrogen/generated/android/"
-)
-
-# Add all .cpp sources that were generated by Nitrogen
-target_sources(
-  # CMake project name (Android C++ library name)
-  NitroLocationGeocoder PRIVATE
-  # Autolinking Setup
-  ../nitrogen/generated/android/NitroLocationGeocoderOnLoad.cpp
-  # Shared Nitrogen C++ sources
-  ../nitrogen/generated/shared/c++/HybridLocationGeocoderSpec.cpp
-  # Android-specific Nitrogen C++ sources
-  ../nitrogen/generated/android/c++/JHybridLocationGeocoderSpec.cpp
-)
-
-# From node_modules/react-native/ReactAndroid/cmake-utils/folly-flags.cmake
-# Used in node_modules/react-native/ReactAndroid/cmake-utils/ReactNative-application.cmake
-target_compile_definitions(
-  NitroLocationGeocoder PRIVATE
-  -DFOLLY_NO_CONFIG=1
-  -DFOLLY_HAVE_CLOCK_GETTIME=1
-  -DFOLLY_USE_LIBCPP=1
-  -DFOLLY_CFG_NO_COROUTINES=1
-  -DFOLLY_MOBILE=1
-  -DFOLLY_HAVE_RECVMMSG=1
-  -DFOLLY_HAVE_PTHREAD=1
-  # Once we target android-23 above, we can comment
-  # the following line. NDK uses GNU style stderror_r() after API 23.
-  -DFOLLY_HAVE_XSI_STRERROR_R=1
-)
-
-# Add all libraries required by the generated specs
-find_package(fbjni REQUIRED) # <-- Used for communication between Java <-> C++
-find_package(ReactAndroid REQUIRED) # <-- Used to set up React Native bindings (e.g. CallInvoker/TurboModule)
-find_package(react-native-nitro-modules REQUIRED) # <-- Used to create all HybridObjects and use the Nitro core library
-
-# Link all libraries together
-target_link_libraries(
-        NitroLocationGeocoder
-        fbjni::fbjni                              # <-- Facebook C++ JNI helpers
-        ReactAndroid::jsi                         # <-- RN: JSI
-        react-native-nitro-modules::NitroModules  # <-- NitroModules Core :)
-)
-
-# Link react-native (different prefab between RN 0.75 and RN 0.76)
-if(ReactAndroid_VERSION_MINOR GREATER_EQUAL 76)
-    target_link_libraries(
-        NitroLocationGeocoder
-        ReactAndroid::reactnative                 # <-- RN: Native Modules umbrella prefab
-    )
-else()
-    target_link_libraries(
-        NitroLocationGeocoder
-        ReactAndroid::react_nativemodule_core     # <-- RN: TurboModules Core
-    )
-endif()
+#
+# NitroLocationGeocoder+autolinking.cmake
+# This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+# https://github.com/mrousavy/nitro
+# Copyright © Marc Rousavy @ Margelo
+#
+
+# This is a CMake file that adds all files generated by Nitrogen
+# to the current CMake project.
+#
+# To use it, add this to your CMakeLists.txt:
+# ```cmake
+# include(${CMAKE_SOURCE_DIR}/../nitrogen/generated/android/NitroLocationGeocoder+autolinking.cmake)
+# ```
+
+# Define a flag to check if we are building properly
+add_definitions(-DBUILDING_NITROLOCATIONGEOCODER_WITH_GENERATED_CMAKE_PROJECT)
+
+# Enable Raw Props parsing in react-native (for Nitro Views)
+add_definitions(-DRN_SERIALIZABLE_STATE)
+
+# Add all headers that were generated by Nitrogen
+include_directories(
+  "../nitrogen/generated/shared/c++"
+  "../nitrogen/generated/android/c++"
+  "../nitrogen/generated/android/"
+)
+
+# Add all .cpp sources that were generated by Nitrogen
+target_sources(
+  # CMake project name (Android C++ library name)
+  NitroLocationGeocoder PRIVATE
+  # Autolinking Setup
+  ../nitrogen/generated/android/NitroLocationGeocoderOnLoad.cpp
+  # Shared Nitrogen C++ sources
+  ../nitrogen/generated/shared/c++/HybridLocationGeocoderSpec.cpp
+  # Android-specific Nitrogen C++ sources
+  ../nitrogen/generated/android/c++/JHybridLocationGeocoderSpec.cpp
+)
+
+# From node_modules/react-native/ReactAndroid/cmake-utils/folly-flags.cmake
+# Used in node_modules/react-native/ReactAndroid/cmake-utils/ReactNative-application.cmake
+target_compile_definitions(
+  NitroLocationGeocoder PRIVATE
+  -DFOLLY_NO_CONFIG=1
+  -DFOLLY_HAVE_CLOCK_GETTIME=1
+  -DFOLLY_USE_LIBCPP=1
+  -DFOLLY_CFG_NO_COROUTINES=1
+  -DFOLLY_MOBILE=1
+  -DFOLLY_HAVE_RECVMMSG=1
+  -DFOLLY_HAVE_PTHREAD=1
+  # Once we target android-23 above, we can comment
+  # the following line. NDK uses GNU style stderror_r() after API 23.
+  -DFOLLY_HAVE_XSI_STRERROR_R=1
+)
+
+# Add all libraries required by the generated specs
+find_package(fbjni REQUIRED) # <-- Used for communication between Java <-> C++
+find_package(ReactAndroid REQUIRED) # <-- Used to set up React Native bindings (e.g. CallInvoker/TurboModule)
+find_package(react-native-nitro-modules REQUIRED) # <-- Used to create all HybridObjects and use the Nitro core library
+
+# Link all libraries together
+target_link_libraries(
+        NitroLocationGeocoder
+        fbjni::fbjni                              # <-- Facebook C++ JNI helpers
+        ReactAndroid::jsi                         # <-- RN: JSI
+        react-native-nitro-modules::NitroModules  # <-- NitroModules Core :)
+)
+
+# Link react-native (different prefab between RN 0.75 and RN 0.76)
+if(ReactAndroid_VERSION_MINOR GREATER_EQUAL 76)
+    target_link_libraries(
+        NitroLocationGeocoder
+        ReactAndroid::reactnative                 # <-- RN: Native Modules umbrella prefab
+    )
+else()
+    target_link_libraries(
+        NitroLocationGeocoder
+        ReactAndroid::react_nativemodule_core     # <-- RN: TurboModules Core
+    )
+endif()

package/nitrogen/generated/android/NitroLocationGeocoder+autolinking.gradle

@@ -1,27 +1,27 @@
-///
-/// NitroLocationGeocoder+autolinking.gradle
-/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
-/// https://github.com/mrousavy/nitro
-/// Copyright © Marc Rousavy @ Margelo
-///
-
-/// This is a Gradle file that adds all files generated by Nitrogen
-/// to the current Gradle project.
-///
-/// To use it, add this to your build.gradle:
-/// ```gradle
-/// apply from: '../nitrogen/generated/android/NitroLocationGeocoder+autolinking.gradle'
-/// ```
-
-logger.warn("[NitroModules] 🔥 NitroLocationGeocoder is boosted by nitro!")
-
-android {
-  sourceSets {
-    main {
-      java.srcDirs += [
-        // Nitrogen files
-        "${project.projectDir}/../nitrogen/generated/android/kotlin"
-      ]
-    }
-  }
-}
+///
+/// NitroLocationGeocoder+autolinking.gradle
+/// This file was generated by nitrogen. DO NOT MODIFY THIS FILE.
+/// https://github.com/mrousavy/nitro
+/// Copyright © Marc Rousavy @ Margelo
+///
+
+/// This is a Gradle file that adds all files generated by Nitrogen
+/// to the current Gradle project.
+///
+/// To use it, add this to your build.gradle:
+/// ```gradle
+/// apply from: '../nitrogen/generated/android/NitroLocationGeocoder+autolinking.gradle'
+/// ```
+
+logger.warn("[NitroModules] 🔥 NitroLocationGeocoder is boosted by nitro!")
+
+android {
+  sourceSets {
+    main {
+      java.srcDirs += [
+        // Nitrogen files
+        "${project.projectDir}/../nitrogen/generated/android/kotlin"
+      ]
+    }
+  }
+}