feat: App plugin (#71)

app/.eslintignore

@@ -0,0 +1,2 @@
+build
+dist

app/.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

app/.prettierignore

@@ -0,0 +1,2 @@
+build
+dist

app/CapacitorApp.podspec

@@ -0,0 +1,17 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'CapacitorApp'
+  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

app/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.

app/README.md

@@ -0,0 +1,246 @@
+# @capacitor/app
+
+The App API handles high level App state and events.For example, this API emits events when the app enters and leaves the foreground, handles deeplinks, opens other apps, and manages persisted plugin state.
+
+## Install
+
+```bash
+npm install @capacitor/app
+npx cap sync
+```
+
+## API
+
+<docgen-index>
+
+* [`exitApp()`](#exitapp)
+* [`getInfo()`](#getinfo)
+* [`getState()`](#getstate)
+* [`getLaunchUrl()`](#getlaunchurl)
+* [`addListener(...)`](#addlistener)
+* [`addListener(...)`](#addlistener)
+* [`addListener(...)`](#addlistener)
+* [`addListener(...)`](#addlistener)
+* [`removeAllListeners()`](#removealllisteners)
+* [Interfaces](#interfaces)
+
+</docgen-index>
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+### exitApp()
+
+```typescript
+exitApp() => never
+```
+
+Force exit the app. This should only be used in conjunction with the `backButton` handler for Android to
+exit the app when navigation is complete.
+
+Ionic handles this itself so you shouldn't need to call this if using Ionic.
+
+**Returns:** <code>never</code>
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### getInfo()
+
+```typescript
+getInfo() => Promise<AppInfo>
+```
+
+Return information about the app.
+
+**Returns:** <code>Promise&lt;<a href="#appinfo">AppInfo</a>&gt;</code>
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### getState()
+
+```typescript
+getState() => Promise<AppState>
+```
+
+Gets the current app state.
+
+**Returns:** <code>Promise&lt;<a href="#appstate">AppState</a>&gt;</code>
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### getLaunchUrl()
+
+```typescript
+getLaunchUrl() => Promise<AppLaunchUrl>
+```
+
+Get the URL the app was launched with, if any.
+
+**Returns:** <code>Promise&lt;<a href="#applaunchurl">AppLaunchUrl</a>&gt;</code>
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### addListener(...)
+
+```typescript
+addListener(eventName: 'appStateChange', listenerFunc: (state: AppState) => void) => PluginListenerHandle
+```
+
+Listen for changes in the App's active state (whether the app is in the foreground or background)
+
+| Param              | Type                                                              |
+| ------------------ | ----------------------------------------------------------------- |
+| **`eventName`**    | <code>"appStateChange"</code>                                     |
+| **`listenerFunc`** | <code>(state: <a href="#appstate">AppState</a>) =&gt; void</code> |
+
+**Returns:** <code><a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### addListener(...)
+
+```typescript
+addListener(eventName: 'appUrlOpen', listenerFunc: (data: AppUrlOpen) => void) => PluginListenerHandle
+```
+
+Listen for url open events for the app. This handles both custom URL scheme links as well
+as URLs your app handles (Universal Links on iOS and App Links on Android)
+
+| Param              | Type                                                                 |
+| ------------------ | -------------------------------------------------------------------- |
+| **`eventName`**    | <code>"appUrlOpen"</code>                                            |
+| **`listenerFunc`** | <code>(data: <a href="#appurlopen">AppUrlOpen</a>) =&gt; void</code> |
+
+**Returns:** <code><a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### addListener(...)
+
+```typescript
+addListener(eventName: 'appRestoredResult', listenerFunc: (data: AppRestoredResult) => void) => PluginListenerHandle
+```
+
+If the app was launched with previously persisted plugin call data, such as on Android
+when an activity returns to an app that was closed, this call will return any data
+the app was launched with, converted into the form of a result from a plugin call.
+
+| Param              | Type                                                                               |
+| ------------------ | ---------------------------------------------------------------------------------- |
+| **`eventName`**    | <code>"appRestoredResult"</code>                                                   |
+| **`listenerFunc`** | <code>(data: <a href="#apprestoredresult">AppRestoredResult</a>) =&gt; void</code> |
+
+**Returns:** <code><a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### addListener(...)
+
+```typescript
+addListener(eventName: 'backButton', listenerFunc: () => void) => PluginListenerHandle
+```
+
+Listen for the hardware back button event (Android only). Listening for this event will disable the
+default back button behaviour, so you might want to call `window.history.back()` manually.
+If you want to close the app, call `App.exitApp()`.
+
+| Param              | Type                       |
+| ------------------ | -------------------------- |
+| **`eventName`**    | <code>"backButton"</code>  |
+| **`listenerFunc`** | <code>() =&gt; void</code> |
+
+**Returns:** <code><a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### removeAllListeners()
+
+```typescript
+removeAllListeners() => void
+```
+
+Remove all native listeners for this plugin
+
+**Since:** 1.0.0
+
+--------------------
+
+
+### Interfaces
+
+
+#### AppInfo
+
+| Prop          | Type                | Description                                                                                         | Since |
+| ------------- | ------------------- | --------------------------------------------------------------------------------------------------- | ----- |
+| **`name`**    | <code>string</code> | The name of the app.                                                                                | 1.0.0 |
+| **`id`**      | <code>string</code> | The identifier of the app. On iOS it's the Bundle Identifier. On Android it's the Application ID    | 1.0.0 |
+| **`build`**   | <code>string</code> | The build version. On iOS it's the CFBundleVersion. On Android it's the versionCode.                | 1.0.0 |
+| **`version`** | <code>string</code> | The app version. On iOS it's the CFBundleShortVersionString. On Android it's package's versionName. | 1.0.0 |
+
+
+#### AppState
+
+| Prop           | Type                 | Description                       | Since |
+| -------------- | -------------------- | --------------------------------- | ----- |
+| **`isActive`** | <code>boolean</code> | Whether the app is active or not. | 1.0.0 |
+
+
+#### AppLaunchUrl
+
+| Prop      | Type                | Description                   | Since |
+| --------- | ------------------- | ----------------------------- | ----- |
+| **`url`** | <code>string</code> | The url used to open the app. | 1.0.0 |
+
+
+#### PluginListenerHandle
+
+| Prop         | Type                       |
+| ------------ | -------------------------- |
+| **`remove`** | <code>() =&gt; void</code> |
+
+
+#### AppUrlOpen
+
+| Prop                       | Type                 | Description                                                                                                                                                                        | Since |
+| -------------------------- | -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
+| **`url`**                  | <code>string</code>  | The URL the app was opened with.                                                                                                                                                   | 1.0.0 |
+| **`iosSourceApplication`** | <code>any</code>     | The source application opening the app (iOS only) https://developer.apple.com/documentation/uikit/uiapplicationopenurloptionskey/1623128-sourceapplication                         | 1.0.0 |
+| **`iosOpenInPlace`**       | <code>boolean</code> | Whether the app should open the passed document in-place or must copy it first. https://developer.apple.com/documentation/uikit/uiapplicationopenurloptionskey/1623123-openinplace | 1.0.0 |
+
+
+#### AppRestoredResult
+
+| Prop             | Type                              | Description                                                                                                                                       | Since |
+| ---------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
+| **`pluginId`**   | <code>string</code>               | The pluginId this result corresponds to. For example, `Camera`.                                                                                   | 1.0.0 |
+| **`methodName`** | <code>string</code>               | The methodName this result corresponds to. For example, `getPhoto`                                                                                | 1.0.0 |
+| **`data`**       | <code>any</code>                  | The result data passed from the plugin. This would be the result you'd expect from normally calling the plugin method. For example, `CameraPhoto` | 1.0.0 |
+| **`success`**    | <code>boolean</code>              | Boolean indicating if the plugin call succeeded.                                                                                                  | 1.0.0 |
+| **`error`**      | <code>{ message: string; }</code> | If the plugin call didn't succeed, it will contain the error message.                                                                             | 1.0.0 |
+
+</docgen-api>

app/android/.gitignore

@@ -0,0 +1 @@
+/build