@capgo/nativegeocoder 0.0.1

package/ios/Plugin/NativeGeocoder.swift

@@ -0,0 +1,242 @@
+import Foundation
+import CoreLocation
+
+struct NativeGeocoderResult: Encodable {
+    var latitude: String?
+    var longitude: String?
+    var countryCode: String?
+    var countryName: String?
+    var postalCode: String?
+    var administrativeArea: String?
+    var subAdministrativeArea: String?
+    var locality: String?
+    var subLocality: String?
+    var thoroughfare: String?
+    var subThoroughfare: String?
+    var areasOfInterest: [String]?
+}
+
+struct NativeGeocoderError {
+    var message: String
+}
+
+struct NativeGeocoderOptions: Decodable {
+    var useLocale: Bool = true
+    var defaultLocale: String?
+    var maxResults: Int = 1
+}
+
+@objc public class NativeGeocoder: NSObject {
+
+    typealias ReverseGeocodeCompletionHandler = ([NativeGeocoderResult]?, NativeGeocoderError?) -> Void
+    typealias ForwardGeocodeCompletionHandler = ([NativeGeocoderResult]?, NativeGeocoderError?) -> Void
+    private static let MAX_RESULTS_COUNT = 5
+
+    // MARK: - REVERSE GEOCODE
+    @objc(reverseGeocode:) func reverseGeocode(latitude: Double, longitude: Double, call: CAPPluginCall) {            
+        if (CLGeocoder().isGeocoding) {
+            call.reject("Geocoder is busy. Please try again later.")
+            return
+        }
+        
+        let location = CLLocation(latitude: latitude, longitude: longitude)
+        var options = NativeGeocoderOptions(useLocale: true, defaultLocale: nil, maxResults: 1)
+        options.useLocale = call.getBoolean("useLocale") ?? true
+        options.defaultLocale = call.getString()
+        options.maxResults = call.getNumber() ?? 1
+
+        reverseGeocodeLocationHandler(location, options: options, completionHandler: { [weak self] (resultObj, error) in
+            if let error = error {
+                call.reject(error.message)
+            } else {
+                if let encodedResult = try? JSONEncoder().encode(resultObj),
+                    let result = try? JSONSerialization.jsonObject(with: encodedResult, options: .allowFragments) as? [Dictionary<String,Any>] {
+                    call.resolve(result)
+                } else {
+                    call.reject("Invalid JSON result")
+                }
+            }
+        })
+    }
+    
+    private func reverseGeocodeLocationHandler(_ location: CLLocation, options: NativeGeocoderOptions, completionHandler: @escaping ReverseGeocodeCompletionHandler) {
+        let geocoderOptions = getNativeGeocoderOptions(from: options)
+        
+        if #available(iOS 11, *) {
+            var locale: Locale?
+            if let defaultLocaleString = geocoderOptions.defaultLocale {
+                locale = Locale.init(identifier: defaultLocaleString)
+            } else if (geocoderOptions.useLocale == false) {
+                locale = Locale.init(identifier: "en_US")
+            }
+
+            CLGeocoder().reverseGeocodeLocation(location, preferredLocale: locale, completionHandler: { [weak self] (placemarks, error) in
+                self?.createReverseGeocodeResult(placemarks, error, maxResults: geocoderOptions.maxResults, completionHandler: { (resultObj, error) in
+                    completionHandler(resultObj, error)
+                })
+            })
+        } else {
+            // fallback for < iOS 11
+            CLGeocoder().reverseGeocodeLocation(location, completionHandler: { [weak self] (placemarks, error) in
+                self?.createReverseGeocodeResult(placemarks, error, maxResults: geocoderOptions.maxResults, completionHandler: { (resultObj, error) in
+                    completionHandler(resultObj, error)
+                })
+            })
+        }
+    }
+    
+    private func createReverseGeocodeResult(_ placemarks: [CLPlacemark]?, _ error: Error?, maxResults: Int, completionHandler: @escaping ReverseGeocodeCompletionHandler) {
+        guard error == nil else {
+            completionHandler(nil, NativeGeocoderError(message: "CLGeocoder:reverseGeocodeLocation Error"))
+            return
+        }
+        
+        if let placemarks = placemarks {
+            let maxResultObjects = placemarks.count >= maxResults ? maxResults : placemarks.count
+            var resultObj = [NativeGeocoderResult]()
+            
+            for i in 0..<maxResultObjects {
+                // https://developer.apple.com/documentation/corelocation/clplacemark
+                var latitude = ""
+                if let lat = placemarks[i].location?.coordinate.latitude {
+                    latitude = "\(lat)"
+                }
+                var longitude = ""
+                if let lon = placemarks[i].location?.coordinate.longitude {
+                    longitude = "\(lon)"
+                }
+                let placemark = NativeGeocoderResult(
+                    latitude: latitude,
+                    longitude: longitude,
+                    countryCode: placemarks[i].isoCountryCode ?? "",
+                    countryName: placemarks[i].country ?? "",
+                    postalCode: placemarks[i].postalCode ?? "",
+                    administrativeArea: placemarks[i].administrativeArea ?? "",
+                    subAdministrativeArea: placemarks[i].subAdministrativeArea ?? "",
+                    locality: placemarks[i].locality ?? "",
+                    subLocality: placemarks[i].subLocality ?? "",
+                    thoroughfare: placemarks[i].thoroughfare ?? "",
+                    subThoroughfare: placemarks[i].subThoroughfare ?? "",
+                    areasOfInterest: placemarks[i].areasOfInterest ?? []
+                )
+                resultObj.append(placemark)
+            }
+            
+            completionHandler(resultObj, nil)
+        }
+        else {
+            completionHandler(nil, NativeGeocoderError(message: "Cannot get an address"))
+        }
+    }
+    
+    
+    // MARK: - FORWARD GEOCODE
+    @objc(forwardGeocode:)func forwardGeocode(address: String, call: CAPPluginCall) {
+        
+        if (CLGeocoder().isGeocoding) {
+            call.reject("Geocoder is busy. Please try again later.")
+            return
+        }
+        
+        var options = NativeGeocoderOptions(useLocale: true, defaultLocale: nil, maxResults: 1)
+        options.useLocale = call.getBoolean("useLocale") ?? true
+        options.defaultLocale = call.getString()
+        options.maxResults = call.getNumber() ?? 1
+        
+        forwardGeocodeHandler(address, options: options, completionHandler: { [weak self] (resultObj, error) in
+            if let error = error {
+                call.reject(error.message)
+            } else {
+                if let encodedResult = try? JSONEncoder().encode(resultObj),
+                    let result = try? JSONSerialization.jsonObject(with: encodedResult, options: .allowFragments) as? [Dictionary<String,Any>] {
+                    call.resolve(result)
+                } else {
+                    call.reject("Invalid JSON result")
+                }
+            }
+        })
+    }
+    
+    func forwardGeocodeHandler(_ address: String, options: NativeGeocoderOptions, completionHandler: @escaping ForwardGeocodeCompletionHandler) {
+        let geocoderOptions = getNativeGeocoderOptions(from: options)
+        
+        if #available(iOS 11, *) {
+            var locale: Locale?
+            if let defaultLocaleString = geocoderOptions.defaultLocale {
+                locale = Locale.init(identifier: defaultLocaleString)
+            } else if (geocoderOptions.useLocale == false) {
+                locale = Locale.init(identifier: "en_US")
+            }
+            
+            CLGeocoder().geocodeAddressString(address, in: nil, preferredLocale: locale, completionHandler: { [weak self] (placemarks, error) in
+                self?.createForwardGeocodeResult(placemarks, error, maxResults: geocoderOptions.maxResults, completionHandler: { (resultObj, error) in
+                    completionHandler(resultObj, error)
+                })
+            })
+        } else {
+            // fallback for < iOS 11
+            CLGeocoder().geocodeAddressString(address, completionHandler: { [weak self] (placemarks, error) in
+                self?.createForwardGeocodeResult(placemarks, error, maxResults: geocoderOptions.maxResults, completionHandler: { (resultObj, error) in
+                    completionHandler(resultObj, error)
+                })
+            })
+        }
+    }
+
+    private func createForwardGeocodeResult(_ placemarks: [CLPlacemark]?, _ error: Error?, maxResults: Int, completionHandler: @escaping ForwardGeocodeCompletionHandler) {
+        guard error == nil else {
+            completionHandler(nil, NativeGeocoderError(message: "CLGeocoder:geocodeAddressString Error"))
+            return
+        }
+        
+        if let placemarks = placemarks {
+            let maxResultObjects = placemarks.count >= maxResults ? maxResults : placemarks.count
+            var resultObj = [NativeGeocoderResult]()
+            
+            for i in 0..<maxResultObjects {
+                if let latitude = placemarks[i].location?.coordinate.latitude,
+                    let longitude = placemarks[i].location?.coordinate.longitude {
+                
+                    // https://developer.apple.com/documentation/corelocation/clplacemark
+                    let placemark = NativeGeocoderResult(
+                        latitude: "\(latitude)",
+                        longitude: "\(longitude)",
+                        countryCode: placemarks[i].isoCountryCode ?? "",
+                        countryName: placemarks[i].country ?? "",
+                        postalCode: placemarks[i].postalCode ?? "",
+                        administrativeArea: placemarks[i].administrativeArea ?? "",
+                        subAdministrativeArea: placemarks[i].subAdministrativeArea ?? "",
+                        locality: placemarks[i].locality ?? "",
+                        subLocality: placemarks[i].subLocality ?? "",
+                        thoroughfare: placemarks[i].thoroughfare ?? "",
+                        subThoroughfare: placemarks[i].subThoroughfare ?? "",
+                        areasOfInterest: placemarks[i].areasOfInterest ?? []
+                    )
+                    resultObj.append(placemark)
+                }
+            }
+            
+            if (resultObj.count == 0) {
+                completionHandler(nil, NativeGeocoderError(message: "Cannot get latitude and/or longitude"))
+            } else {
+                completionHandler(resultObj, nil)
+            }
+        }
+        else {
+            completionHandler(nil, NativeGeocoderError(message: "Cannot find a location"))
+        }
+    }
+    
+    // MARK: - Helper
+    private func getNativeGeocoderOptions(from options: NativeGeocoderOptions) -> NativeGeocoderOptions {
+        var geocoderOptions = NativeGeocoderOptions()
+        geocoderOptions.useLocale = options.useLocale
+        geocoderOptions.defaultLocale = options.defaultLocale
+        if (options.maxResults > 0) {
+            geocoderOptions.maxResults = options.maxResults > NativeGeocoder.MAX_RESULTS_COUNT ? NativeGeocoder.MAX_RESULTS_COUNT : options.maxResults
+        } else {
+            geocoderOptions.maxResults = 1
+        }
+        return geocoderOptions
+    }
+}

package/ios/Plugin/NativeGeocoderPlugin.h

@@ -0,0 +1,10 @@
+#import <UIKit/UIKit.h>
+
+//! Project version number for Plugin.
+FOUNDATION_EXPORT double PluginVersionNumber;
+
+//! Project version string for Plugin.
+FOUNDATION_EXPORT const unsigned char PluginVersionString[];
+
+// In this header, you should import all the public headers of your framework using statements like #import <Plugin/PublicHeader.h>
+

package/ios/Plugin/NativeGeocoderPlugin.m

@@ -0,0 +1,9 @@
+#import <Foundation/Foundation.h>
+#import <Capacitor/Capacitor.h>
+
+// Define the plugin using the CAP_PLUGIN Macro, and
+// each method the plugin supports using the CAP_PLUGIN_METHOD macro.
+CAP_PLUGIN(NativeGeocoderPlugin, "NativeGeocoder",
+           CAP_PLUGIN_METHOD(reverseGeocode, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(forwardGeocode, CAPPluginReturnPromise);
+)

package/ios/Plugin/NativeGeocoderPlugin.swift

@@ -0,0 +1,31 @@
+import Foundation
+import Capacitor
+
+/**
+ * Please read the Capacitor iOS Plugin Development Guide
+ * here: https://capacitorjs.com/docs/plugins/ios
+ */
+@objc(NativeGeocoderPlugin)
+public class NativeGeocoderPlugin: CAPPlugin {
+    private let implementation = NativeGeocoder()
+
+    @objc func reverseGeocode(_ call: CAPPluginCall) {
+        guard let addressString = call.getString("addressString") else {
+            call.reject("Missing addressString")
+            return
+        }
+        implementation.reverseGeocode(addressString: addressString, call: call)
+    }
+
+    @objc func forwardGeocode(_ call: CAPPluginCall) {
+        guard let latitude = call.getNumber("latitude") else {
+            call.reject("Missing latitude")
+            return
+        }
+        guard let longitude = call.getNumber("longitude") else {
+            call.reject("Missing longitude")
+            return
+        }
+        implementation.forwardGeocode(latitude: latitude, longitude: longitude, call: call)
+    }
+}

package/package.json

@@ -0,0 +1,79 @@
+{
+  "name": "@capgo/nativegeocoder",
+  "version": "0.0.1",
+  "description": "Capacitor plugin for native forward and reverse geocoding",
+  "main": "dist/plugin.cjs.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
+  "unpkg": "dist/plugin.js",
+  "files": [
+    "android/src/main/",
+    "android/build.gradle",
+    "dist/",
+    "ios/Plugin/",
+    "CapgoNativegeocoder.podspec"
+  ],
+  "author": "Martin Donadieu",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Cap-go/capacitor-nativegeocoder.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Cap-go/capacitor-nativegeocoder/issues"
+  },
+  "keywords": [
+    "capacitor",
+    "plugin",
+    "geocoder",
+    "native"
+  ],
+  "scripts": {
+    "verify": "npm run verify:ios && npm run verify:android && npm run verify:web",
+    "verify:ios": "cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin && cd ..",
+    "verify:android": "cd android && ./gradlew clean build test && cd ..",
+    "verify:web": "npm run build",
+    "lint": "npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint",
+    "fmt": "npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format",
+    "eslint": "eslint . --ext ts",
+    "prettier": "prettier \"**/*.{css,html,ts,js,java}\"",
+    "swiftlint": "node-swiftlint",
+    "docgen": "docgen --api NativeGeocoderPlugin --output-readme README.md --output-json dist/docs.json",
+    "build": "npm run clean && npm run docgen && tsc && rollup -c rollup.config.js",
+    "clean": "rimraf ./dist",
+    "watch": "tsc --watch",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "@capacitor/android": "^3.0.0",
+    "@capacitor/core": "^3.0.0",
+    "@capacitor/docgen": "^0.0.18",
+    "@capacitor/ios": "^3.0.0",
+    "@ionic/eslint-config": "^0.3.0",
+    "@ionic/prettier-config": "^1.0.1",
+    "@ionic/swiftlint-config": "^1.1.2",
+    "eslint": "^7.11.0",
+    "prettier": "~2.2.0",
+    "prettier-plugin-java": "~1.0.0",
+    "rimraf": "^3.0.2",
+    "rollup": "^2.32.0",
+    "swiftlint": "^1.0.1",
+    "typescript": "~4.0.3"
+  },
+  "peerDependencies": {
+    "@capacitor/core": "^3.0.0"
+  },
+  "prettier": "@ionic/prettier-config",
+  "swiftlint": "@ionic/swiftlint-config",
+  "eslintConfig": {
+    "extends": "@ionic/eslint-config/recommended"
+  },
+  "capacitor": {
+    "ios": {
+      "src": "ios"
+    },
+    "android": {
+      "src": "android"
+    }
+  }
+}