@capawesome/capacitor-live-update 5.0.0

package/CapawesomeCapacitorLiveUpdate.podspec

@@ -0,0 +1,20 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name = 'CapawesomeCapacitorLiveUpdate'
+  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  = '13.0'
+  s.dependency 'Capacitor'
+  s.dependency 'Alamofire', '~> 5.9.0'
+  s.dependency 'SSZipArchive', '~> 2.2'
+  s.swift_version = '5.1'
+  s.static_framework = true
+end

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Robin Genz
+
+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.

package/README.md

@@ -0,0 +1,509 @@
+# @capawesome/capacitor-live-update
+
+Capacitor plugin to update your app remotely in realtime.
+
+## Install
+
+```bash
+npm install @capawesome/capacitor-live-update
+npx cap sync
+```
+
+## Configuration
+
+<docgen-config>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+| Prop                    | Type                 | Description                                                                                                                                       | Default            | Since |
+| ----------------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ----- |
+| **`appId`**             | <code>string</code>  | The app ID is used to identify the app when using [Capawesome Cloud](https://capawesome.io/cloud).                                                |                    | 5.0.0 |
+| **`autoDeleteBundles`** | <code>boolean</code> | Whether or not to automatically delete unused bundles. When enabled, the plugin will automatically delete unused bundles after calling `ready()`. | <code>false</code> | 5.0.0 |
+| **`enabled`**           | <code>boolean</code> | Whether or not the plugin is enabled.                                                                                                             | <code>true</code>  | 5.0.0 |
+| **`readyTimeout`**      | <code>number</code>  | The timeout in milliseconds to wait for the app to be ready before resetting to the default bundle.                                               | <code>10000</code> | 5.0.0 |
+| **`resetOnUpdate`**     | <code>boolean</code> | Whether or not the app should be reset to the default bundle during an update.                                                                    | <code>true</code>  | 5.0.0 |
+
+### Examples
+
+In `capacitor.config.json`:
+
+```json
+{
+  "plugins": {
+    "LiveUpdate": {
+      "appId": '4100e356-e851-47fe-9d3c-b411eb325a99',
+      "autoDeleteBundles": undefined,
+      "enabled": undefined,
+      "readyTimeout": undefined,
+      "resetOnUpdate": undefined
+    }
+  }
+}
+```
+
+In `capacitor.config.ts`:
+
+```ts
+/// <reference types="@capacitor/live-update" />
+
+import { CapacitorConfig } from '@capacitor/cli';
+
+const config: CapacitorConfig = {
+  plugins: {
+    LiveUpdate: {
+      appId: '4100e356-e851-47fe-9d3c-b411eb325a99',
+      autoDeleteBundles: undefined,
+      enabled: undefined,
+      readyTimeout: undefined,
+      resetOnUpdate: undefined,
+    },
+  },
+};
+
+export default config;
+```
+
+</docgen-config>
+
+## Demo
+
+A working example can be found here: [robingenz/capacitor-plugin-demo](https://github.com/robingenz/capacitor-plugin-demo)
+
+## Usage
+
+```typescript
+import { LiveUpdate } from '@capawesome/capacitor-live-update';
+
+const downloadBundle = async () => {
+    // Download a bundle from a URL
+    await LiveUpdate.downloadBundle({
+        url: 'https://example.com/1.0.0.zip',
+        bundleId: '1.0.0',
+    });
+    // Set the downloaded bundle as the next bundle to use
+    await LiveUpdate.setBundle({ bundleId: '1.0.0' });
+    // Reload the app to apply the new bundle
+    await LiveUpdate.reload();
+};
+
+const sync = async () => {
+    // Automatically download and set the latest bundle for the app
+    const result = await LiveUpdate.sync();
+    if (result.nextBundleId) {
+        // Reload the app to apply the new bundle
+        await LiveUpdate.reload();
+    }
+};
+```
+
+## API
+
+<docgen-index>
+
+* [`deleteBundle(...)`](#deletebundle)
+* [`downloadBundle(...)`](#downloadbundle)
+* [`getBundle()`](#getbundle)
+* [`getBundles()`](#getbundles)
+* [`getChannel()`](#getchannel)
+* [`getCustomId()`](#getcustomid)
+* [`getDeviceId()`](#getdeviceid)
+* [`getVersionCode()`](#getversioncode)
+* [`getVersionName()`](#getversionname)
+* [`ready()`](#ready)
+* [`reload()`](#reload)
+* [`reset()`](#reset)
+* [`setBundle(...)`](#setbundle)
+* [`setChannel(...)`](#setchannel)
+* [`setCustomId(...)`](#setcustomid)
+* [`sync()`](#sync)
+* [Interfaces](#interfaces)
+
+</docgen-index>
+
+<docgen-api>
+<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->
+
+### deleteBundle(...)
+
+```typescript
+deleteBundle(options: DeleteBundleOptions) => Promise<void>
+```
+
+Delete a bundle from the app.
+
+Only available on Android and iOS.
+
+| Param         | Type                                                                |
+| ------------- | ------------------------------------------------------------------- |
+| **`options`** | <code><a href="#deletebundleoptions">DeleteBundleOptions</a></code> |
+
+**Since:** 5.0.0
+
+--------------------
+
+
+### downloadBundle(...)
+
+```typescript
+downloadBundle(options: DownloadBundleOptions) => Promise<void>
+```
+
+Download a bundle.
+
+Only available on Android and iOS.
+
+| Param         | Type                                                                    |
+| ------------- | ----------------------------------------------------------------------- |
+| **`options`** | <code><a href="#downloadbundleoptions">DownloadBundleOptions</a></code> |
+
+**Since:** 5.0.0
+
+--------------------
+
+
+### getBundle()
+
+```typescript
+getBundle() => Promise<GetBundleResult>
+```
+
+Get the active bundle identifier.
+
+Only available on Android and iOS.
+
+**Returns:** <code>Promise&lt;<a href="#getbundleresult">GetBundleResult</a>&gt;</code>
+
+**Since:** 5.0.0
+
+--------------------
+
+
+### getBundles()
+
+```typescript
+getBundles() => Promise<GetBundlesResult>
+```
+
+Get all available bundle identifiers.
+
+Only available on Android and iOS.
+
+**Returns:** <code>Promise&lt;<a href="#getbundlesresult">GetBundlesResult</a>&gt;</code>
+
+**Since:** 5.0.0
+
+--------------------
+
+
+### getChannel()
+
+```typescript
+getChannel() => Promise<GetChannelResult>
+```
+
+Get the channel of the app.
+
+Only available on Android and iOS.
+
+**Returns:** <code>Promise&lt;<a href="#getchannelresult">GetChannelResult</a>&gt;</code>
+
+**Since:** 5.0.0
+
+--------------------
+
+
+### getCustomId()
+
+```typescript
+getCustomId() => Promise<GetCustomIdResult>
+```
+
+Get the custom identifier of the app.
+
+Only available on Android and iOS.
+
+**Returns:** <code>Promise&lt;<a href="#getcustomidresult">GetCustomIdResult</a>&gt;</code>
+
+**Since:** 5.0.0
+
+--------------------
+
+
+### getDeviceId()
+
+```typescript
+getDeviceId() => Promise<GetDeviceIdResult>
+```
+
+Get the device identifier of the app.
+
+Only available on Android and iOS.
+
+**Returns:** <code>Promise&lt;<a href="#getdeviceidresult">GetDeviceIdResult</a>&gt;</code>
+
+**Since:** 5.0.0
+
+--------------------
+
+
+### getVersionCode()
+
+```typescript
+getVersionCode() => Promise<GetVersionCodeResult>
+```
+
+Get the version code of the app.
+
+Only available on Android and iOS.
+
+**Returns:** <code>Promise&lt;<a href="#getversioncoderesult">GetVersionCodeResult</a>&gt;</code>
+
+**Since:** 5.0.0
+
+--------------------
+
+
+### getVersionName()
+
+```typescript
+getVersionName() => Promise<GetVersionNameResult>
+```
+
+Get the version name of the app.
+
+Only available on Android and iOS.
+
+**Returns:** <code>Promise&lt;<a href="#getversionnameresult">GetVersionNameResult</a>&gt;</code>
+
+**Since:** 5.0.0
+
+--------------------
+
+
+### ready()
+
+```typescript
+ready() => Promise<void>
+```
+
+Notify the plugin that the app is ready to use and no rollback is needed.
+
+Only available on Android and iOS.
+
+**Since:** 5.0.0
+
+--------------------
+
+
+### reload()
+
+```typescript
+reload() => Promise<void>
+```
+
+Reload the app to apply the new bundle.
+
+Only available on Android and iOS.
+
+**Since:** 5.0.0
+
+--------------------
+
+
+### reset()
+
+```typescript
+reset() => Promise<void>
+```
+
+Reset the app to the default bundle.
+
+Call `reload()` or restart the app to apply the changes.
+
+Only available on Android and iOS.
+
+**Since:** 5.0.0
+
+--------------------
+
+
+### setBundle(...)
+
+```typescript
+setBundle(options: SetBundleOptions) => Promise<void>
+```
+
+Set the next bundle to use for the app.
+
+Call `reload()` or restart the app to apply the changes.
+
+Only available on Android and iOS.
+
+| Param         | Type                                                          |
+| ------------- | ------------------------------------------------------------- |
+| **`options`** | <code><a href="#setbundleoptions">SetBundleOptions</a></code> |
+
+**Since:** 5.0.0
+
+--------------------
+
+
+### setChannel(...)
+
+```typescript
+setChannel(options: SetChannelOptions) => Promise<void>
+```
+
+Set the channel of the app.
+
+Only available on Android and iOS.
+
+| Param         | Type                                                            |
+| ------------- | --------------------------------------------------------------- |
+| **`options`** | <code><a href="#setchanneloptions">SetChannelOptions</a></code> |
+
+**Since:** 5.0.0
+
+--------------------
+
+
+### setCustomId(...)
+
+```typescript
+setCustomId(options: SetCustomIdOptions) => Promise<void>
+```
+
+Set the custom identifier of the app.
+
+Only available on Android and iOS.
+
+| Param         | Type                                                              |
+| ------------- | ----------------------------------------------------------------- |
+| **`options`** | <code><a href="#setcustomidoptions">SetCustomIdOptions</a></code> |
+
+**Since:** 5.0.0
+
+--------------------
+
+
+### sync()
+
+```typescript
+sync() => Promise<SyncResult>
+```
+
+Automatically download and set the latest bundle for the app using the [Capawesome Cloud](https://capawesome.io/cloud/).
+
+Call `reload()` or restart the app to apply the changes.
+
+Only available on Android and iOS.
+
+**Returns:** <code>Promise&lt;<a href="#syncresult">SyncResult</a>&gt;</code>
+
+**Since:** 5.0.0
+
+--------------------
+
+
+### Interfaces
+
+
+#### DeleteBundleOptions
+
+| Prop           | Type                | Description                                    | Since |
+| -------------- | ------------------- | ---------------------------------------------- | ----- |
+| **`bundleId`** | <code>string</code> | The unique identifier of the bundle to delete. | 5.0.0 |
+
+
+#### DownloadBundleOptions
+
+| Prop           | Type                | Description                                                                                               | Since |
+| -------------- | ------------------- | --------------------------------------------------------------------------------------------------------- | ----- |
+| **`url`**      | <code>string</code> | The URL of the bundle to download. The bundle must be a ZIP file containing at least a `index.html` file. | 5.0.0 |
+| **`bundleId`** | <code>string</code> | The unique identifier of the bundle.                                                                      | 5.0.0 |
+
+
+#### GetBundleResult
+
+| Prop           | Type                        | Description                                                                              | Since |
+| -------------- | --------------------------- | ---------------------------------------------------------------------------------------- | ----- |
+| **`bundleId`** | <code>string \| null</code> | The unique identifier of the active bundle. If `null`, the default bundle is being used. | 5.0.0 |
+
+
+#### GetBundlesResult
+
+| Prop            | Type                  | Description                                              | Since |
+| --------------- | --------------------- | -------------------------------------------------------- | ----- |
+| **`bundleIds`** | <code>string[]</code> | An array of unique identifiers of all available bundles. | 5.0.0 |
+
+
+#### GetChannelResult
+
+| Prop          | Type                        | Description                                                              | Since |
+| ------------- | --------------------------- | ------------------------------------------------------------------------ | ----- |
+| **`channel`** | <code>string \| null</code> | The channel of the app. If `null`, the app is using the default channel. | 5.0.0 |
+
+
+#### GetCustomIdResult
+
+| Prop           | Type                        | Description                                                               | Since |
+| -------------- | --------------------------- | ------------------------------------------------------------------------- | ----- |
+| **`customId`** | <code>string \| null</code> | The custom identifier of the app. If `null`, no custom identifier is set. | 5.0.0 |
+
+
+#### GetDeviceIdResult
+
+| Prop           | Type                | Description                          | Since |
+| -------------- | ------------------- | ------------------------------------ | ----- |
+| **`deviceId`** | <code>string</code> | The unique identifier of the device. | 5.0.0 |
+
+
+#### GetVersionCodeResult
+
+| Prop              | Type                | Description                                                                                                                                                                            | Since |
+| ----------------- | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
+| **`versionCode`** | <code>string</code> | The version code of the app. On **Android**, this is the `versionCode` from the `android/app/build.gradle` file. On **iOS**, this is the `CFBundleVersion` from the `Info.plist` file. | 5.0.0 |
+
+
+#### GetVersionNameResult
+
+| Prop              | Type                | Description                                                                                                                                                                                       | Since |
+| ----------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
+| **`versionName`** | <code>string</code> | The version name of the app. On **Android**, this is the `versionName` from the `android/app/build.gradle` file. On **iOS**, this is the `CFBundleShortVersionString` from the `Info.plist` file. | 5.0.0 |
+
+
+#### SetBundleOptions
+
+| Prop           | Type                | Description                                 | Since |
+| -------------- | ------------------- | ------------------------------------------- | ----- |
+| **`bundleId`** | <code>string</code> | The unique identifier of the bundle to use. | 5.0.0 |
+
+
+#### SetChannelOptions
+
+| Prop          | Type                        | Description                                               | Since |
+| ------------- | --------------------------- | --------------------------------------------------------- | ----- |
+| **`channel`** | <code>string \| null</code> | The channel of the app. Set `null` to remove the channel. | 5.0.0 |
+
+
+#### SetCustomIdOptions
+
+| Prop           | Type                        | Description                                                                   | Since |
+| -------------- | --------------------------- | ----------------------------------------------------------------------------- | ----- |
+| **`customId`** | <code>string \| null</code> | The custom identifier of the app. Set `null` to remove the custom identifier. | 5.0.0 |
+
+
+#### SyncResult
+
+| Prop               | Type                        | Description                                                                                                | Since |
+| ------------------ | --------------------------- | ---------------------------------------------------------------------------------------------------------- | ----- |
+| **`nextBundleId`** | <code>string \| null</code> | The identifier of the next bundle to use. If `null`, the app is up-to-date and no new bundle is available. | 5.0.0 |
+
+</docgen-api>
+
+## Changelog
+
+See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/live-update/CHANGELOG.md).
+
+## License
+
+See [LICENSE](https://github.com/capawesome-team/capacitor-plugins/blob/main/packages/live-update/LICENSE).

package/android/build.gradle

@@ -0,0 +1,62 @@
+ext {
+    junitVersion = project.hasProperty('junitVersion') ? rootProject.ext.junitVersion : '4.13.2'
+    androidxAppCompatVersion = project.hasProperty('androidxAppCompatVersion') ? rootProject.ext.androidxAppCompatVersion : '1.6.1'
+    androidxJunitVersion = project.hasProperty('androidxJunitVersion') ? rootProject.ext.androidxJunitVersion : '1.1.5'
+    androidxEspressoCoreVersion = project.hasProperty('androidxEspressoCoreVersion') ? rootProject.ext.androidxEspressoCoreVersion : '3.5.1'
+    okhttp3Version = project.hasProperty('okhttp3Version') ? rootProject.ext.okhttp3Version : '4.12.0'
+    zip4jVersion = project.hasProperty('zip4jVersion') ? rootProject.ext.zip4jVersion : '2.11.5'
+}
+
+buildscript {
+    repositories {
+        google()
+        mavenCentral()
+    }
+    dependencies {
+        classpath 'com.android.tools.build:gradle:8.0.0'
+    }
+}
+
+apply plugin: 'com.android.library'
+
+android {
+    namespace "io.capawesome.capacitorjs.plugins.liveupdate"
+    compileSdkVersion project.hasProperty('compileSdkVersion') ? rootProject.ext.compileSdkVersion : 33
+    defaultConfig {
+        minSdkVersion project.hasProperty('minSdkVersion') ? rootProject.ext.minSdkVersion : 22
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? rootProject.ext.targetSdkVersion : 33
+        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_17
+        targetCompatibility JavaVersion.VERSION_17
+    }
+}
+
+repositories {
+    google()
+    mavenCentral()
+}
+
+
+dependencies {
+    implementation fileTree(dir: 'libs', include: ['*.jar'])
+    implementation project(':capacitor-android')
+    implementation "androidx.appcompat:appcompat:$androidxAppCompatVersion"
+    implementation "net.lingala.zip4j:zip4j:$zip4jVersion"
+    implementation "com.squareup.okhttp3:okhttp:$okhttp3Version"
+    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,2 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+</manifest>