@simplysm/capacitor-plugin-auto-update 14.0.4 → 14.0.6

package/README.md

@@ -1,6 +1,9 @@
 # @simplysm/capacitor-plugin-auto-update
 
-Capacitor auto-update plugin for Android APK installation and OTA updates.
+Capacitor plugin for automatic APK updates on Android. Provides APK installation with permission management and automatic update flows via a remote server or external storage.
+
+- **Android**: Launches APK install intents, manages `REQUEST_INSTALL_PACKAGES` permission
+- **Browser**: Displays notification messages and returns normally (for development)
 
 ## Installation
 
@@ -10,76 +13,124 @@ npm install @simplysm/capacitor-plugin-auto-update
 
 ## API Overview
 
-### APK Installation
+### Interfaces
 
 | API | Type | Description |
 |-----|------|-------------|
 | `VersionInfo` | Interface | App version information |
 | `ApkInstallerPlugin` | Interface | Native plugin interface for APK installation |
-| `ApkInstaller` | Class | Static API for APK installation, permission management, and version info |
 
-### Auto Update
+### Classes
 
 | API | Type | Description |
 |-----|------|-------------|
+| `ApkInstaller` | Class | Static API for APK installation, permission management, and version info |
 | `AutoUpdate` | Class | Static API for downloading and installing APK updates from a server or external storage |
 
-## Interfaces
-
-### VersionInfo
+## `VersionInfo`
 
 Holds application version information.
 
+```typescript
+interface VersionInfo {
+  versionName: string;
+  versionCode: string;
+}
+```
+
 | Field | Type | Description |
 |-------|------|-------------|
 | `versionName` | `string` | Human-readable version name (e.g. `"1.2.3"`) |
 | `versionCode` | `string` | Numeric version code used by the Android system |
 
-### ApkInstallerPlugin
+## `ApkInstallerPlugin`
 
-Native plugin interface for APK installation.
+Native plugin interface for APK installation. Use the `ApkInstaller` class for a simplified API.
+
+```typescript
+interface ApkInstallerPlugin {
+  install(options: { uri: string }): Promise<void>;
+  checkPermissions(): Promise<{ granted: boolean; manifest: boolean }>;
+  requestPermissions(): Promise<void>;
+  getVersionInfo(): Promise<VersionInfo>;
+}
+```
 
 | Method | Signature | Description |
 |--------|-----------|-------------|
-| `install` | `(options: { uri: string }) => Promise<void>` | Install APK from the given content URI |
-| `checkPermissions` | `() => Promise<{ granted: boolean; manifest: boolean }>` | Check whether install permissions are granted |
+| `install` | `(options: { uri: string }) => Promise<void>` | Install APK from the given `content://` URI |
+| `checkPermissions` | `() => Promise<{ granted: boolean; manifest: boolean }>` | Check whether install permissions are granted and declared in manifest |
 | `requestPermissions` | `() => Promise<void>` | Request the `REQUEST_INSTALL_PACKAGES` permission |
 | `getVersionInfo` | `() => Promise<VersionInfo>` | Retrieve current app version info |
 
-## Classes
+## `ApkInstaller`
 
-### ApkInstaller
+Abstract class with static methods for APK installation and permission management. On Android it runs the APK install intent and manages the `REQUEST_INSTALL_PACKAGES` permission. On the browser it shows a notification and returns normally.
 
-APK installation plugin. On Android it runs the APK install intent and manages the `REQUEST_INSTALL_PACKAGES` permission. On the browser it shows a notification and returns normally.
-
-All methods are static.
+```typescript
+abstract class ApkInstaller {
+  static async checkPermissions(): Promise<{ granted: boolean; manifest: boolean }>;
+  static async requestPermissions(): Promise<void>;
+  static async install(apkUri: string): Promise<void>;
+  static async getVersionInfo(): Promise<VersionInfo>;
+}
+```
 
 | Method | Signature | Description |
 |--------|-----------|-------------|
-| `checkPermissions` | `static async checkPermissions(): Promise<{ granted: boolean; manifest: boolean }>` | Check whether install permissions are currently granted |
-| `requestPermissions` | `static async requestPermissions(): Promise<void>` | Request the `REQUEST_INSTALL_PACKAGES` permission from the user |
-| `install` | `static async install(apkUri: string): Promise<void>` | Install an APK from a `content://` URI |
+| `checkPermissions` | `static async checkPermissions(): Promise<{ granted: boolean; manifest: boolean }>` | Check whether install permission is granted and declared in manifest |
+| `requestPermissions` | `static async requestPermissions(): Promise<void>` | Request `REQUEST_INSTALL_PACKAGES` permission (navigates to settings screen) |
+| `install` | `static async install(apkUri: string): Promise<void>` | Install an APK from a `content://` URI (FileProvider URI) |
 | `getVersionInfo` | `static async getVersionInfo(): Promise<VersionInfo>` | Get the current app version name and version code |
 
-### AutoUpdate
+## `AutoUpdate`
 
-Handles the full update flow: download an APK and install it.
+Abstract class with static methods for orchestrating the full automatic update flow. Handles permission checks, version comparison, APK download, and installation.
 
-All methods are static.
+```typescript
+abstract class AutoUpdate {
+  static async run(opt: {
+    log: (messageHtml: string) => void;
+    serviceClient: ServiceClient;
+  }): Promise<void>;
+
+  static async runByExternalStorage(opt: {
+    log: (messageHtml: string) => void;
+    dirPath: string;
+  }): Promise<void>;
+}
+```
 
 | Method | Signature | Description |
 |--------|-----------|-------------|
-| `run` | `static async run(opt: { log: (messageHtml: string) => void; serviceClient: ServiceClient }): Promise<void>` | Download the latest APK from a server via `ServiceClient` and install it. Progress is reported through the `log` callback as HTML strings. |
-| `runByExternalStorage` | `static async runByExternalStorage(opt: { log: (messageHtml: string) => void; dirPath: string }): Promise<void>` | Find the latest APK file from an external storage directory and install it. Progress is reported through the `log` callback. |
+| `run` | `static async run(opt: { log: (messageHtml: string) => void; serviceClient: ServiceClient }): Promise<void>` | Download the latest APK from a remote server via `ServiceClient` and install it. Progress is reported through the `log` callback as HTML strings. |
+| `runByExternalStorage` | `static async runByExternalStorage(opt: { log: (messageHtml: string) => void; dirPath: string }): Promise<void>` | Find the latest versioned APK file from an external storage directory and install it. Scans `dirPath` for files named `{semver}.apk`. |
+
+### Parameters for `run`
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `log` | `(messageHtml: string) => void` | Callback to display progress/status HTML messages |
+| `serviceClient` | `ServiceClient` | `@simplysm/service-client` instance for server communication |
+
+### Parameters for `runByExternalStorage`
+
+| Field | Type | Description |
+|-------|------|-------------|
+| `log` | `(messageHtml: string) => void` | Callback to display progress/status HTML messages |
+| `dirPath` | `string` | Relative path within external storage containing versioned APK files |
 
 ## Usage Examples
 
 ### Check permissions and install an APK
 
-```ts
+```typescript
 import { ApkInstaller } from "@simplysm/capacitor-plugin-auto-update";
 
 const perms = await ApkInstaller.checkPermissions();
+if (!perms.manifest) {
+  throw new Error("REQUEST_INSTALL_PACKAGES not declared in AndroidManifest.xml");
+}
 if (!perms.granted) {
   await ApkInstaller.requestPermissions();
 }
@@ -87,9 +138,9 @@ if (!perms.granted) {
 await ApkInstaller.install("content://com.example.provider/apk/update.apk");
 ```
 
-### Auto-update from a server
+### Auto-update from a remote server
 
-```ts
+```typescript
 import { AutoUpdate } from "@simplysm/capacitor-plugin-auto-update";
 
 await AutoUpdate.run({
@@ -102,13 +153,13 @@ await AutoUpdate.run({
 
 ### Auto-update from external storage
 
-```ts
+```typescript
 import { AutoUpdate } from "@simplysm/capacitor-plugin-auto-update";
 
 await AutoUpdate.runByExternalStorage({
   log: (messageHtml) => {
     document.getElementById("status")!.innerHTML = messageHtml;
   },
-  dirPath: "/storage/emulated/0/Download/updates",
+  dirPath: "MyApp/updates",
 });
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@simplysm/capacitor-plugin-auto-update",
-  "version": "14.0.4",
+  "version": "14.0.6",
   "description": "심플리즘 패키지 - Capacitor 자동 업데이트 플러그인",
   "author": "심플리즘",
   "license": "Apache-2.0",
@@ -19,11 +19,11 @@
   ],
   "dependencies": {
     "semver": "^7.7.4",
-    "@simplysm/capacitor-plugin-file-system": "14.0.4",
-    "@simplysm/core-browser": "14.0.4",
-    "@simplysm/service-client": "14.0.4",
-    "@simplysm/core-common": "14.0.4",
-    "@simplysm/service-common": "14.0.4"
+    "@simplysm/capacitor-plugin-file-system": "14.0.6",
+    "@simplysm/core-browser": "14.0.6",
+    "@simplysm/core-common": "14.0.6",
+    "@simplysm/service-client": "14.0.6",
+    "@simplysm/service-common": "14.0.6"
   },
   "devDependencies": {
     "@capacitor/core": "^7.6.1",