@capgo/capacitor-updater 3.0.3

package/README.md

@@ -0,0 +1,456 @@
+# capacitor-updater
+
+Update capacitor app withtout store review.
+
+You have 3 ways possible :
+- use [capgo.app](https://capgo.app) a full featured auto update system in 5 min Setup, to manage version, update, revert and see stats.
+- use your own server update with auto update system
+- use manual methods to zip, upload, download, from JS to do it when you want.
+
+
+## Community
+Join the [discord](https://discord.gg/VnYRvBfgA6) to get help.
+
+## Documentation
+I maintain a more user friendly and complete [documentation](https://github.com/Cap-go/capacitor-updater/wiki) in GitHub wiki.
+
+## install plugin
+
+```bash
+npm install capacitor-updater
+npx cap sync
+```
+
+## Auto update setup
+
+Create account in [capgo.app](https://capgo.app) and get your [API key](https://capgo.app/app/apikeys)
+- Download the CLI `npm i -g capgo`
+- Add app from CLI `capgo add -a API_KEY`
+- Upload app `capgo upload -a API_KEY`
+- Upload app `capgo set -a API_KEY -s public`
+- Edit your `capacitor.config.json` like below, set `autoUpdate` to true.
+```json
+// capacitor.config.json
+{
+	"appId": "**.***.**",
+	"appName": "Name",
+	"plugins": {
+		"CapacitorUpdater": {
+			"autoUpdate": true,
+		}
+	}
+}
+```
+- Add to your main code
+```javascript
+  import { CapacitorUpdater } from 'capacitor-updater'
+  CapacitorUpdater.notifyAppReady()
+  // To let auto update know you app boot well.
+```
+
+- Do `npm run build && npx cap copy` to copy the build to capacitor.
+- Run the app and see app auto update after each backgrounding.
+- If update fail it will roolback to previous version.
+
+See more there in the [Auto update](
+https://doc.capgo.app/Auto-update-2cf9edda70484d7fa57111ab9c435d08) documentation.
+
+
+## Manual setup
+
+Download app update from url when user enter the app
+install it when user background the app.
+
+In your main code :
+
+```javascript
+  import { CapacitorUpdater } from 'capacitor-updater'
+  import { SplashScreen } from '@capacitor/splash-screen'
+  import { App } from '@capacitor/app'
+
+  let version = ""
+  App.addListener('appStateChange', async(state) => {
+      if (state.isActive) {
+        // Do the download during user active app time to prevent failed download
+        version = await CapacitorUpdater.download({
+        url: 'https://github.com/Cap-go/demo-app/releases/download/0.0.4/dist.zip',
+        })
+      }
+      if (!state.isActive && version !== "") {
+        // Do the switch when user leave app
+        SplashScreen.show()
+        try {
+          await CapacitorUpdater.set(version)
+        } catch () {
+          SplashScreen.hide() // in case the set fail, otherwise the new app will have to hide it
+        }
+      }
+  })
+
+  // or do it when click on button
+  const updateNow = async () => {
+    const version = await CapacitorUpdater.download({
+      url: 'https://github.com/Cap-go/demo-app/releases/download/0.0.4/dist.zip',
+    })
+    // show the splashscreen to let the update happen
+    SplashScreen.show()
+    await CapacitorUpdater.set(version)
+    SplashScreen.hide() // in case the set fail, otherwise the new app will have to hide it
+  }
+```
+
+*Be extra carufull for your update* if you send a broken update, the app will crash until the user reinstalls it.
+
+If you need more secure way to update your app, you can use Auto update system.
+
+You can list the version and manage it with the command below.
+
+### Packaging `dist.zip`
+
+Whatever you choose to name the file you download from your release/update server URL, the zip file should contain the full contents of your production Capacitor build output folder, usually `{project directory}/dist/` or `{project directory}/www/`. This is where `index.html` will be located, and it should also contain all bundled JavaScript, CSS, and web resources necessary for your app to run.
+
+Do not password encrypt this file, or it will fail to unpack.
+
+## API
+
+<docgen-index>
+
+* [`download(...)`](#download)
+* [`set(...)`](#set)
+* [`getId()`](#getid)
+* [`delete(...)`](#delete)
+* [`list()`](#list)
+* [`reset(...)`](#reset)
+* [`current()`](#current)
+* [`reload()`](#reload)
+* [`versionName()`](#versionname)
+* [`notifyAppReady()`](#notifyappready)
+* [`delayUpdate()`](#delayupdate)
+* [`cancelDelay()`](#canceldelay)
+* [`addListener('download', ...)`](#addlistenerdownload)
+* [`addListener('majorAvailable', ...)`](#addlistenermajoravailable)
+* [`addListener('updateAvailable', ...)`](#addlistenerupdateavailable)
+* [`addListener(string, ...)`](#addlistenerstring)
+* [`removeAllListeners()`](#removealllisteners)
+* [Interfaces](#interfaces)
+* [Type Aliases](#type-aliases)
+
+</docgen-index>
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+### download(...)
+
+```typescript
+download(options: { url: string; }) => Promise<{ version: string; }>
+```
+
+Download a new version from the provided URL, it should be a zip file, with files inside or with a unique folder inside with all your files
+
+| Param         | Type                          |
+| ------------- | ----------------------------- |
+| **`options`** | <code>{ url: string; }</code> |
+
+**Returns:** <code>Promise&lt;{ version: string; }&gt;</code>
+
+--------------------
+
+
+### set(...)
+
+```typescript
+set(options: { version: string; versionName?: string; }) => Promise<void>
+```
+
+Set version as current version, set will return an error if there are is no index.html file inside the version folder. `versionName` is optional and it's a custom value that will be saved for you
+
+| Param         | Type                                                    |
+| ------------- | ------------------------------------------------------- |
+| **`options`** | <code>{ version: string; versionName?: string; }</code> |
+
+--------------------
+
+
+### getId()
+
+```typescript
+getId() => Promise<{ id: string; }>
+```
+
+Get unique ID used to identify device into auto update server
+
+**Returns:** <code>Promise&lt;{ id: string; }&gt;</code>
+
+--------------------
+
+
+### delete(...)
+
+```typescript
+delete(options: { version: string; }) => Promise<void>
+```
+
+Delete version in storage
+
+| Param         | Type                              |
+| ------------- | --------------------------------- |
+| **`options`** | <code>{ version: string; }</code> |
+
+--------------------
+
+
+### list()
+
+```typescript
+list() => Promise<{ versions: string[]; }>
+```
+
+Get all available versions
+
+**Returns:** <code>Promise&lt;{ versions: string[]; }&gt;</code>
+
+--------------------
+
+
+### reset(...)
+
+```typescript
+reset(options?: { toAutoUpdate?: boolean | undefined; } | undefined) => Promise<void>
+```
+
+Set the `builtin` version (the one sent to Apple store / Google play store ) as current version
+
+| Param         | Type                                     |
+| ------------- | ---------------------------------------- |
+| **`options`** | <code>{ toAutoUpdate?: boolean; }</code> |
+
+--------------------
+
+
+### current()
+
+```typescript
+current() => Promise<{ current: string; currentNative: string; }>
+```
+
+Get the current version, if none are set it returns `builtin`, currentNative is the original version install on the device
+
+**Returns:** <code>Promise&lt;{ current: string; currentNative: string; }&gt;</code>
+
+--------------------
+
+
+### reload()
+
+```typescript
+reload() => Promise<void>
+```
+
+Reload the view
+
+--------------------
+
+
+### versionName()
+
+```typescript
+versionName() => Promise<{ versionName: string; }>
+```
+
+Get the version name, if it was set during the set phase
+
+**Returns:** <code>Promise&lt;{ versionName: string; }&gt;</code>
+
+--------------------
+
+
+### notifyAppReady()
+
+```typescript
+notifyAppReady() => Promise<void>
+```
+
+Notify native plugin that the update is working, only in auto-update
+
+--------------------
+
+
+### delayUpdate()
+
+```typescript
+delayUpdate() => Promise<void>
+```
+
+Skip updates in the next time the app goes into the background, only in auto-update
+
+--------------------
+
+
+### cancelDelay()
+
+```typescript
+cancelDelay() => Promise<void>
+```
+
+allow update in the next time the app goes into the background, only in auto-update
+
+--------------------
+
+
+### addListener('download', ...)
+
+```typescript
+addListener(eventName: 'download', listenerFunc: DownloadChangeListener) => Promise<PluginListenerHandle> & PluginListenerHandle
+```
+
+Listen for download event in the App, let you know when the download is started, loading and finished
+
+| Param              | Type                                                                      |
+| ------------------ | ------------------------------------------------------------------------- |
+| **`eventName`**    | <code>'download'</code>                                                   |
+| **`listenerFunc`** | <code><a href="#downloadchangelistener">DownloadChangeListener</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt; & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
+
+**Since:** 2.0.11
+
+--------------------
+
+
+### addListener('majorAvailable', ...)
+
+```typescript
+addListener(eventName: 'majorAvailable', listenerFunc: MajorAvailableListener) => Promise<PluginListenerHandle> & PluginListenerHandle
+```
+
+Listen for Major update event in the App, let you know when major update is blocked by setting disableAutoUpdateBreaking
+
+| Param              | Type                                                                      |
+| ------------------ | ------------------------------------------------------------------------- |
+| **`eventName`**    | <code>'majorAvailable'</code>                                             |
+| **`listenerFunc`** | <code><a href="#majoravailablelistener">MajorAvailableListener</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt; & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
+
+**Since:** 2.3.0
+
+--------------------
+
+
+### addListener('updateAvailable', ...)
+
+```typescript
+addListener(eventName: 'updateAvailable', listenerFunc: UpdateAvailableListener) => Promise<PluginListenerHandle> & PluginListenerHandle
+```
+
+Listen for update event in the App, let you know when update is ready to install at next app start
+
+| Param              | Type                                                                        |
+| ------------------ | --------------------------------------------------------------------------- |
+| **`eventName`**    | <code>'updateAvailable'</code>                                              |
+| **`listenerFunc`** | <code><a href="#updateavailablelistener">UpdateAvailableListener</a></code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt; & <a href="#pluginlistenerhandle">PluginListenerHandle</a></code>
+
+**Since:** 2.3.0
+
+--------------------
+
+
+### addListener(string, ...)
+
+```typescript
+addListener(eventName: string, listenerFunc: (...args: any[]) => any) => Promise<PluginListenerHandle>
+```
+
+| Param              | Type                                    |
+| ------------------ | --------------------------------------- |
+| **`eventName`**    | <code>string</code>                     |
+| **`listenerFunc`** | <code>(...args: any[]) =&gt; any</code> |
+
+**Returns:** <code>Promise&lt;<a href="#pluginlistenerhandle">PluginListenerHandle</a>&gt;</code>
+
+--------------------
+
+
+### removeAllListeners()
+
+```typescript
+removeAllListeners() => Promise<void>
+```
+
+--------------------
+
+
+### Interfaces
+
+
+#### PluginListenerHandle
+
+| Prop         | Type                                      |
+| ------------ | ----------------------------------------- |
+| **`remove`** | <code>() =&gt; Promise&lt;void&gt;</code> |
+
+
+#### DownloadEvent
+
+| Prop          | Type                | Description                                    | Since  |
+| ------------- | ------------------- | ---------------------------------------------- | ------ |
+| **`percent`** | <code>number</code> | Current status of download, between 0 and 100. | 2.0.11 |
+
+
+#### MajorAvailableEvent
+
+| Prop          | Type                | Description                                 | Since |
+| ------------- | ------------------- | ------------------------------------------- | ----- |
+| **`version`** | <code>string</code> | Emit when a new major version is available. | 2.3.0 |
+
+
+#### UpdateAvailableEvent
+
+| Prop          | Type                | Description                          | Since |
+| ------------- | ------------------- | ------------------------------------ | ----- |
+| **`version`** | <code>string</code> | Emit when a new update is available. | 3.0.0 |
+
+
+### Type Aliases
+
+
+#### DownloadChangeListener
+
+<code>(state: <a href="#downloadevent">DownloadEvent</a>): void</code>
+
+
+#### MajorAvailableListener
+
+<code>(state: <a href="#majoravailableevent">MajorAvailableEvent</a>): void</code>
+
+
+#### UpdateAvailableListener
+
+<code>(state: <a href="#updateavailableevent">UpdateAvailableEvent</a>): void</code>
+
+</docgen-api>
+
+### Listen to download events
+
+```javascript
+  import { CapacitorUpdater } from 'capacitor-updater';
+
+CapacitorUpdater.addListener('download', (info: any) => {
+  console.log('download was fired', info.percent);
+});
+```
+
+On iOS, Apple don't allow you to show a message when the app is updated, so you can't show a progress bar.
+
+### Inspiration
+
+- [cordova-plugin-ionic](https://github.com/ionic-team/cordova-plugin-ionic)
+- [capacitor-codepush](https://github.dev/mapiacompany/capacitor-codepush)
+
+
+### Contributors
+
+[jamesyoung1337](https://github.com/jamesyoung1337) Thanks a lot for your guidance and support, it was impossible to make this plugin work without you.

package/android/build.gradle

@@ -0,0 +1,60 @@
+ext {
+    junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.1'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.2.0'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.2'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.3.0'
+}
+
+buildscript {
+    repositories {
+        google()
+        jcenter()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:4.2.1'
+    }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 30
+    defaultConfig {
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 21
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 30
+        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 "androidx.appcompat:appcompat:$androidxAppCompatVersion"
+    implementation 'com.android.volley:volley:1.2.1'
+    implementation 'io.github.g00fy2:versioncompare:1.5.0'
+    testImplementation "junit:junit:$junitVersion"
+    androidTestImplementation "androidx.test.ext:junit:$androidxJunitVersion"
+    androidTestImplementation "androidx.test.espresso:espresso-core:$androidxEspressoCoreVersion"
+}

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,3 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android"
+    package="ee.forgr.capacitor_updater">
+</manifest>