native-update 1.0.0 → 1.0.1

package/docs/APP_REVIEW_GUIDE.md

@@ -1,6 +1,6 @@
 # App Review Implementation Guide
 
-This comprehensive guide explains how to implement in-app review functionality in your Capacitor application using the CapacitorNativeUpdate plugin.
+This comprehensive guide explains how to implement in-app review functionality in your Capacitor application using the NativeUpdate plugin.
 
 ## Table of Contents
 
@@ -76,7 +76,7 @@ The App Review feature allows users to rate and review your app without leaving
 ### Installation
 
 ```bash
-npm install capacitor-native-update
+npm install native-update
 npx cap sync
 ```
 
@@ -93,7 +93,7 @@ No additional configuration required. The plugin automatically uses StoreKit.
 ```json
 {
   "plugins": {
-    "CapacitorNativeUpdate": {
+    "NativeUpdate": {
       "appStoreId": "YOUR_APP_STORE_ID",
       "reviewPromptDelay": 2000,
       "reviewDebugMode": false
@@ -107,12 +107,12 @@ No additional configuration required. The plugin automatically uses StoreKit.
 ### Step 1: Basic Implementation
 
 ```typescript
-import { CapacitorNativeUpdate } from 'capacitor-native-update';
+import { NativeUpdate } from 'native-update';
 
 export class AppReviewService {
   async requestReview() {
     try {
-      const result = await CapacitorNativeUpdate.requestReview();
+      const result = await NativeUpdate.requestReview();
 
       if (result.displayed) {
         console.log('Review prompt was displayed');
@@ -329,7 +329,7 @@ export class TwoStepReviewFlow {
           text: 'Sure!',
           handler: async () => {
             this.analytics.track('review_accepted');
-            await CapacitorNativeUpdate.requestReview();
+            await NativeUpdate.requestReview();
           },
         },
       ],
@@ -540,7 +540,7 @@ export class ReviewABTesting {
 
     switch (strategy) {
       case 'immediate':
-        await CapacitorNativeUpdate.requestReview();
+        await NativeUpdate.requestReview();
         break;
       case 'two-step':
         await this.twoStepFlow.initiateReviewFlow();
@@ -617,7 +617,7 @@ export class ReviewAnalytics {
 export class ReviewTestingUtils {
   async enableTestMode() {
     // Enable debug mode
-    await CapacitorNativeUpdate.setReviewDebugMode({ enabled: true });
+    await NativeUpdate.setReviewDebugMode({ enabled: true });
 
     // Reset all preferences
     await this.clearReviewPreferences();
@@ -630,7 +630,7 @@ export class ReviewTestingUtils {
     console.log('Simulating review flow...');
 
     // Force display of review prompt
-    const result = await CapacitorNativeUpdate.requestReview({
+    const result = await NativeUpdate.requestReview({
       force: true, // Only works in debug mode
     });
 
@@ -682,11 +682,11 @@ export class ReviewTestingUtils {
 // Debug checklist
 async function debugReviewPrompt() {
   // Check if available on platform
-  const isAvailable = await CapacitorNativeUpdate.isReviewAvailable();
+  const isAvailable = await NativeUpdate.isReviewAvailable();
   console.log('Review available:', isAvailable);
 
   // Check system throttling
-  const debugInfo = await CapacitorNativeUpdate.getReviewDebugInfo();
+  const debugInfo = await NativeUpdate.getReviewDebugInfo();
   console.log('Debug info:', debugInfo);
 
   // Check your conditions
@@ -731,7 +731,7 @@ class ReviewOptimizer {
 // Platform fallbacks
 async function requestReviewWithFallback() {
   try {
-    const result = await CapacitorNativeUpdate.requestReview();
+    const result = await NativeUpdate.requestReview();
 
     if (!result.displayed) {
       // System didn't show prompt

package/docs/BUNDLE_SIGNING.md

@@ -78,7 +78,7 @@ Signatures are:
 // capacitor.config.json
 {
   "plugins": {
-    "CapacitorNativeUpdate": {
+    "NativeUpdate": {
       "publicKey": "base64-encoded-public-key",
       "enforceSignature": true
     }
@@ -90,9 +90,9 @@ Signatures are:
 
 ```swift
 // Info.plist
-<key>CapacitorNativeUpdatePublicKey</key>
+<key>NativeUpdatePublicKey</key>
 <string>base64-encoded-public-key</string>
-<key>CapacitorNativeUpdateEnforceSignature</key>
+<key>NativeUpdateEnforceSignature</key>
 <true/>
 ```
 
@@ -241,7 +241,7 @@ Response: {
 
 ```typescript
 // Manual verification (advanced use)
-const isValid = await CapacitorNativeUpdate.verifySignature({
+const isValid = await NativeUpdate.verifySignature({
   bundlePath: '/path/to/bundle.zip',
   signature: 'base64-signature',
   publicKey: 'base64-public-key', // Optional, uses config if not provided

package/docs/LIVE_UPDATES_GUIDE.md

@@ -1,6 +1,6 @@
 # Live Updates (OTA) Implementation Guide
 
-This comprehensive guide explains how to implement Live Updates (Over-The-Air updates) in your Capacitor application using the CapacitorNativeUpdate plugin.
+This comprehensive guide explains how to implement Live Updates (Over-The-Air updates) in your Capacitor application using the NativeUpdate plugin.
 
 ## Table of Contents
 
@@ -69,7 +69,7 @@ sequenceDiagram
 ### 1. Install the Plugin
 
 ```bash
-npm install capacitor-native-update
+npm install native-update
 npx cap sync
 ```
 
@@ -82,7 +82,7 @@ npx cap sync
   "appId": "com.example.app",
   "appName": "My App",
   "plugins": {
-    "CapacitorNativeUpdate": {
+    "NativeUpdate": {
       "updateUrl": "https://updates.yourdomain.com/api/v1",
       "enabled": true,
       "autoCheck": true,
@@ -102,9 +102,9 @@ npx cap sync
 Add to `Info.plist`:
 
 ```xml
-<key>CapacitorNativeUpdateEnabled</key>
+<key>NativeUpdateEnabled</key>
 <true/>
-<key>CapacitorNativeUpdateURL</key>
+<key>NativeUpdateURL</key>
 <string>https://updates.yourdomain.com/api/v1</string>
 ```
 
@@ -122,20 +122,20 @@ Add to `AndroidManifest.xml`:
 ### Step 1: Basic Implementation
 
 ```typescript
-import { CapacitorNativeUpdate } from 'capacitor-native-update';
+import { NativeUpdate } from 'native-update';
 
 export class UpdateManager {
   async checkAndUpdate() {
     try {
       // Check for updates
       const { available, version } =
-        await CapacitorNativeUpdate.checkForUpdate();
+        await NativeUpdate.checkForUpdate();
 
       if (available) {
         console.log(`Update available: ${version}`);
 
         // Download the update
-        const { success } = await CapacitorNativeUpdate.downloadUpdate({
+        const { success } = await NativeUpdate.downloadUpdate({
           onProgress: (progress) => {
             console.log(`Download progress: ${progress.percent}%`);
           },
@@ -143,7 +143,7 @@ export class UpdateManager {
 
         if (success) {
           // Apply the update
-          await CapacitorNativeUpdate.applyUpdate();
+          await NativeUpdate.applyUpdate();
           // App will restart automatically
         }
       }
@@ -157,7 +157,7 @@ export class UpdateManager {
 ### Step 2: Advanced Implementation with UI
 
 ```typescript
-import { CapacitorNativeUpdate } from 'capacitor-native-update';
+import { NativeUpdate } from 'native-update';
 import { AlertController, LoadingController } from '@ionic/angular';
 
 export class UpdateService {
@@ -169,7 +169,7 @@ export class UpdateService {
   async checkForUpdates(silent = false) {
     try {
       const { available, version, mandatory, notes } =
-        await CapacitorNativeUpdate.checkForUpdate();
+        await NativeUpdate.checkForUpdate();
 
       if (!available) {
         if (!silent) {
@@ -220,7 +220,7 @@ export class UpdateService {
 
     try {
       // Download with progress
-      await CapacitorNativeUpdate.downloadUpdate({
+      await NativeUpdate.downloadUpdate({
         onProgress: (progress) => {
           loading.message = `Downloading... ${Math.round(progress.percent)}%`;
         },
@@ -229,7 +229,7 @@ export class UpdateService {
       loading.message = 'Applying update...';
 
       // Apply the update
-      await CapacitorNativeUpdate.applyUpdate();
+      await NativeUpdate.applyUpdate();
 
       // The app will restart automatically
     } catch (error) {
@@ -291,19 +291,19 @@ export class AppComponent implements OnInit {
 export class UpdateStrategies {
   // Immediate update (default)
   async immediateUpdate() {
-    const { available } = await CapacitorNativeUpdate.checkForUpdate();
+    const { available } = await NativeUpdate.checkForUpdate();
     if (available) {
-      await CapacitorNativeUpdate.downloadUpdate();
-      await CapacitorNativeUpdate.applyUpdate(); // Restarts immediately
+      await NativeUpdate.downloadUpdate();
+      await NativeUpdate.applyUpdate(); // Restarts immediately
     }
   }
 
   // Update on next restart
   async updateOnRestart() {
-    const { available } = await CapacitorNativeUpdate.checkForUpdate();
+    const { available } = await NativeUpdate.checkForUpdate();
     if (available) {
-      await CapacitorNativeUpdate.downloadUpdate();
-      await CapacitorNativeUpdate.applyUpdate({
+      await NativeUpdate.downloadUpdate();
+      await NativeUpdate.applyUpdate({
         reloadStrategy: 'on-next-restart',
       });
       // Update will be applied next time app starts
@@ -312,14 +312,14 @@ export class UpdateStrategies {
 
   // Update with confirmation
   async updateWithConfirmation() {
-    const { available } = await CapacitorNativeUpdate.checkForUpdate();
+    const { available } = await NativeUpdate.checkForUpdate();
     if (available) {
-      await CapacitorNativeUpdate.downloadUpdate();
+      await NativeUpdate.downloadUpdate();
 
       // Show confirmation dialog
       const confirmed = await this.showUpdateReadyDialog();
       if (confirmed) {
-        await CapacitorNativeUpdate.applyUpdate();
+        await NativeUpdate.applyUpdate();
       }
     }
   }
@@ -417,20 +417,20 @@ curl -X POST https://updates.example.com/api/v1/bundles \
 
 ```typescript
 // Development channel for testing
-await CapacitorNativeUpdate.setChannel({ channel: 'development' });
+await NativeUpdate.setChannel({ channel: 'development' });
 
 // Production channel for users
-await CapacitorNativeUpdate.setChannel({ channel: 'production' });
+await NativeUpdate.setChannel({ channel: 'production' });
 
 // Beta channel for early adopters
-await CapacitorNativeUpdate.setChannel({ channel: 'beta' });
+await NativeUpdate.setChannel({ channel: 'beta' });
 ```
 
 ### 2. Delta Updates
 
 ```typescript
 // Enable delta updates to reduce download size
-await CapacitorNativeUpdate.configureDeltaUpdates({
+await NativeUpdate.configureDeltaUpdates({
   enabled: true,
   threshold: 0.3, // Use delta if size < 30% of full bundle
 });
@@ -440,15 +440,15 @@ await CapacitorNativeUpdate.configureDeltaUpdates({
 
 ```typescript
 // List available versions
-const { versions } = await CapacitorNativeUpdate.getVersions();
+const { versions } = await NativeUpdate.getVersions();
 
 // Rollback to previous version
 if (versions.length > 1) {
-  await CapacitorNativeUpdate.rollback();
+  await NativeUpdate.rollback();
 }
 
 // Rollback to specific version
-await CapacitorNativeUpdate.switchVersion({
+await NativeUpdate.switchVersion({
   version: '1.0.0',
 });
 ```
@@ -457,13 +457,13 @@ await CapacitorNativeUpdate.switchVersion({
 
 ```typescript
 // Track update success
-await CapacitorNativeUpdate.reportUpdateSuccess({
+await NativeUpdate.reportUpdateSuccess({
   version: '1.0.1',
   duration: 5000,
 });
 
 // Track update failure
-await CapacitorNativeUpdate.reportUpdateFailure({
+await NativeUpdate.reportUpdateFailure({
   version: '1.0.1',
   error: 'DOWNLOAD_FAILED',
   details: 'Network timeout',
@@ -474,7 +474,7 @@ await CapacitorNativeUpdate.reportUpdateFailure({
 
 ```typescript
 // Disable auto-check
-await CapacitorNativeUpdate.configure({
+await NativeUpdate.configure({
   autoCheck: false,
 });
 
@@ -482,7 +482,7 @@ await CapacitorNativeUpdate.configure({
 class CustomUpdateUI {
   async showUpdateFlow() {
     // Custom check
-    const update = await CapacitorNativeUpdate.checkForUpdate();
+    const update = await NativeUpdate.checkForUpdate();
 
     if (update.available) {
       // Show custom UI
@@ -519,7 +519,7 @@ const skipVersions = ['1.0.2', '1.0.3']; // Known bad versions
 class RobustUpdateManager {
   async safeUpdate() {
     try {
-      await CapacitorNativeUpdate.checkForUpdate();
+      await NativeUpdate.checkForUpdate();
     } catch (error) {
       if (error.code === 'NETWORK_ERROR') {
         // Retry with exponential backoff
@@ -542,7 +542,7 @@ class RobustUpdateManager {
 // Test in development
 if (environment.development) {
   // Force check against staging server
-  await CapacitorNativeUpdate.configure({
+  await NativeUpdate.configure({
     updateUrl: 'https://staging-updates.yourdomain.com',
     channel: 'development',
   });
@@ -550,7 +550,7 @@ if (environment.development) {
 
 // A/B testing
 const testGroup = user.id % 2 === 0 ? 'A' : 'B';
-await CapacitorNativeUpdate.setChannel({
+await NativeUpdate.setChannel({
   channel: `production-${testGroup}`,
 });
 ```
@@ -561,15 +561,15 @@ await CapacitorNativeUpdate.setChannel({
 // Download during off-peak hours
 const now = new Date().getHours();
 if (now >= 2 && now <= 6) {
-  await CapacitorNativeUpdate.downloadUpdate({
+  await NativeUpdate.downloadUpdate({
     priority: 'low',
   });
 }
 
 // Pause/resume downloads
-const downloadId = await CapacitorNativeUpdate.startDownload();
-await CapacitorNativeUpdate.pauseDownload({ id: downloadId });
-await CapacitorNativeUpdate.resumeDownload({ id: downloadId });
+const downloadId = await NativeUpdate.startDownload();
+await NativeUpdate.pauseDownload({ id: downloadId });
+await NativeUpdate.resumeDownload({ id: downloadId });
 ```
 
 ## Troubleshooting
@@ -580,10 +580,10 @@ await CapacitorNativeUpdate.resumeDownload({ id: downloadId });
 
    ```typescript
    // Check if update was downloaded
-   const { ready } = await CapacitorNativeUpdate.isUpdateReady();
+   const { ready } = await NativeUpdate.isUpdateReady();
    if (ready) {
      // Force apply
-     await CapacitorNativeUpdate.applyUpdate({ force: true });
+     await NativeUpdate.applyUpdate({ force: true });
    }
    ```
 
@@ -591,14 +591,14 @@ await CapacitorNativeUpdate.resumeDownload({ id: downloadId });
 
    ```typescript
    // Verify public key configuration
-   const config = await CapacitorNativeUpdate.getConfiguration();
+   const config = await NativeUpdate.getConfiguration();
    console.log('Public key:', config.publicKey);
    ```
 
 3. **Storage issues**
    ```typescript
    // Clear old versions
-   await CapacitorNativeUpdate.cleanup({
+   await NativeUpdate.cleanup({
      keepVersions: 1,
    });
    ```
@@ -607,14 +607,14 @@ await CapacitorNativeUpdate.resumeDownload({ id: downloadId });
 
 ```typescript
 // Enable debug logging
-await CapacitorNativeUpdate.setDebugMode({ enabled: true });
+await NativeUpdate.setDebugMode({ enabled: true });
 
 // Monitor update events
-CapacitorNativeUpdate.addListener('updateDownloadProgress', (progress) => {
+NativeUpdate.addListener('updateDownloadProgress', (progress) => {
   console.log('Download progress:', progress);
 });
 
-CapacitorNativeUpdate.addListener('updateStateChange', (state) => {
+NativeUpdate.addListener('updateStateChange', (state) => {
   console.log('Update state:', state);
 });
 ```
@@ -623,7 +623,7 @@ CapacitorNativeUpdate.addListener('updateStateChange', (state) => {
 
 ```typescript
 // Verify update system health
-const health = await CapacitorNativeUpdate.getHealth();
+const health = await NativeUpdate.getHealth();
 console.log('Update system health:', {
   enabled: health.enabled,
   lastCheck: health.lastCheck,

package/docs/MIGRATION.md

@@ -13,7 +13,7 @@ If you're migrating from the official Capacitor Live Updates plugin:
 import { LiveUpdates } from '@capacitor/live-updates';
 
 // After
-import { CapacitorNativeUpdate } from 'capacitor-native-update';
+import { NativeUpdate } from 'native-update';
 ```
 
 2. **Update configuration**:
@@ -27,7 +27,7 @@ await LiveUpdates.configure({
 });
 
 // After
-await CapacitorNativeUpdate.configure({
+await NativeUpdate.configure({
   liveUpdate: {
     appId: 'your-app-id',
     serverUrl: 'https://your-server.com',
@@ -45,7 +45,7 @@ await CapacitorNativeUpdate.configure({
 const result = await LiveUpdates.sync();
 
 // After
-const result = await CapacitorNativeUpdate.sync();
+const result = await NativeUpdate.sync();
 ```
 
 ### From Capgo Capacitor Updater
@@ -65,8 +65,8 @@ import { CapacitorUpdater } from '@capgo/capacitor-updater';
 await CapacitorUpdater.download({ url, version });
 
 // Capacitor Native Update
-import { CapacitorNativeUpdate } from 'capacitor-native-update';
-await CapacitorNativeUpdate.download({
+import { NativeUpdate } from 'native-update';
+await NativeUpdate.download({
   url,
   version,
   checksum: 'required-checksum',
@@ -90,7 +90,7 @@ If you're migrating from Ionic Appflow:
 
 ```typescript
 // Similar channel concept
-await CapacitorNativeUpdate.setChannel('production');
+await NativeUpdate.setChannel('production');
 ```
 
 3. **Additional features**:
@@ -124,13 +124,13 @@ If you have existing bundles from another solution:
 
 ```typescript
 // Clear old data and start fresh
-await CapacitorNativeUpdate.reset();
+await NativeUpdate.reset();
 
 // Or manually migrate bundles
 const oldBundles = getOldBundles(); // Your migration logic
 for (const bundle of oldBundles) {
   // Re-download with new security requirements
-  await CapacitorNativeUpdate.download({
+  await NativeUpdate.download({
     url: bundle.url,
     version: bundle.version,
     checksum: await calculateChecksum(bundle.url),
@@ -150,7 +150,7 @@ codePush.sync({
 });
 
 // Convert to:
-await CapacitorNativeUpdate.sync({
+await NativeUpdate.sync({
   updateMode: 'immediate',
 });
 ```
@@ -166,7 +166,7 @@ const config = {
   },
 };
 
-await CapacitorNativeUpdate.configure(config);
+await NativeUpdate.configure(config);
 ```
 
 ## Troubleshooting Migration