diff --git a/geolocation/.eslintignore b/geolocation/.eslintignore new file mode 100644 index 000000000..9d0b71a3c --- /dev/null +++ b/geolocation/.eslintignore @@ -0,0 +1,2 @@ +build +dist diff --git a/geolocation/.gitignore b/geolocation/.gitignore new file mode 100644 index 000000000..70ccbf713 --- /dev/null +++ b/geolocation/.gitignore @@ -0,0 +1,61 @@ +# node files +dist +node_modules + +# iOS files +Pods +Podfile.lock +Build +xcuserdata + +# macOS files +.DS_Store + + + +# Based on Android gitignore template: https://github.com/github/gitignore/blob/HEAD/Android.gitignore + +# Built application files +*.apk +*.ap_ + +# Files for the ART/Dalvik VM +*.dex + +# Java class files +*.class + +# Generated files +bin +gen +out + +# Gradle files +.gradle +build + +# Local configuration file (sdk path, etc) +local.properties + +# Proguard folder generated by Eclipse +proguard + +# Log Files +*.log + +# Android Studio Navigation editor temp files +.navigation + +# Android Studio captures folder +captures + +# IntelliJ +*.iml +.idea + +# Keystore files +# Uncomment the following line if you do not want to check your keystore files in. +#*.jks + +# External native build folder generated in Android Studio 2.2 and later +.externalNativeBuild diff --git a/geolocation/.prettierignore b/geolocation/.prettierignore new file mode 100644 index 000000000..9d0b71a3c --- /dev/null +++ b/geolocation/.prettierignore @@ -0,0 +1,2 @@ +build +dist diff --git a/geolocation/CapacitorGeolocation.podspec b/geolocation/CapacitorGeolocation.podspec new file mode 100644 index 000000000..8252edd94 --- /dev/null +++ b/geolocation/CapacitorGeolocation.podspec @@ -0,0 +1,17 @@ +require 'json' + +package = JSON.parse(File.read(File.join(__dir__, 'package.json'))) + +Pod::Spec.new do |s| + s.name = 'CapacitorGeolocation' + s.version = package['version'] + s.summary = package['description'] + s.license = package['license'] + s.homepage = package['repository']['url'] + s.author = package['author'] + s.source = { :git => package['repository']['url'], :tag => s.version.to_s } + s.source_files = 'ios/Plugin/**/*.{swift,h,m,c,cc,mm,cpp}' + s.ios.deployment_target = '11.0' + s.dependency 'Capacitor' + s.swift_version = '5.1' +end diff --git a/geolocation/LICENSE b/geolocation/LICENSE new file mode 100644 index 000000000..6652495cb --- /dev/null +++ b/geolocation/LICENSE @@ -0,0 +1,23 @@ +Copyright 2020-present Ionic +https://ionic.io + +MIT License + +Permission is hereby granted, free of charge, to any person obtaining +a copy of this software and associated documentation files (the +"Software"), to deal in the Software without restriction, including +without limitation the rights to use, copy, modify, merge, publish, +distribute, sublicense, and/or sell copies of the Software, and to +permit persons to whom the Software is furnished to do so, subject to +the following conditions: + +The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/geolocation/README.md b/geolocation/README.md new file mode 100644 index 000000000..adbf8131f --- /dev/null +++ b/geolocation/README.md @@ -0,0 +1,165 @@ +# @capacitor/geolocation + +The Geolocation API provides simple methods for getting and tracking the current position of the device using GPS, along with altitude, heading, and speed information if available. + +## Install + +```bash +npm install @capacitor/geolocation +npx cap sync +``` + +## API + + + +* [`getCurrentPosition(...)`](#getcurrentposition) +* [`watchPosition(...)`](#watchposition) +* [`clearWatch(...)`](#clearwatch) +* [`checkPermissions()`](#checkpermissions) +* [`requestPermissions()`](#requestpermissions) +* [Interfaces](#interfaces) +* [Type Aliases](#type-aliases) + + + + + + +### getCurrentPosition(...) + +```typescript +getCurrentPosition(options?: GeolocationOptions | undefined) => Promise +``` + +Get the current GPS location of the device + +| Param | Type | +| ------------- | ----------------------------------------------------------------- | +| **`options`** | GeolocationOptions | + +**Returns:** Promise<GeolocationPosition> + +**Since:** 1.0.0 + +-------------------- + + +### watchPosition(...) + +```typescript +watchPosition(options: GeolocationOptions, callback: GeolocationWatchCallback) => CallbackID +``` + +Set up a watch for location changes. Note that watching for location changes +can consume a large amount of energy. Be smart about listening only when you need to. + +| Param | Type | +| -------------- | ----------------------------------------------------------------------------- | +| **`options`** | GeolocationOptions | +| **`callback`** | GeolocationWatchCallback | + +**Returns:** string + +**Since:** 1.0.0 + +-------------------- + + +### clearWatch(...) + +```typescript +clearWatch(options: { id: string; }) => Promise +``` + +Clear a given watch + +| Param | Type | +| ------------- | ---------------------------- | +| **`options`** | { id: string; } | + +**Since:** 1.0.0 + +-------------------- + + +### checkPermissions() + +```typescript +checkPermissions() => Promise +``` + +Check location permissions + +**Returns:** Promise<GeolocationPermissionStatus> + +**Since:** 1.0.0 + +-------------------- + + +### requestPermissions() + +```typescript +requestPermissions() => Promise +``` + +Request location permissions + +**Returns:** Promise<GeolocationPermissionStatus> + +**Since:** 1.0.0 + +-------------------- + + +### Interfaces + + +#### GeolocationPosition + +| Prop | Type | Description | Since | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------- | ----- | +| **`timestamp`** | number | Creation timestamp for coords | 1.0.0 | +| **`coords`** | { latitude: number; longitude: number; accuracy: number; altitudeAccuracy: number \| null; altitude: number \| null; speed: number \| null; heading: number \| null; } | The GPS coordinates along with the accuracy of the data | 1.0.0 | + + +#### GeolocationOptions + +| Prop | Type | Description | Default | Since | +| ------------------------ | -------------------- | ------------------------------------------------------------------------------------------ | ------------------ | ----- | +| **`enableHighAccuracy`** | boolean | High accuracy mode (such as GPS, if available) | false | 1.0.0 | +| **`timeout`** | number | The maximum wait time in milliseconds for location updates | 10000 | 1.0.0 | +| **`maximumAge`** | number | The maximum age in milliseconds of a possible cached position that is acceptable to return | 0 | 1.0.0 | + + +#### GeolocationPermissionStatus + +| Prop | Type | +| -------------- | ------------------------------------------------------------- | +| **`location`** | GeolocationState | + + +### Type Aliases + + +#### GeolocationWatchCallback + +(position: GeolocationPosition | null, err?: any): void + + +#### CallbackID + +string + + +#### GeolocationState + +PermissionState + + +#### PermissionState + +'prompt' | 'prompt-with-rationale' | 'granted' | 'denied' + + diff --git a/geolocation/android/.gitignore b/geolocation/android/.gitignore new file mode 100644 index 000000000..42afabfd2 --- /dev/null +++ b/geolocation/android/.gitignore @@ -0,0 +1 @@ +/build \ No newline at end of file diff --git a/geolocation/android/build.gradle b/geolocation/android/build.gradle new file mode 100644 index 000000000..a9eb55ee7 --- /dev/null +++ b/geolocation/android/build.gradle @@ -0,0 +1,58 @@ +ext { + junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.12' + androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.1' + androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.2.0' + playServicesLocationVersion = project.hasProperty('playServicesLocationVersion') ? rootProject.ext.playServicesLocationVersion : '17.0.0' +} + +buildscript { + repositories { + google() + jcenter() + } + dependencies { + classpath 'com.android.tools.build:gradle:4.1.1' + } +} + +apply plugin: 'com.android.library' + +android { + compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 29 + defaultConfig { + minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 21 + targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 29 + versionCode 1 + versionName "1.0" + testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" + } + buildTypes { + release { + minifyEnabled false + proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro' + } + } + lintOptions { + abortOnError false + } + compileOptions { + sourceCompatibility JavaVersion.VERSION_1_8 + targetCompatibility JavaVersion.VERSION_1_8 + } +} + +repositories { + google() + jcenter() + mavenCentral() +} + + +dependencies { + implementation fileTree(dir: 'libs', include: ['*.jar']) + implementation project(':capacitor-android') + implementation "com.google.android.gms:play-services-location:$playServicesLocationVersion" + testImplementation "junit:junit:$junitVersion" + androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion" + androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion" +} diff --git a/geolocation/android/gradle.properties b/geolocation/android/gradle.properties new file mode 100644 index 000000000..0566c221d --- /dev/null +++ b/geolocation/android/gradle.properties @@ -0,0 +1,24 @@ +# Project-wide Gradle settings. + +# IDE (e.g. Android Studio) users: +# Gradle settings configured through the IDE *will override* +# any settings specified in this file. + +# For more details on how to configure your build environment visit +# http://www.gradle.org/docs/current/userguide/build_environment.html + +# Specifies the JVM arguments used for the daemon process. +# The setting is particularly useful for tweaking memory settings. +org.gradle.jvmargs=-Xmx1536m + +# When configured, Gradle will run in incubating parallel mode. +# This option should only be used with decoupled projects. More details, visit +# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects +# org.gradle.parallel=true + +# AndroidX package structure to make it clearer which packages are bundled with the +# Android operating system, and which are packaged with your app's APK +# https://developer.android.com/topic/libraries/support-library/androidx-rn +android.useAndroidX=true +# Automatically convert third-party libraries to use AndroidX +android.enableJetifier=true diff --git a/geolocation/android/gradle/wrapper/gradle-wrapper.jar b/geolocation/android/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 000000000..62d4c0535 Binary files /dev/null and b/geolocation/android/gradle/wrapper/gradle-wrapper.jar differ diff --git a/geolocation/android/gradle/wrapper/gradle-wrapper.properties b/geolocation/android/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 000000000..186b71557 --- /dev/null +++ b/geolocation/android/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,5 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-6.5-all.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/geolocation/android/gradlew b/geolocation/android/gradlew new file mode 100755 index 000000000..fbd7c5158 --- /dev/null +++ b/geolocation/android/gradlew @@ -0,0 +1,185 @@ +#!/usr/bin/env sh + +# +# Copyright 2015 the original author or authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; + NONSTOP* ) + nonstop=true + ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin or MSYS, switch paths to Windows format before running java +if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=`expr $i + 1` + done + case $i in + 0) set -- ;; + 1) set -- "$args0" ;; + 2) set -- "$args0" "$args1" ;; + 3) set -- "$args0" "$args1" "$args2" ;; + 4) set -- "$args0" "$args1" "$args2" "$args3" ;; + 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=`save "$@"` + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +exec "$JAVACMD" "$@" diff --git a/geolocation/android/gradlew.bat b/geolocation/android/gradlew.bat new file mode 100644 index 000000000..a9f778a7a --- /dev/null +++ b/geolocation/android/gradlew.bat @@ -0,0 +1,104 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windows variants + +if not "%OS%" == "Windows_NT" goto win9xME_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/geolocation/android/proguard-rules.pro b/geolocation/android/proguard-rules.pro new file mode 100644 index 000000000..f1b424510 --- /dev/null +++ b/geolocation/android/proguard-rules.pro @@ -0,0 +1,21 @@ +# Add project specific ProGuard rules here. +# You can control the set of applied configuration files using the +# proguardFiles setting in build.gradle. +# +# For more details, see +# http://developer.android.com/guide/developing/tools/proguard.html + +# If your project uses WebView with JS, uncomment the following +# and specify the fully qualified class name to the JavaScript interface +# class: +#-keepclassmembers class fqcn.of.javascript.interface.for.webview { +# public *; +#} + +# Uncomment this to preserve the line number information for +# debugging stack traces. +#-keepattributes SourceFile,LineNumberTable + +# If you keep the line number information, uncomment this to +# hide the original source file name. +#-renamesourcefileattribute SourceFile diff --git a/geolocation/android/settings.gradle b/geolocation/android/settings.gradle new file mode 100644 index 000000000..1e5b8431f --- /dev/null +++ b/geolocation/android/settings.gradle @@ -0,0 +1,2 @@ +include ':capacitor-android' +project(':capacitor-android').projectDir = new File('../node_modules/@capacitor/android/capacitor') \ No newline at end of file diff --git a/geolocation/android/src/androidTest/java/com/getcapacitor/android/ExampleInstrumentedTest.java b/geolocation/android/src/androidTest/java/com/getcapacitor/android/ExampleInstrumentedTest.java new file mode 100644 index 000000000..58020e16c --- /dev/null +++ b/geolocation/android/src/androidTest/java/com/getcapacitor/android/ExampleInstrumentedTest.java @@ -0,0 +1,26 @@ +package com.getcapacitor.android; + +import static org.junit.Assert.*; + +import android.content.Context; +import androidx.test.ext.junit.runners.AndroidJUnit4; +import androidx.test.platform.app.InstrumentationRegistry; +import org.junit.Test; +import org.junit.runner.RunWith; + +/** + * Instrumented test, which will execute on an Android device. + * + * @see Testing documentation + */ +@RunWith(AndroidJUnit4.class) +public class ExampleInstrumentedTest { + + @Test + public void useAppContext() throws Exception { + // Context of the app under test. + Context appContext = InstrumentationRegistry.getInstrumentation().getTargetContext(); + + assertEquals("com.getcapacitor.android", appContext.getPackageName()); + } +} diff --git a/geolocation/android/src/main/AndroidManifest.xml b/geolocation/android/src/main/AndroidManifest.xml new file mode 100644 index 000000000..7e5d28df2 --- /dev/null +++ b/geolocation/android/src/main/AndroidManifest.xml @@ -0,0 +1,3 @@ + + diff --git a/geolocation/android/src/main/java/com/capacitorjs/plugins/geolocation/Geolocation.java b/geolocation/android/src/main/java/com/capacitorjs/plugins/geolocation/Geolocation.java new file mode 100644 index 000000000..60e92963d --- /dev/null +++ b/geolocation/android/src/main/java/com/capacitorjs/plugins/geolocation/Geolocation.java @@ -0,0 +1,91 @@ +package com.capacitorjs.plugins.geolocation; + +import android.content.Context; +import android.location.Location; +import android.location.LocationManager; +import com.google.android.gms.location.FusedLocationProviderClient; +import com.google.android.gms.location.LocationAvailability; +import com.google.android.gms.location.LocationCallback; +import com.google.android.gms.location.LocationRequest; +import com.google.android.gms.location.LocationResult; +import com.google.android.gms.location.LocationServices; + +public class Geolocation { + + private FusedLocationProviderClient fusedLocationClient; + private LocationCallback locationCallback; + + private Context context; + + public Geolocation(Context context) { + this.context = context; + } + + public void sendLocation( + boolean enableHighAccuracy, + int timeout, + final boolean getCurrentPosition, + final LocationResultCallback resultCallback + ) { + requestLocationUpdates(enableHighAccuracy, timeout, getCurrentPosition, resultCallback); + } + + @SuppressWarnings("MissingPermission") + public void requestLocationUpdates( + boolean enableHighAccuracy, + int timeout, + final boolean getCurrentPosition, + final LocationResultCallback resultCallback + ) { + clearLocationUpdates(); + fusedLocationClient = LocationServices.getFusedLocationProviderClient(context); + + LocationManager lm = (LocationManager) context.getSystemService(Context.LOCATION_SERVICE); + boolean networkEnabled = false; + + try { + networkEnabled = lm.isProviderEnabled(LocationManager.NETWORK_PROVIDER); + } catch (Exception ex) {} + + LocationRequest locationRequest = new LocationRequest(); + locationRequest.setMaxWaitTime(timeout); + locationRequest.setInterval(10000); + locationRequest.setFastestInterval(5000); + int lowPriority = networkEnabled ? LocationRequest.PRIORITY_BALANCED_POWER_ACCURACY : LocationRequest.PRIORITY_LOW_POWER; + int priority = enableHighAccuracy ? LocationRequest.PRIORITY_HIGH_ACCURACY : lowPriority; + locationRequest.setPriority(priority); + + locationCallback = + new LocationCallback() { + @Override + public void onLocationResult(LocationResult locationResult) { + if (getCurrentPosition) { + clearLocationUpdates(); + } + Location lastLocation = locationResult.getLastLocation(); + if (lastLocation == null) { + resultCallback.error("location unavailable"); + } else { + resultCallback.success(lastLocation); + } + } + + @Override + public void onLocationAvailability(LocationAvailability availability) { + if (!availability.isLocationAvailable()) { + resultCallback.error("location unavailable"); + clearLocationUpdates(); + } + } + }; + + fusedLocationClient.requestLocationUpdates(locationRequest, locationCallback, null); + } + + public void clearLocationUpdates() { + if (locationCallback != null) { + fusedLocationClient.removeLocationUpdates(locationCallback); + locationCallback = null; + } + } +} diff --git a/geolocation/android/src/main/java/com/capacitorjs/plugins/geolocation/GeolocationPlugin.java b/geolocation/android/src/main/java/com/capacitorjs/plugins/geolocation/GeolocationPlugin.java new file mode 100644 index 000000000..3c55af675 --- /dev/null +++ b/geolocation/android/src/main/java/com/capacitorjs/plugins/geolocation/GeolocationPlugin.java @@ -0,0 +1,216 @@ +package com.capacitorjs.plugins.geolocation; + +import android.Manifest; +import android.content.pm.PackageManager; +import android.location.Location; +import android.os.Build; +import com.getcapacitor.JSObject; +import com.getcapacitor.Plugin; +import com.getcapacitor.PluginCall; +import com.getcapacitor.PluginMethod; +import com.getcapacitor.annotation.CapacitorPlugin; +import com.getcapacitor.annotation.Permission; +import java.util.HashMap; +import java.util.Map; + +@CapacitorPlugin( + name = "Geolocation", + permissions = { + @Permission(strings = { Manifest.permission.ACCESS_COARSE_LOCATION, Manifest.permission.ACCESS_FINE_LOCATION }, alias = "location") + }, + permissionRequestCode = GeolocationPlugin.GEOLOCATION_REQUEST_PERMISSIONS +) +public class GeolocationPlugin extends Plugin { + + public static final int GEOLOCATION_REQUEST_PERMISSIONS = 9030; + + private Geolocation implementation; + private Map watchingCalls = new HashMap<>(); + + @Override + public void load() { + implementation = new Geolocation(getContext()); + } + + /** + * Gets a snapshot of the current device position if permissions are granted. If not, + * the call is rejected in {@link #onRequestPermissionsResult(int, String[], int[])}. + * + * @param call Plugin call + */ + @PluginMethod + public void getCurrentPosition(final PluginCall call) { + if (!hasRequiredPermissions()) { + requestAllPermissions(call); + } else { + getPosition(call); + } + } + + @SuppressWarnings("MissingPermission") + private void getPosition(PluginCall call) { + boolean enableHighAccuracy = call.getBoolean("enableHighAccuracy", false); + int timeout = call.getInt("timeout", 10000); + + implementation.sendLocation( + enableHighAccuracy, + timeout, + false, + new LocationResultCallback() { + @Override + public void success(Location location) { + call.resolve(getJSObjectForLocation(location)); + } + + @Override + public void error(String message) { + call.reject(message); + } + } + ); + } + + /** + * Begins watching for live location changes if permissions are granted. If not, + * the call is rejected in {@link #onRequestPermissionsResult(int, String[], int[])}. + * + * @param call Plugin call + */ + @PluginMethod(returnType = PluginMethod.RETURN_CALLBACK) + public void watchPosition(PluginCall call) { + call.save(); + if (!hasRequiredPermissions()) { + requestAllPermissions(call); + } else { + startWatch(call); + } + } + + @SuppressWarnings("MissingPermission") + private void startWatch(final PluginCall call) { + boolean enableHighAccuracy = call.getBoolean("enableHighAccuracy", false); + int timeout = call.getInt("timeout", 10000); + + implementation.requestLocationUpdates( + enableHighAccuracy, + timeout, + false, + new LocationResultCallback() { + @Override + public void success(Location location) { + call.resolve(getJSObjectForLocation(location)); + } + + @Override + public void error(String message) { + call.reject(message); + } + } + ); + + watchingCalls.put(call.getCallbackId(), call); + } + + /** + * Removes an active geolocation watch. + * + * @param call Plugin call + */ + @SuppressWarnings("MissingPermission") + @PluginMethod + public void clearWatch(PluginCall call) { + String callbackId = call.getString("id"); + + if (callbackId != null) { + PluginCall removed = watchingCalls.remove(callbackId); + if (removed != null) { + removed.release(bridge); + } + + if (watchingCalls.size() == 0) { + implementation.clearLocationUpdates(); + } + + call.resolve(); + } else { + call.reject("Watch call id must be provided"); + } + } + + /** + * Handle permission results related to the plugin. Permission calls may happen by direct + * plugin call or during a call to {@link #getCurrentPosition} or {@link #watchPosition}. + * + * The result of a direct call will return the result states for each permission. + * + * @param savedCall The original call to the plugin waiting for a response + * @param requestCode The code associated with the permission request {@link #GEOLOCATION_REQUEST_PERMISSIONS} + * @param permissions The permissions requested + * @param grantResults The result status + */ + @Override + protected void onRequestPermissionsResult(PluginCall savedCall, int requestCode, String[] permissions, int[] grantResults) { + if (savedCall.getMethodName().equals("getCurrentPosition")) { + if (!handleDenied(savedCall, grantResults)) { + boolean enableHighAccuracy = savedCall.getBoolean("enableHighAccuracy", false); + int timeout = savedCall.getInt("timeout", 10000); + + implementation.sendLocation( + enableHighAccuracy, + timeout, + true, + new LocationResultCallback() { + @Override + public void success(Location location) { + savedCall.resolve(getJSObjectForLocation(location)); + } + + @Override + public void error(String message) { + savedCall.reject(message); + } + } + ); + } + } else if (savedCall.getMethodName().equals("watchPosition")) { + if (!handleDenied(savedCall, grantResults)) { + startWatch(savedCall); + } + } + } + + /** + * Return rejection if permissions were denied during a request triggered from a plugin call. + * + * @param savedCall The cached plugin call to respond to + * @param grantResults The plugin permission results + * @return true if a denied permission occurred and the rejection is handled, false if not + */ + private boolean handleDenied(PluginCall savedCall, int[] grantResults) { + for (int result : grantResults) { + if (result == PackageManager.PERMISSION_DENIED) { + savedCall.reject("Location permission was denied"); + return true; + } + } + + return false; + } + + private JSObject getJSObjectForLocation(Location location) { + JSObject ret = new JSObject(); + JSObject coords = new JSObject(); + ret.put("coords", coords); + ret.put("timestamp", location.getTime()); + coords.put("latitude", location.getLatitude()); + coords.put("longitude", location.getLongitude()); + coords.put("accuracy", location.getAccuracy()); + coords.put("altitude", location.getAltitude()); + if (Build.VERSION.SDK_INT >= 26) { + coords.put("altitudeAccuracy", location.getVerticalAccuracyMeters()); + } + coords.put("speed", location.getSpeed()); + coords.put("heading", location.getBearing()); + return ret; + } +} diff --git a/geolocation/android/src/main/java/com/capacitorjs/plugins/geolocation/LocationResultCallback.java b/geolocation/android/src/main/java/com/capacitorjs/plugins/geolocation/LocationResultCallback.java new file mode 100644 index 000000000..f3da0fc3a --- /dev/null +++ b/geolocation/android/src/main/java/com/capacitorjs/plugins/geolocation/LocationResultCallback.java @@ -0,0 +1,8 @@ +package com.capacitorjs.plugins.geolocation; + +import android.location.Location; + +public interface LocationResultCallback { + void success(Location location); + void error(String message); +} diff --git a/geolocation/android/src/test/java/com/getcapacitor/ExampleUnitTest.java b/geolocation/android/src/test/java/com/getcapacitor/ExampleUnitTest.java new file mode 100644 index 000000000..a0fed0cfb --- /dev/null +++ b/geolocation/android/src/test/java/com/getcapacitor/ExampleUnitTest.java @@ -0,0 +1,18 @@ +package com.getcapacitor; + +import static org.junit.Assert.*; + +import org.junit.Test; + +/** + * Example local unit test, which will execute on the development machine (host). + * + * @see Testing documentation + */ +public class ExampleUnitTest { + + @Test + public void addition_isCorrect() throws Exception { + assertEquals(4, 2 + 2); + } +} diff --git a/geolocation/ios/Plugin.xcodeproj/project.pbxproj b/geolocation/ios/Plugin.xcodeproj/project.pbxproj new file mode 100644 index 000000000..035b74f52 --- /dev/null +++ b/geolocation/ios/Plugin.xcodeproj/project.pbxproj @@ -0,0 +1,565 @@ +// !$*UTF8*$! +{ + archiveVersion = 1; + classes = { + }; + objectVersion = 48; + objects = { + +/* Begin PBXBuildFile section */ + 03FC29A292ACC40490383A1F /* Pods_Plugin.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 3B2A61DA5A1F2DD4F959604D /* Pods_Plugin.framework */; }; + 20C0B05DCFC8E3958A738AF2 /* Pods_PluginTests.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = F6753A823D3815DB436415E3 /* Pods_PluginTests.framework */; }; + 50ADFF92201F53D600D50D53 /* Plugin.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 50ADFF88201F53D600D50D53 /* Plugin.framework */; }; + 50ADFF97201F53D600D50D53 /* GeolocationPluginTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 50ADFF96201F53D600D50D53 /* GeolocationPluginTests.swift */; }; + 50ADFF99201F53D600D50D53 /* GeolocationPlugin.h in Headers */ = {isa = PBXBuildFile; fileRef = 50ADFF8B201F53D600D50D53 /* GeolocationPlugin.h */; settings = {ATTRIBUTES = (Public, ); }; }; + 50ADFFA42020D75100D50D53 /* Capacitor.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 50ADFFA52020D75100D50D53 /* Capacitor.framework */; }; + 50ADFFA82020EE4F00D50D53 /* GeolocationPlugin.m in Sources */ = {isa = PBXBuildFile; fileRef = 50ADFFA72020EE4F00D50D53 /* GeolocationPlugin.m */; }; + 50E1A94820377CB70090CE1A /* GeolocationPlugin.swift in Sources */ = {isa = PBXBuildFile; fileRef = 50E1A94720377CB70090CE1A /* GeolocationPlugin.swift */; }; +/* End PBXBuildFile section */ + +/* Begin PBXContainerItemProxy section */ + 50ADFF93201F53D600D50D53 /* PBXContainerItemProxy */ = { + isa = PBXContainerItemProxy; + containerPortal = 50ADFF7F201F53D600D50D53 /* Project object */; + proxyType = 1; + remoteGlobalIDString = 50ADFF87201F53D600D50D53; + remoteInfo = Plugin; + }; +/* End PBXContainerItemProxy section */ + +/* Begin PBXFileReference section */ + 3B2A61DA5A1F2DD4F959604D /* Pods_Plugin.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_Plugin.framework; sourceTree = BUILT_PRODUCTS_DIR; }; + 50ADFF88201F53D600D50D53 /* Plugin.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Plugin.framework; sourceTree = BUILT_PRODUCTS_DIR; }; + 50ADFF8B201F53D600D50D53 /* GeolocationPlugin.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = GeolocationPlugin.h; sourceTree = ""; }; + 50ADFF8C201F53D600D50D53 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = ""; }; + 50ADFF91201F53D600D50D53 /* PluginTests.xctest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = PluginTests.xctest; sourceTree = BUILT_PRODUCTS_DIR; }; + 50ADFF96201F53D600D50D53 /* GeolocationPluginTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = GeolocationPluginTests.swift; sourceTree = ""; }; + 50ADFF98201F53D600D50D53 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = ""; }; + 50ADFFA52020D75100D50D53 /* Capacitor.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; path = Capacitor.framework; sourceTree = BUILT_PRODUCTS_DIR; }; + 50ADFFA72020EE4F00D50D53 /* GeolocationPlugin.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = GeolocationPlugin.m; sourceTree = ""; }; + 50E1A94720377CB70090CE1A /* GeolocationPlugin.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = GeolocationPlugin.swift; sourceTree = ""; }; + 5E23F77F099397094342571A /* Pods-Plugin.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Plugin.debug.xcconfig"; path = "Pods/Target Support Files/Pods-Plugin/Pods-Plugin.debug.xcconfig"; sourceTree = ""; }; + 91781294A431A2A7CC6EB714 /* Pods-Plugin.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-Plugin.release.xcconfig"; path = "Pods/Target Support Files/Pods-Plugin/Pods-Plugin.release.xcconfig"; sourceTree = ""; }; + 96ED1B6440D6672E406C8D19 /* Pods-PluginTests.debug.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-PluginTests.debug.xcconfig"; path = "Pods/Target Support Files/Pods-PluginTests/Pods-PluginTests.debug.xcconfig"; sourceTree = ""; }; + F65BB2953ECE002E1EF3E424 /* Pods-PluginTests.release.xcconfig */ = {isa = PBXFileReference; includeInIndex = 1; lastKnownFileType = text.xcconfig; name = "Pods-PluginTests.release.xcconfig"; path = "Pods/Target Support Files/Pods-PluginTests/Pods-PluginTests.release.xcconfig"; sourceTree = ""; }; + F6753A823D3815DB436415E3 /* Pods_PluginTests.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = Pods_PluginTests.framework; sourceTree = BUILT_PRODUCTS_DIR; }; +/* End PBXFileReference section */ + +/* Begin PBXFrameworksBuildPhase section */ + 50ADFF84201F53D600D50D53 /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + 50ADFFA42020D75100D50D53 /* Capacitor.framework in Frameworks */, + 03FC29A292ACC40490383A1F /* Pods_Plugin.framework in Frameworks */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 50ADFF8E201F53D600D50D53 /* Frameworks */ = { + isa = PBXFrameworksBuildPhase; + buildActionMask = 2147483647; + files = ( + 50ADFF92201F53D600D50D53 /* Plugin.framework in Frameworks */, + 20C0B05DCFC8E3958A738AF2 /* Pods_PluginTests.framework in Frameworks */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXFrameworksBuildPhase section */ + +/* Begin PBXGroup section */ + 50ADFF7E201F53D600D50D53 = { + isa = PBXGroup; + children = ( + 50ADFF8A201F53D600D50D53 /* Plugin */, + 50ADFF95201F53D600D50D53 /* PluginTests */, + 50ADFF89201F53D600D50D53 /* Products */, + 8C8E7744173064A9F6D438E3 /* Pods */, + A797B9EFA3DCEFEA1FBB66A9 /* Frameworks */, + ); + sourceTree = ""; + }; + 50ADFF89201F53D600D50D53 /* Products */ = { + isa = PBXGroup; + children = ( + 50ADFF88201F53D600D50D53 /* Plugin.framework */, + 50ADFF91201F53D600D50D53 /* PluginTests.xctest */, + ); + name = Products; + sourceTree = ""; + }; + 50ADFF8A201F53D600D50D53 /* Plugin */ = { + isa = PBXGroup; + children = ( + 50E1A94720377CB70090CE1A /* GeolocationPlugin.swift */, + 50ADFF8B201F53D600D50D53 /* GeolocationPlugin.h */, + 50ADFFA72020EE4F00D50D53 /* GeolocationPlugin.m */, + 50ADFF8C201F53D600D50D53 /* Info.plist */, + ); + path = Plugin; + sourceTree = ""; + }; + 50ADFF95201F53D600D50D53 /* PluginTests */ = { + isa = PBXGroup; + children = ( + 50ADFF96201F53D600D50D53 /* GeolocationPluginTests.swift */, + 50ADFF98201F53D600D50D53 /* Info.plist */, + ); + path = PluginTests; + sourceTree = ""; + }; + 8C8E7744173064A9F6D438E3 /* Pods */ = { + isa = PBXGroup; + children = ( + 5E23F77F099397094342571A /* Pods-Plugin.debug.xcconfig */, + 91781294A431A2A7CC6EB714 /* Pods-Plugin.release.xcconfig */, + 96ED1B6440D6672E406C8D19 /* Pods-PluginTests.debug.xcconfig */, + F65BB2953ECE002E1EF3E424 /* Pods-PluginTests.release.xcconfig */, + ); + name = Pods; + sourceTree = ""; + }; + A797B9EFA3DCEFEA1FBB66A9 /* Frameworks */ = { + isa = PBXGroup; + children = ( + 50ADFFA52020D75100D50D53 /* Capacitor.framework */, + 3B2A61DA5A1F2DD4F959604D /* Pods_Plugin.framework */, + F6753A823D3815DB436415E3 /* Pods_PluginTests.framework */, + ); + name = Frameworks; + sourceTree = ""; + }; +/* End PBXGroup section */ + +/* Begin PBXHeadersBuildPhase section */ + 50ADFF85201F53D600D50D53 /* Headers */ = { + isa = PBXHeadersBuildPhase; + buildActionMask = 2147483647; + files = ( + 50ADFF99201F53D600D50D53 /* GeolocationPlugin.h in Headers */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXHeadersBuildPhase section */ + +/* Begin PBXNativeTarget section */ + 50ADFF87201F53D600D50D53 /* Plugin */ = { + isa = PBXNativeTarget; + buildConfigurationList = 50ADFF9C201F53D600D50D53 /* Build configuration list for PBXNativeTarget "Plugin" */; + buildPhases = ( + AB5B3E54B4E897F32C2279DA /* [CP] Check Pods Manifest.lock */, + 50ADFF83201F53D600D50D53 /* Sources */, + 50ADFF84201F53D600D50D53 /* Frameworks */, + 50ADFF85201F53D600D50D53 /* Headers */, + 50ADFF86201F53D600D50D53 /* Resources */, + ); + buildRules = ( + ); + dependencies = ( + ); + name = Plugin; + productName = Plugin; + productReference = 50ADFF88201F53D600D50D53 /* Plugin.framework */; + productType = "com.apple.product-type.framework"; + }; + 50ADFF90201F53D600D50D53 /* PluginTests */ = { + isa = PBXNativeTarget; + buildConfigurationList = 50ADFF9F201F53D600D50D53 /* Build configuration list for PBXNativeTarget "PluginTests" */; + buildPhases = ( + 0596884F929ED6F1DE134961 /* [CP] Check Pods Manifest.lock */, + 50ADFF8D201F53D600D50D53 /* Sources */, + 50ADFF8E201F53D600D50D53 /* Frameworks */, + 50ADFF8F201F53D600D50D53 /* Resources */, + 8E97F58B69A94C6503FC9C85 /* [CP] Embed Pods Frameworks */, + ); + buildRules = ( + ); + dependencies = ( + 50ADFF94201F53D600D50D53 /* PBXTargetDependency */, + ); + name = PluginTests; + productName = PluginTests; + productReference = 50ADFF91201F53D600D50D53 /* PluginTests.xctest */; + productType = "com.apple.product-type.bundle.unit-test"; + }; +/* End PBXNativeTarget section */ + +/* Begin PBXProject section */ + 50ADFF7F201F53D600D50D53 /* Project object */ = { + isa = PBXProject; + attributes = { + LastSwiftUpdateCheck = 0920; + LastUpgradeCheck = 1160; + ORGANIZATIONNAME = "Max Lynch"; + TargetAttributes = { + 50ADFF87201F53D600D50D53 = { + CreatedOnToolsVersion = 9.2; + LastSwiftMigration = 1100; + ProvisioningStyle = Automatic; + }; + 50ADFF90201F53D600D50D53 = { + CreatedOnToolsVersion = 9.2; + LastSwiftMigration = 1100; + ProvisioningStyle = Automatic; + }; + }; + }; + buildConfigurationList = 50ADFF82201F53D600D50D53 /* Build configuration list for PBXProject "Plugin" */; + compatibilityVersion = "Xcode 8.0"; + developmentRegion = en; + hasScannedForEncodings = 0; + knownRegions = ( + en, + Base, + ); + mainGroup = 50ADFF7E201F53D600D50D53; + productRefGroup = 50ADFF89201F53D600D50D53 /* Products */; + projectDirPath = ""; + projectRoot = ""; + targets = ( + 50ADFF87201F53D600D50D53 /* Plugin */, + 50ADFF90201F53D600D50D53 /* PluginTests */, + ); + }; +/* End PBXProject section */ + +/* Begin PBXResourcesBuildPhase section */ + 50ADFF86201F53D600D50D53 /* Resources */ = { + isa = PBXResourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 50ADFF8F201F53D600D50D53 /* Resources */ = { + isa = PBXResourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXResourcesBuildPhase section */ + +/* Begin PBXShellScriptBuildPhase section */ + 0596884F929ED6F1DE134961 /* [CP] Check Pods Manifest.lock */ = { + isa = PBXShellScriptBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + inputPaths = ( + "${PODS_PODFILE_DIR_PATH}/Podfile.lock", + "${PODS_ROOT}/Manifest.lock", + ); + name = "[CP] Check Pods Manifest.lock"; + outputPaths = ( + "$(DERIVED_FILE_DIR)/Pods-PluginTests-checkManifestLockResult.txt", + ); + runOnlyForDeploymentPostprocessing = 0; + shellPath = /bin/sh; + shellScript = "diff \"${PODS_PODFILE_DIR_PATH}/Podfile.lock\" \"${PODS_ROOT}/Manifest.lock\" > /dev/null\nif [ $? != 0 ] ; then\n # print error to STDERR\n echo \"error: The sandbox is not in sync with the Podfile.lock. Run 'pod install' or update your CocoaPods installation.\" >&2\n exit 1\nfi\n# This output is used by Xcode 'outputs' to avoid re-running this script phase.\necho \"SUCCESS\" > \"${SCRIPT_OUTPUT_FILE_0}\"\n"; + showEnvVarsInLog = 0; + }; + 8E97F58B69A94C6503FC9C85 /* [CP] Embed Pods Frameworks */ = { + isa = PBXShellScriptBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + inputPaths = ( + "${PODS_ROOT}/Target Support Files/Pods-PluginTests/Pods-PluginTests-frameworks.sh", + "${BUILT_PRODUCTS_DIR}/Capacitor/Capacitor.framework", + "${BUILT_PRODUCTS_DIR}/CapacitorCordova/Cordova.framework", + ); + name = "[CP] Embed Pods Frameworks"; + outputPaths = ( + "${TARGET_BUILD_DIR}/${FRAMEWORKS_FOLDER_PATH}/Capacitor.framework", + "${TARGET_BUILD_DIR}/${FRAMEWORKS_FOLDER_PATH}/Cordova.framework", + ); + runOnlyForDeploymentPostprocessing = 0; + shellPath = /bin/sh; + shellScript = "\"${PODS_ROOT}/Target Support Files/Pods-PluginTests/Pods-PluginTests-frameworks.sh\"\n"; + showEnvVarsInLog = 0; + }; + AB5B3E54B4E897F32C2279DA /* [CP] Check Pods Manifest.lock */ = { + isa = PBXShellScriptBuildPhase; + buildActionMask = 2147483647; + files = ( + ); + inputPaths = ( + "${PODS_PODFILE_DIR_PATH}/Podfile.lock", + "${PODS_ROOT}/Manifest.lock", + ); + name = "[CP] Check Pods Manifest.lock"; + outputPaths = ( + "$(DERIVED_FILE_DIR)/Pods-Plugin-checkManifestLockResult.txt", + ); + runOnlyForDeploymentPostprocessing = 0; + shellPath = /bin/sh; + shellScript = "diff \"${PODS_PODFILE_DIR_PATH}/Podfile.lock\" \"${PODS_ROOT}/Manifest.lock\" > /dev/null\nif [ $? != 0 ] ; then\n # print error to STDERR\n echo \"error: The sandbox is not in sync with the Podfile.lock. Run 'pod install' or update your CocoaPods installation.\" >&2\n exit 1\nfi\n# This output is used by Xcode 'outputs' to avoid re-running this script phase.\necho \"SUCCESS\" > \"${SCRIPT_OUTPUT_FILE_0}\"\n"; + showEnvVarsInLog = 0; + }; +/* End PBXShellScriptBuildPhase section */ + +/* Begin PBXSourcesBuildPhase section */ + 50ADFF83201F53D600D50D53 /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 50E1A94820377CB70090CE1A /* GeolocationPlugin.swift in Sources */, + 50ADFFA82020EE4F00D50D53 /* GeolocationPlugin.m in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; + 50ADFF8D201F53D600D50D53 /* Sources */ = { + isa = PBXSourcesBuildPhase; + buildActionMask = 2147483647; + files = ( + 50ADFF97201F53D600D50D53 /* GeolocationPluginTests.swift in Sources */, + ); + runOnlyForDeploymentPostprocessing = 0; + }; +/* End PBXSourcesBuildPhase section */ + +/* Begin PBXTargetDependency section */ + 50ADFF94201F53D600D50D53 /* PBXTargetDependency */ = { + isa = PBXTargetDependency; + target = 50ADFF87201F53D600D50D53 /* Plugin */; + targetProxy = 50ADFF93201F53D600D50D53 /* PBXContainerItemProxy */; + }; +/* End PBXTargetDependency section */ + +/* Begin XCBuildConfiguration section */ + 50ADFF9A201F53D600D50D53 /* Debug */ = { + isa = XCBuildConfiguration; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + CLANG_ANALYZER_NONNULL = YES; + CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE; + CLANG_CXX_LANGUAGE_STANDARD = "gnu++14"; + CLANG_CXX_LIBRARY = "libc++"; + CLANG_ENABLE_MODULES = YES; + CLANG_ENABLE_OBJC_ARC = YES; + CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; + CLANG_WARN_BOOL_CONVERSION = YES; + CLANG_WARN_COMMA = YES; + CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; + CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; + CLANG_WARN_DOCUMENTATION_COMMENTS = YES; + CLANG_WARN_EMPTY_BODY = YES; + CLANG_WARN_ENUM_CONVERSION = YES; + CLANG_WARN_INFINITE_RECURSION = YES; + CLANG_WARN_INT_CONVERSION = YES; + CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES; + CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; + CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; + CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; + CLANG_WARN_STRICT_PROTOTYPES = YES; + CLANG_WARN_SUSPICIOUS_MOVE = YES; + CLANG_WARN_UNGUARDED_AVAILABILITY = YES_AGGRESSIVE; + CLANG_WARN_UNREACHABLE_CODE = YES; + CLANG_WARN__DUPLICATE_METHOD_MATCH = YES; + CODE_SIGN_IDENTITY = "iPhone Developer"; + COPY_PHASE_STRIP = NO; + CURRENT_PROJECT_VERSION = 1; + DEBUG_INFORMATION_FORMAT = dwarf; + ENABLE_STRICT_OBJC_MSGSEND = YES; + ENABLE_TESTABILITY = YES; + FRAMEWORK_SEARCH_PATHS = ( + "\"${BUILT_PRODUCTS_DIR}/Capacitor\"", + "\"${BUILT_PRODUCTS_DIR}/CapacitorCordova\"", + ); + GCC_C_LANGUAGE_STANDARD = gnu11; + GCC_DYNAMIC_NO_PIC = NO; + GCC_NO_COMMON_BLOCKS = YES; + GCC_OPTIMIZATION_LEVEL = 0; + GCC_PREPROCESSOR_DEFINITIONS = ( + "DEBUG=1", + "$(inherited)", + ); + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; + GCC_WARN_UNDECLARED_SELECTOR = YES; + GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; + GCC_WARN_UNUSED_FUNCTION = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + IPHONEOS_DEPLOYMENT_TARGET = 11.0; + MTL_ENABLE_DEBUG_INFO = YES; + ONLY_ACTIVE_ARCH = YES; + SDKROOT = iphoneos; + SWIFT_ACTIVE_COMPILATION_CONDITIONS = DEBUG; + SWIFT_OPTIMIZATION_LEVEL = "-Onone"; + VERSIONING_SYSTEM = "apple-generic"; + VERSION_INFO_PREFIX = ""; + }; + name = Debug; + }; + 50ADFF9B201F53D600D50D53 /* Release */ = { + isa = XCBuildConfiguration; + buildSettings = { + ALWAYS_SEARCH_USER_PATHS = NO; + CLANG_ANALYZER_NONNULL = YES; + CLANG_ANALYZER_NUMBER_OBJECT_CONVERSION = YES_AGGRESSIVE; + CLANG_CXX_LANGUAGE_STANDARD = "gnu++14"; + CLANG_CXX_LIBRARY = "libc++"; + CLANG_ENABLE_MODULES = YES; + CLANG_ENABLE_OBJC_ARC = YES; + CLANG_WARN_BLOCK_CAPTURE_AUTORELEASING = YES; + CLANG_WARN_BOOL_CONVERSION = YES; + CLANG_WARN_COMMA = YES; + CLANG_WARN_CONSTANT_CONVERSION = YES; + CLANG_WARN_DEPRECATED_OBJC_IMPLEMENTATIONS = YES; + CLANG_WARN_DIRECT_OBJC_ISA_USAGE = YES_ERROR; + CLANG_WARN_DOCUMENTATION_COMMENTS = YES; + CLANG_WARN_EMPTY_BODY = YES; + CLANG_WARN_ENUM_CONVERSION = YES; + CLANG_WARN_INFINITE_RECURSION = YES; + CLANG_WARN_INT_CONVERSION = YES; + CLANG_WARN_NON_LITERAL_NULL_CONVERSION = YES; + CLANG_WARN_OBJC_IMPLICIT_RETAIN_SELF = YES; + CLANG_WARN_OBJC_LITERAL_CONVERSION = YES; + CLANG_WARN_OBJC_ROOT_CLASS = YES_ERROR; + CLANG_WARN_RANGE_LOOP_ANALYSIS = YES; + CLANG_WARN_STRICT_PROTOTYPES = YES; + CLANG_WARN_SUSPICIOUS_MOVE = YES; + CLANG_WARN_UNGUARDED_AVAILABILITY = YES_AGGRESSIVE; + CLANG_WARN_UNREACHABLE_CODE = YES; + CLANG_WARN__DUPLICATE_METHOD_MATCH = YES; + CODE_SIGN_IDENTITY = "iPhone Developer"; + COPY_PHASE_STRIP = NO; + CURRENT_PROJECT_VERSION = 1; + DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym"; + ENABLE_NS_ASSERTIONS = NO; + ENABLE_STRICT_OBJC_MSGSEND = YES; + FRAMEWORK_SEARCH_PATHS = ( + "\"${BUILT_PRODUCTS_DIR}/Capacitor\"", + "\"${BUILT_PRODUCTS_DIR}/CapacitorCordova\"", + ); + GCC_C_LANGUAGE_STANDARD = gnu11; + GCC_NO_COMMON_BLOCKS = YES; + GCC_WARN_64_TO_32_BIT_CONVERSION = YES; + GCC_WARN_ABOUT_RETURN_TYPE = YES_ERROR; + GCC_WARN_UNDECLARED_SELECTOR = YES; + GCC_WARN_UNINITIALIZED_AUTOS = YES_AGGRESSIVE; + GCC_WARN_UNUSED_FUNCTION = YES; + GCC_WARN_UNUSED_VARIABLE = YES; + IPHONEOS_DEPLOYMENT_TARGET = 11.0; + MTL_ENABLE_DEBUG_INFO = NO; + SDKROOT = iphoneos; + SWIFT_OPTIMIZATION_LEVEL = "-Owholemodule"; + VALIDATE_PRODUCT = YES; + VERSIONING_SYSTEM = "apple-generic"; + VERSION_INFO_PREFIX = ""; + }; + name = Release; + }; + 50ADFF9D201F53D600D50D53 /* Debug */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 5E23F77F099397094342571A /* Pods-Plugin.debug.xcconfig */; + buildSettings = { + CLANG_ENABLE_MODULES = YES; + CODE_SIGN_IDENTITY = ""; + CODE_SIGN_STYLE = Automatic; + DEFINES_MODULE = YES; + DYLIB_COMPATIBILITY_VERSION = 1; + DYLIB_CURRENT_VERSION = 1; + DYLIB_INSTALL_NAME_BASE = "@rpath"; + INFOPLIST_FILE = Plugin/Info.plist; + INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks"; + IPHONEOS_DEPLOYMENT_TARGET = 11.0; + LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks $(FRAMEWORK_SEARCH_PATHS)\n$(FRAMEWORK_SEARCH_PATHS)\n$(FRAMEWORK_SEARCH_PATHS)"; + ONLY_ACTIVE_ARCH = YES; + PRODUCT_BUNDLE_IDENTIFIER = com.getcapacitor.Plugin; + PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)"; + SKIP_INSTALL = YES; + SWIFT_OPTIMIZATION_LEVEL = "-Onone"; + SWIFT_VERSION = 5.0; + TARGETED_DEVICE_FAMILY = "1,2"; + }; + name = Debug; + }; + 50ADFF9E201F53D600D50D53 /* Release */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 91781294A431A2A7CC6EB714 /* Pods-Plugin.release.xcconfig */; + buildSettings = { + CLANG_ENABLE_MODULES = YES; + CODE_SIGN_IDENTITY = ""; + CODE_SIGN_STYLE = Automatic; + DEFINES_MODULE = YES; + DYLIB_COMPATIBILITY_VERSION = 1; + DYLIB_CURRENT_VERSION = 1; + DYLIB_INSTALL_NAME_BASE = "@rpath"; + INFOPLIST_FILE = Plugin/Info.plist; + INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks"; + IPHONEOS_DEPLOYMENT_TARGET = 11.0; + LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks $(FRAMEWORK_SEARCH_PATHS)"; + ONLY_ACTIVE_ARCH = NO; + PRODUCT_BUNDLE_IDENTIFIER = com.getcapacitor.Plugin; + PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)"; + SKIP_INSTALL = YES; + SWIFT_VERSION = 5.0; + TARGETED_DEVICE_FAMILY = "1,2"; + }; + name = Release; + }; + 50ADFFA0201F53D600D50D53 /* Debug */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = 96ED1B6440D6672E406C8D19 /* Pods-PluginTests.debug.xcconfig */; + buildSettings = { + CODE_SIGN_STYLE = Automatic; + INFOPLIST_FILE = PluginTests/Info.plist; + LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks"; + PRODUCT_BUNDLE_IDENTIFIER = com.getcapacitor.PluginTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_VERSION = 5.0; + TARGETED_DEVICE_FAMILY = "1,2"; + }; + name = Debug; + }; + 50ADFFA1201F53D600D50D53 /* Release */ = { + isa = XCBuildConfiguration; + baseConfigurationReference = F65BB2953ECE002E1EF3E424 /* Pods-PluginTests.release.xcconfig */; + buildSettings = { + CODE_SIGN_STYLE = Automatic; + INFOPLIST_FILE = PluginTests/Info.plist; + LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks"; + PRODUCT_BUNDLE_IDENTIFIER = com.getcapacitor.PluginTests; + PRODUCT_NAME = "$(TARGET_NAME)"; + SWIFT_VERSION = 5.0; + TARGETED_DEVICE_FAMILY = "1,2"; + }; + name = Release; + }; +/* End XCBuildConfiguration section */ + +/* Begin XCConfigurationList section */ + 50ADFF82201F53D600D50D53 /* Build configuration list for PBXProject "Plugin" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 50ADFF9A201F53D600D50D53 /* Debug */, + 50ADFF9B201F53D600D50D53 /* Release */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 50ADFF9C201F53D600D50D53 /* Build configuration list for PBXNativeTarget "Plugin" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 50ADFF9D201F53D600D50D53 /* Debug */, + 50ADFF9E201F53D600D50D53 /* Release */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; + 50ADFF9F201F53D600D50D53 /* Build configuration list for PBXNativeTarget "PluginTests" */ = { + isa = XCConfigurationList; + buildConfigurations = ( + 50ADFFA0201F53D600D50D53 /* Debug */, + 50ADFFA1201F53D600D50D53 /* Release */, + ); + defaultConfigurationIsVisible = 0; + defaultConfigurationName = Release; + }; +/* End XCConfigurationList section */ + }; + rootObject = 50ADFF7F201F53D600D50D53 /* Project object */; +} diff --git a/geolocation/ios/Plugin.xcodeproj/project.xcworkspace/contents.xcworkspacedata b/geolocation/ios/Plugin.xcodeproj/project.xcworkspace/contents.xcworkspacedata new file mode 100644 index 000000000..919434a62 --- /dev/null +++ b/geolocation/ios/Plugin.xcodeproj/project.xcworkspace/contents.xcworkspacedata @@ -0,0 +1,7 @@ + + + + + diff --git a/geolocation/ios/Plugin.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/geolocation/ios/Plugin.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist new file mode 100644 index 000000000..18d981003 --- /dev/null +++ b/geolocation/ios/Plugin.xcodeproj/project.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist @@ -0,0 +1,8 @@ + + + + + IDEDidComputeMac32BitWarning + + + diff --git a/geolocation/ios/Plugin.xcodeproj/xcshareddata/xcschemes/Plugin.xcscheme b/geolocation/ios/Plugin.xcodeproj/xcshareddata/xcschemes/Plugin.xcscheme new file mode 100644 index 000000000..303f2621b --- /dev/null +++ b/geolocation/ios/Plugin.xcodeproj/xcshareddata/xcschemes/Plugin.xcscheme @@ -0,0 +1,77 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/geolocation/ios/Plugin.xcodeproj/xcshareddata/xcschemes/PluginTests.xcscheme b/geolocation/ios/Plugin.xcodeproj/xcshareddata/xcschemes/PluginTests.xcscheme new file mode 100644 index 000000000..3d8c88d25 --- /dev/null +++ b/geolocation/ios/Plugin.xcodeproj/xcshareddata/xcschemes/PluginTests.xcscheme @@ -0,0 +1,68 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/geolocation/ios/Plugin.xcworkspace/contents.xcworkspacedata b/geolocation/ios/Plugin.xcworkspace/contents.xcworkspacedata new file mode 100644 index 000000000..afad624ec --- /dev/null +++ b/geolocation/ios/Plugin.xcworkspace/contents.xcworkspacedata @@ -0,0 +1,10 @@ + + + + + + + diff --git a/geolocation/ios/Plugin.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist b/geolocation/ios/Plugin.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist new file mode 100644 index 000000000..18d981003 --- /dev/null +++ b/geolocation/ios/Plugin.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist @@ -0,0 +1,8 @@ + + + + + IDEDidComputeMac32BitWarning + + + diff --git a/geolocation/ios/Plugin/GeolocationPlugin.h b/geolocation/ios/Plugin/GeolocationPlugin.h new file mode 100644 index 000000000..f2bd9e0bb --- /dev/null +++ b/geolocation/ios/Plugin/GeolocationPlugin.h @@ -0,0 +1,10 @@ +#import + +//! 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 + diff --git a/geolocation/ios/Plugin/GeolocationPlugin.m b/geolocation/ios/Plugin/GeolocationPlugin.m new file mode 100644 index 000000000..9f2fd9fe5 --- /dev/null +++ b/geolocation/ios/Plugin/GeolocationPlugin.m @@ -0,0 +1,12 @@ +#import +#import + +// Define the plugin using the CAP_PLUGIN Macro, and +// each method the plugin supports using the CAP_PLUGIN_METHOD macro. +CAP_PLUGIN(GeolocationPlugin, "Geolocation", + CAP_PLUGIN_METHOD(getCurrentPosition, CAPPluginReturnPromise); + CAP_PLUGIN_METHOD(watchPosition, CAPPluginReturnCallback); + CAP_PLUGIN_METHOD(clearWatch, CAPPluginReturnPromise); + CAP_PLUGIN_METHOD(checkPermissions, CAPPluginReturnPromise); + CAP_PLUGIN_METHOD(requestPermissions, CAPPluginReturnPromise); +) diff --git a/geolocation/ios/Plugin/GeolocationPlugin.swift b/geolocation/ios/Plugin/GeolocationPlugin.swift new file mode 100644 index 000000000..359db27fb --- /dev/null +++ b/geolocation/ios/Plugin/GeolocationPlugin.swift @@ -0,0 +1,212 @@ +import Foundation +import CoreLocation +import UIKit +import Capacitor + +@objc(GeolocationPlugin) +public class GeolocationPlugin: CAPPlugin, CLLocationManagerDelegate { + + enum CallType { + case permissions + case singleUpdate + case watch + } + + var locationManager = CLLocationManager() + private var isUpdatingLocation: Bool = false + private var callQueue: [String: CallType] = [:] + + @objc func getCurrentPosition(_ call: CAPPluginCall) { + call.save() + callQueue[call.callbackId] = .singleUpdate + + DispatchQueue.main.async { + self.locationManager.delegate = self + + if call.getBool("enableHighAccuracy", false) == true { + self.locationManager.desiredAccuracy = kCLLocationAccuracyBest + } else { + self.locationManager.desiredAccuracy = kCLLocationAccuracyThreeKilometers + } + + if CLLocationManager.authorizationStatus() == .notDetermined { + self.locationManager.requestWhenInUseAuthorization() + } else { + self.locationManager.requestLocation() + } + } + } + + @objc func watchPosition(_ call: CAPPluginCall) { + call.save() + callQueue[call.callbackId] = .watch + + DispatchQueue.main.async { + self.locationManager.delegate = self + + if call.getBool("enableHighAccuracy", false) == true { + self.locationManager.desiredAccuracy = kCLLocationAccuracyBestForNavigation + } else { + self.locationManager.desiredAccuracy = kCLLocationAccuracyThreeKilometers + } + + if CLLocationManager.authorizationStatus() == .notDetermined { + self.locationManager.requestWhenInUseAuthorization() + } else { + self.locationManager.startUpdatingLocation() + self.isUpdatingLocation = true + } + } + } + + @objc func clearWatch(_ call: CAPPluginCall) { + guard let callbackId = call.getString("id") else { + call.reject("Watch call id must be provided") + return + } + + if let savedCall = bridge?.getSavedCall(callbackId) { + bridge?.releaseCall(savedCall) + + self.stopUpdating() + } + + callQueue.removeValue(forKey: callbackId) + + call.resolve() + } + + public func locationManager(_ manager: CLLocationManager, didFailWithError error: Error) { + let removalQueue = callQueue.filter { $0.value == .permissions || $0.value == .singleUpdate } + callQueue = callQueue.filter { $0.value == .watch } + + for (id, _) in removalQueue { + if let call = bridge?.getSavedCall(id) { + call.reject(error.localizedDescription) + bridge?.releaseCall(call) + } + } + + for (id, _) in callQueue { + if let call = bridge?.getSavedCall(id) { + call.reject(error.localizedDescription) + } + } + } + + public func locationManager(_ manager: CLLocationManager, didUpdateLocations locations: [CLLocation]) { + let removalQueue = callQueue.filter { $0.value == .singleUpdate } + callQueue = callQueue.filter { $0.value != .singleUpdate } + + for (id, _) in removalQueue { + if let call = bridge?.getSavedCall(id) { + reportLocation(call, locations) + bridge?.releaseCall(call) + } + } + + for (id, callType) in callQueue { + if let call = bridge?.getSavedCall(id), callType == .watch { + reportLocation(call, locations) + } + } + } + + public func locationManager(_ manager: CLLocationManager, didChangeAuthorization status: CLAuthorizationStatus) { + let removalQueue = callQueue.filter { $0.value == .permissions } + callQueue = callQueue.filter { $0.value != .permissions } + + for (id, _) in removalQueue { + if let call = bridge?.getSavedCall(id) { + checkPermissions(call) + bridge?.releaseCall(call) + } + } + + if !(callQueue.filter({ $0.value == .singleUpdate }).isEmpty) { + self.locationManager.requestLocation() + } + + if !(callQueue.filter({ $0.value == .watch }).isEmpty) && !self.isUpdatingLocation { + self.locationManager.startUpdatingLocation() + self.isUpdatingLocation = true + } + } + + public func stopUpdating() { + self.locationManager.stopUpdatingLocation() + self.isUpdatingLocation = false + } + + private func reportLocation(_ call: CAPPluginCall, _ locations: [CLLocation]) { + if let location = locations.first { + let result = makePosition(location) + call.resolve(result) + } else { + // TODO: Handle case where location is nil + call.resolve() + } + } + + @objc override public func checkPermissions(_ call: CAPPluginCall) { + var status: String = "" + + if CLLocationManager.locationServicesEnabled() { + switch CLLocationManager.authorizationStatus() { + case .notDetermined: + status = "prompt" + case .restricted, .denied: + status = "denied" + case .authorizedAlways, .authorizedWhenInUse: + status = "granted" + @unknown default: + status = "prompt" + } + } else { + call.reject("Location services are not enabled") + return + } + + let result = [ + "location": status + ] + + call.resolve(result) + } + + @objc override public func requestPermissions(_ call: CAPPluginCall) { + if CLLocationManager.locationServicesEnabled() { + // If state is not yet determined, request perms. + // Otherwise, report back the state right away + if CLLocationManager.authorizationStatus() == .notDetermined { + call.save() + callQueue[call.callbackId] = .permissions + + DispatchQueue.main.async { + self.locationManager.delegate = self + self.locationManager.requestWhenInUseAuthorization() + } + } else { + checkPermissions(call) + } + } else { + call.reject("Location services are not enabled") + } + } + + func makePosition(_ location: CLLocation) -> JSObject { + var ret = JSObject() + var coords = JSObject() + coords["latitude"] = location.coordinate.latitude + coords["longitude"] = location.coordinate.longitude + coords["accuracy"] = location.horizontalAccuracy + coords["altitude"] = location.altitude + coords["altitudeAccuracy"] = location.verticalAccuracy + coords["speed"] = location.speed + coords["heading"] = location.course + ret["timestamp"] = Int((location.timestamp.timeIntervalSince1970 * 1000)) + ret["coords"] = coords + return ret + } + +} diff --git a/geolocation/ios/Plugin/Info.plist b/geolocation/ios/Plugin/Info.plist new file mode 100644 index 000000000..1007fd9dd --- /dev/null +++ b/geolocation/ios/Plugin/Info.plist @@ -0,0 +1,24 @@ + + + + + CFBundleDevelopmentRegion + $(DEVELOPMENT_LANGUAGE) + CFBundleExecutable + $(EXECUTABLE_NAME) + CFBundleIdentifier + $(PRODUCT_BUNDLE_IDENTIFIER) + CFBundleInfoDictionaryVersion + 6.0 + CFBundleName + $(PRODUCT_NAME) + CFBundlePackageType + FMWK + CFBundleShortVersionString + 1.0 + CFBundleVersion + $(CURRENT_PROJECT_VERSION) + NSPrincipalClass + + + diff --git a/geolocation/ios/PluginTests/GeolocationPluginTests.swift b/geolocation/ios/PluginTests/GeolocationPluginTests.swift new file mode 100644 index 000000000..86b5cfaae --- /dev/null +++ b/geolocation/ios/PluginTests/GeolocationPluginTests.swift @@ -0,0 +1,14 @@ +import XCTest +@testable import Plugin + +class GeolocationTests: XCTestCase { + override func setUp() { + super.setUp() + // Put setup code here. This method is called before the invocation of each test method in the class. + } + + override func tearDown() { + // Put teardown code here. This method is called after the invocation of each test method in the class. + super.tearDown() + } +} diff --git a/geolocation/ios/PluginTests/Info.plist b/geolocation/ios/PluginTests/Info.plist new file mode 100644 index 000000000..6c40a6cd0 --- /dev/null +++ b/geolocation/ios/PluginTests/Info.plist @@ -0,0 +1,22 @@ + + + + + CFBundleDevelopmentRegion + $(DEVELOPMENT_LANGUAGE) + CFBundleExecutable + $(EXECUTABLE_NAME) + CFBundleIdentifier + $(PRODUCT_BUNDLE_IDENTIFIER) + CFBundleInfoDictionaryVersion + 6.0 + CFBundleName + $(PRODUCT_NAME) + CFBundlePackageType + BNDL + CFBundleShortVersionString + 1.0 + CFBundleVersion + 1 + + diff --git a/geolocation/ios/Podfile b/geolocation/ios/Podfile new file mode 100644 index 000000000..350751435 --- /dev/null +++ b/geolocation/ios/Podfile @@ -0,0 +1,16 @@ +platform :ios, '11.0' + +def capacitor_pods + # Comment the next line if you're not using Swift and don't want to use dynamic frameworks + use_frameworks! + pod 'Capacitor', :path => '../node_modules/@capacitor/ios' + pod 'CapacitorCordova', :path => '../node_modules/@capacitor/ios' +end + +target 'Plugin' do + capacitor_pods +end + +target 'PluginTests' do + capacitor_pods +end diff --git a/geolocation/package.json b/geolocation/package.json new file mode 100644 index 000000000..713e3e79d --- /dev/null +++ b/geolocation/package.json @@ -0,0 +1,80 @@ +{ + "name": "@capacitor/geolocation", + "version": "0.0.1", + "description": "The Geolocation API provides simple methods for getting and tracking the current position of the device using GPS, along with altitude, heading, and speed information if available.", + "main": "dist/esm/index.js", + "types": "dist/esm/index.d.ts", + "unpkg": "dist/plugin.js", + "files": [ + "android/src/main/", + "android/build.gradle", + "dist/", + "ios/Plugin/", + "CapacitorGeolocation.podspec" + ], + "author": "Ionic ", + "license": "MIT", + "repository": { + "type": "git", + "url": "https://github.com/ionic-team/capacitor-plugins" + }, + "bugs": { + "url": "https://github.com/ionic-team/capacitor-plugins/issues" + }, + "keywords": [ + "capacitor", + "plugin", + "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 -- autocorrect --format", + "eslint": "eslint . --ext ts", + "prettier": "prettier \"**/*.{css,html,ts,js,java}\"", + "swiftlint": "node-swiftlint", + "docgen": "docgen --api GeolocationPlugin --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-alpha.10", + "@capacitor/core": "^3.0.0-alpha.9", + "@capacitor/docgen": "0.0.14", + "@capacitor/ios": "^3.0.0-alpha.9", + "@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.0", + "rollup": "^2.29.0", + "swiftlint": "^1.0.1", + "typescript": "~4.0.3" + }, + "peerDependencies": { + "@capacitor/core": "^3.0.0-alpha.9" + }, + "prettier": "@ionic/prettier-config", + "swiftlint": "@ionic/swiftlint-config", + "eslintConfig": { + "extends": "@ionic/eslint-config/recommended" + }, + "capacitor": { + "ios": { + "src": "ios" + }, + "android": { + "src": "android" + } + }, + "publishConfig": { + "access": "public" + } +} diff --git a/geolocation/rollup.config.js b/geolocation/rollup.config.js new file mode 100644 index 000000000..03fcdf857 --- /dev/null +++ b/geolocation/rollup.config.js @@ -0,0 +1,14 @@ +export default { + input: 'dist/esm/index.js', + output: { + file: 'dist/plugin.js', + format: 'iife', + name: 'capacitorGeolocation', + globals: { + '@capacitor/core': 'capacitorExports', + }, + sourcemap: true, + inlineDynamicImports: true, + }, + external: ['@capacitor/core'], +}; diff --git a/geolocation/src/definitions.ts b/geolocation/src/definitions.ts new file mode 100644 index 000000000..694bfa4d9 --- /dev/null +++ b/geolocation/src/definitions.ts @@ -0,0 +1,154 @@ +import type { PermissionState } from '@capacitor/core'; + +export type CallbackID = string; + +export type GeolocationState = PermissionState; + +export interface GeolocationPermissionStatus { + location: GeolocationState; +} + +export interface GeolocationPlugin { + /** + * Get the current GPS location of the device + * + * @since 1.0.0 + */ + getCurrentPosition( + options?: GeolocationOptions, + ): Promise; + + /** + * Set up a watch for location changes. Note that watching for location changes + * can consume a large amount of energy. Be smart about listening only when you need to. + * + * @since 1.0.0 + */ + watchPosition( + options: GeolocationOptions, + callback: GeolocationWatchCallback, + ): CallbackID; + + /** + * Clear a given watch + * + * @since 1.0.0 + */ + clearWatch(options: { id: string }): Promise; + + /** + * Check location permissions + * + * @since 1.0.0 + */ + checkPermissions(): Promise; + + /** + * Request location permissions + * + * @since 1.0.0 + */ + requestPermissions(): Promise; +} + +export interface GeolocationPosition { + /** + * Creation timestamp for coords + * + * @since 1.0.0 + */ + timestamp: number; + + /** + * The GPS coordinates along with the accuracy of the data + * + * @since 1.0.0 + */ + coords: { + /** + * Latitude in decimal degrees + * + * @since 1.0.0 + */ + latitude: number; + + /** + * longitude in decimal degrees + * + * @since 1.0.0 + */ + longitude: number; + + /** + * Accuracy level of the latitude and longitude coordinates in meters + * + * @since 1.0.0 + */ + accuracy: number; + + /** + * Accuracy level of the altitude coordinate in meters, if available. + * + * Available on all iOS versions and on Android 8.0+. + * + * @since 1.0.0 + */ + altitudeAccuracy: number | null | undefined; + + /** + * The altitude the user is at (if available) + * + * @since 1.0.0 + */ + altitude: number | null; + + /** + * The speed the user is traveling (if available) + * + * @since 1.0.0 + */ + speed: number | null; + + /** + * The heading the user is facing (if available) + * + * @since 1.0.0 + */ + heading: number | null; + }; +} + +export interface GeolocationOptions { + /** + * High accuracy mode (such as GPS, if available) + * + * @default false + * @since 1.0.0 + */ + enableHighAccuracy?: boolean; + + /** + * The maximum wait time in milliseconds for location updates + * + * @default 10000 + * @since 1.0.0 + */ + timeout?: number; + + /** + * The maximum age in milliseconds of a possible cached position that is acceptable to return + * + * @default 0 + * @since 1.0.0 + */ + maximumAge?: number; +} + +export type GeolocationWatchCallback = ( + position: GeolocationPosition | null, + err?: any, +) => void; + +export interface PermissionsRequestResult { + results: any[]; +} diff --git a/geolocation/src/index.ts b/geolocation/src/index.ts new file mode 100644 index 000000000..18e8dd191 --- /dev/null +++ b/geolocation/src/index.ts @@ -0,0 +1,10 @@ +import { registerPlugin } from '@capacitor/core'; + +import type { GeolocationPlugin } from './definitions'; +import { GeolocationPermissionStatus } from './definitions'; + +const Geolocation = registerPlugin('Geolocation', { + web: () => import('./web').then(m => new m.GeolocationWeb()), +}); + +export { Geolocation, GeolocationPermissionStatus }; diff --git a/geolocation/src/util.ts b/geolocation/src/util.ts new file mode 100644 index 000000000..c668dcbc6 --- /dev/null +++ b/geolocation/src/util.ts @@ -0,0 +1,12 @@ +export const extend = (target: any, ...objs: any[]): any => { + objs.forEach(o => { + if (o && typeof o === 'object') { + for (const k in o) { + if (Object.prototype.hasOwnProperty.call(o, k)) { + target[k] = o[k]; + } + } + } + }); + return target; +}; diff --git a/geolocation/src/web.ts b/geolocation/src/web.ts new file mode 100644 index 000000000..182115731 --- /dev/null +++ b/geolocation/src/web.ts @@ -0,0 +1,77 @@ +import { WebPlugin } from '@capacitor/core'; + +import type { + GeolocationPlugin, + GeolocationOptions, + GeolocationPosition, + GeolocationWatchCallback, + GeolocationPermissionStatus, +} from './definitions'; + +export class GeolocationWeb extends WebPlugin implements GeolocationPlugin { + async getCurrentPosition( + options?: GeolocationOptions, + ): Promise { + return new Promise((resolve, reject) => { + navigator.geolocation.getCurrentPosition( + pos => { + resolve(pos); + }, + err => { + reject(err); + }, + { + enableHighAccuracy: false, + timeout: 10000, + maximumAge: 0, + ...options, + }, + ); + }); + } + + watchPosition( + options: GeolocationOptions, + callback: GeolocationWatchCallback, + ): string { + const id = navigator.geolocation.watchPosition( + pos => { + callback(pos); + }, + err => { + callback(null, err); + }, + { + enableHighAccuracy: false, + timeout: 10000, + maximumAge: 0, + ...options, + }, + ); + + return `${id}`; + } + + async clearWatch(options: { id: string }): Promise { + window.navigator.geolocation.clearWatch(parseInt(options.id, 10)); + } + + async checkPermissions(): Promise { + if (typeof navigator === 'undefined' || !navigator.permissions) { + throw this.unavailable('Permissions API not available in this browser'); + } + + const permission = await window.navigator.permissions.query({ + name: 'geolocation', + }); + return { location: permission.state }; + } + + async requestPermissions(): Promise { + throw this.unimplemented('Not implemented on web.'); + } +} + +const Geolocation = new GeolocationWeb(); + +export { Geolocation }; diff --git a/geolocation/tsconfig.json b/geolocation/tsconfig.json new file mode 100644 index 000000000..3bb999d96 --- /dev/null +++ b/geolocation/tsconfig.json @@ -0,0 +1,19 @@ +{ + "compilerOptions": { + "allowUnreachableCode": false, + "declaration": true, + "esModuleInterop": true, + "lib": ["dom"], + "module": "esnext", + "moduleResolution": "node", + "noFallthroughCasesInSwitch": true, + "noUnusedLocals": true, + "noUnusedParameters": true, + "outDir": "dist/esm", + "pretty": true, + "sourceMap": true, + "strict": true, + "target": "es2017" + }, + "files": ["src/index.ts"] +} diff --git a/lerna.json b/lerna.json index 395693b87..1baa3893f 100644 --- a/lerna.json +++ b/lerna.json @@ -8,6 +8,7 @@ "device", "dialog", "filesystem", + "geolocation", "haptics", "keyboard", "motion",