native-update 1.0.0 → 1.0.1

package/docs/NATIVE_UPDATES_GUIDE.md

@@ -1,6 +1,6 @@
 # Native App Updates Implementation Guide
 
-This comprehensive guide explains how to implement Native App Updates (App Store and Google Play updates) in your Capacitor application using the CapacitorNativeUpdate plugin.
+This comprehensive guide explains how to implement Native App Updates (App Store and Google Play updates) in your Capacitor application using the NativeUpdate plugin.
 
 ## Table of Contents
 
@@ -61,7 +61,7 @@ Native App Updates allow your app to:
 ### Installation
 
 ```bash
-npm install capacitor-native-update
+npm install native-update
 npx cap sync
 ```
 
@@ -103,7 +103,7 @@ dependencies {
 ### Step 1: Basic Implementation
 
 ```typescript
-import { CapacitorNativeUpdate } from 'capacitor-native-update';
+import { NativeUpdate } from 'native-update';
 import { Capacitor } from '@capacitor/core';
 
 export class NativeUpdateService {
@@ -113,7 +113,7 @@ export class NativeUpdateService {
       const platform = Capacitor.getPlatform();
 
       // Check for native app updates
-      const result = await CapacitorNativeUpdate.checkAppUpdate();
+      const result = await NativeUpdate.checkAppUpdate();
 
       if (result.updateAvailable) {
         console.log(`Update available: ${result.availableVersion}`);
@@ -144,7 +144,7 @@ export class AndroidImmediateUpdate {
   async performImmediateUpdate() {
     try {
       // Start immediate update
-      const { started } = await CapacitorNativeUpdate.startImmediateUpdate();
+      const { started } = await NativeUpdate.startImmediateUpdate();
 
       if (started) {
         // The app will be restarted automatically after update
@@ -187,10 +187,10 @@ export class AndroidFlexibleUpdate {
   async performFlexibleUpdate() {
     try {
       // Start flexible update
-      await CapacitorNativeUpdate.startFlexibleUpdate();
+      await NativeUpdate.startFlexibleUpdate();
 
       // Listen for download progress
-      CapacitorNativeUpdate.addListener(
+      NativeUpdate.addListener(
         'onAppUpdateDownloadProgress',
         (progress) => {
           console.log(
@@ -201,7 +201,7 @@ export class AndroidFlexibleUpdate {
       );
 
       // Listen for download completion
-      CapacitorNativeUpdate.addListener('onAppUpdateDownloaded', () => {
+      NativeUpdate.addListener('onAppUpdateDownloaded', () => {
         console.log('Update downloaded');
         this.updateDownloaded = true;
         this.showInstallPrompt();
@@ -237,7 +237,7 @@ export class AndroidFlexibleUpdate {
 
   async completeFlexibleUpdate() {
     try {
-      await CapacitorNativeUpdate.completeFlexibleUpdate();
+      await NativeUpdate.completeFlexibleUpdate();
       // App will restart with new version
     } catch (error) {
       console.error('Failed to complete update:', error);
@@ -261,7 +261,7 @@ export class AndroidFlexibleUpdate {
 export class iOSAppStoreUpdate {
   async checkAndPromptUpdate() {
     try {
-      const result = await CapacitorNativeUpdate.checkAppUpdate();
+      const result = await NativeUpdate.checkAppUpdate();
 
       if (result.updateAvailable) {
         await this.showiOSUpdateDialog(result);
@@ -293,7 +293,7 @@ export class iOSAppStoreUpdate {
 
   async openAppStore() {
     try {
-      await CapacitorNativeUpdate.openAppStore();
+      await NativeUpdate.openAppStore();
     } catch (error) {
       // Fallback to browser
       const appStoreUrl = `https://apps.apple.com/app/id${YOUR_APP_STORE_ID}`;
@@ -307,14 +307,14 @@ export class iOSAppStoreUpdate {
 
 ```typescript
 import { Capacitor } from '@capacitor/core';
-import { CapacitorNativeUpdate } from 'capacitor-native-update';
+import { NativeUpdate } from 'native-update';
 
 export class UnifiedUpdateService {
   private platform = Capacitor.getPlatform();
 
   async checkAndUpdateApp() {
     try {
-      const updateInfo = await CapacitorNativeUpdate.checkAppUpdate();
+      const updateInfo = await NativeUpdate.checkAppUpdate();
 
       if (!updateInfo.updateAvailable) {
         console.log('App is up to date');
@@ -361,7 +361,7 @@ export class UnifiedUpdateService {
       title: 'Update Available',
       message: `Version ${updateInfo.availableVersion} is available on the App Store.`,
       mandatory: false,
-      action: () => CapacitorNativeUpdate.openAppStore(),
+      action: () => NativeUpdate.openAppStore(),
     });
   }
 
@@ -411,7 +411,7 @@ export class UpdateStatusManager {
 
   private setupUpdateListeners() {
     // Installation status
-    CapacitorNativeUpdate.addListener('onAppUpdateInstallStatus', (status) => {
+    NativeUpdate.addListener('onAppUpdateInstallStatus', (status) => {
       switch (status.status) {
         case 'PENDING':
           console.log('Update pending');
@@ -437,7 +437,7 @@ export class UpdateStatusManager {
     });
 
     // Download progress (Android flexible updates)
-    CapacitorNativeUpdate.addListener(
+    NativeUpdate.addListener(
       'onAppUpdateDownloadProgress',
       (progress) => {
         const percent = Math.round(
@@ -534,7 +534,7 @@ export class UpdateUIService {
 ```typescript
 export class SmartUpdateScheduler {
   async scheduleUpdate() {
-    const updateInfo = await CapacitorNativeUpdate.checkAppUpdate();
+    const updateInfo = await NativeUpdate.checkAppUpdate();
 
     if (!updateInfo.updateAvailable) return;
 
@@ -573,7 +573,7 @@ export class SmartUpdateScheduler {
 
 ```typescript
 // Enable internal app sharing for testing
-await CapacitorNativeUpdate.enableDebugMode({
+await NativeUpdate.enableDebugMode({
   enabled: true,
   testMode: 'internal-test',
 });
@@ -583,13 +583,13 @@ await CapacitorNativeUpdate.enableDebugMode({
 
 ```typescript
 // Test immediate update
-await CapacitorNativeUpdate.simulateUpdate({
+await NativeUpdate.simulateUpdate({
   type: 'immediate',
   version: '2.0.0',
 });
 
 // Test flexible update
-await CapacitorNativeUpdate.simulateUpdate({
+await NativeUpdate.simulateUpdate({
   type: 'flexible',
   version: '1.1.0',
 });
@@ -626,7 +626,7 @@ await CapacitorNativeUpdate.simulateUpdate({
 
 ```typescript
 // Debug update detection
-const debug = await CapacitorNativeUpdate.getDebugInfo();
+const debug = await NativeUpdate.getDebugInfo();
 console.log('Debug info:', {
   currentVersion: debug.currentVersion,
   packageName: debug.packageName,
@@ -639,11 +639,11 @@ console.log('Debug info:', {
 
 ```typescript
 // Check update state
-const state = await CapacitorNativeUpdate.getUpdateState();
+const state = await NativeUpdate.getUpdateState();
 if (state.status === 'FAILED') {
   // Clear update data and retry
-  await CapacitorNativeUpdate.clearUpdateData();
-  await CapacitorNativeUpdate.checkAppUpdate();
+  await NativeUpdate.clearUpdateData();
+  await NativeUpdate.checkAppUpdate();
 }
 ```
 
@@ -651,7 +651,7 @@ if (state.status === 'FAILED') {
 
 ```typescript
 // Verify App Store ID configuration
-const config = await CapacitorNativeUpdate.getConfiguration();
+const config = await NativeUpdate.getConfiguration();
 console.log('App Store ID:', config.appStoreId);
 
 // Manual fallback

package/docs/QUICK_START.md

@@ -10,7 +10,7 @@ Get up and running with Capacitor Native Update in 5 minutes! This guide covers
 
 ```bash
 # Install the plugin
-npm install capacitor-native-update
+npm install native-update
 
 # Sync with native projects
 npx cap sync
@@ -27,7 +27,7 @@ npx cap sync
   "appId": "com.example.app",
   "appName": "MyApp",
   "plugins": {
-    "CapacitorNativeUpdate": {
+    "NativeUpdate": {
       "updateUrl": "https://updates.example.com/api/v1",
       "autoCheck": true,
       "appStoreId": "123456789"
@@ -39,7 +39,7 @@ npx cap sync
 ### 2. Import and Initialize
 
 ```typescript
-import { CapacitorNativeUpdate } from 'capacitor-native-update';
+import { NativeUpdate } from 'native-update';
 
 // Initialize on app start
 export class App {
@@ -65,14 +65,14 @@ Push updates without app store review!
 ### Basic Implementation
 
 ```typescript
-import { CapacitorNativeUpdate } from 'capacitor-native-update';
+import { NativeUpdate } from 'native-update';
 
 export class LiveUpdateService {
   async checkAndApplyUpdates() {
     try {
       // 1. Check for updates
       const { available, version } =
-        await CapacitorNativeUpdate.checkForUpdate();
+        await NativeUpdate.checkForUpdate();
 
       if (!available) {
         console.log('No updates available');
@@ -82,14 +82,14 @@ export class LiveUpdateService {
       console.log(`Update ${version} available!`);
 
       // 2. Download the update
-      await CapacitorNativeUpdate.downloadUpdate({
+      await NativeUpdate.downloadUpdate({
         onProgress: (progress) => {
           console.log(`Download: ${progress.percent}%`);
         },
       });
 
       // 3. Apply the update (app will restart)
-      await CapacitorNativeUpdate.applyUpdate();
+      await NativeUpdate.applyUpdate();
     } catch (error) {
       console.error('Update failed:', error);
     }
@@ -108,7 +108,7 @@ export class UpdateUIService {
 
   async checkForUpdatesWithUI() {
     const { available, version, notes } =
-      await CapacitorNativeUpdate.checkForUpdate();
+      await NativeUpdate.checkForUpdate();
 
     if (!available) return;
 
@@ -135,14 +135,14 @@ export class UpdateUIService {
     await loading.present();
 
     try {
-      await CapacitorNativeUpdate.downloadUpdate({
+      await NativeUpdate.downloadUpdate({
         onProgress: (progress) => {
           loading.message = `Downloading: ${Math.round(progress.percent)}%`;
         },
       });
 
       loading.message = 'Installing...';
-      await CapacitorNativeUpdate.applyUpdate();
+      await NativeUpdate.applyUpdate();
     } catch (error) {
       await loading.dismiss();
       // Show error
@@ -179,7 +179,7 @@ Check for app store updates and install them!
 export class NativeUpdateService {
   async checkForAppStoreUpdates() {
     try {
-      const result = await CapacitorNativeUpdate.checkAppUpdate();
+      const result = await NativeUpdate.checkAppUpdate();
 
       if (!result.updateAvailable) {
         console.log('App is up to date');
@@ -200,10 +200,10 @@ export class NativeUpdateService {
   private async handleAndroidUpdate(result: any) {
     if (result.immediateUpdateAllowed) {
       // Critical update - must install
-      await CapacitorNativeUpdate.startImmediateUpdate();
+      await NativeUpdate.startImmediateUpdate();
     } else {
       // Optional update - download in background
-      await CapacitorNativeUpdate.startFlexibleUpdate();
+      await NativeUpdate.startFlexibleUpdate();
     }
   }
 
@@ -216,7 +216,7 @@ export class NativeUpdateService {
         { text: 'Later', role: 'cancel' },
         {
           text: 'Update',
-          handler: () => CapacitorNativeUpdate.openAppStore(),
+          handler: () => NativeUpdate.openAppStore(),
         },
       ],
     });
@@ -233,10 +233,10 @@ export class AndroidUpdateProgress {
 
   async startFlexibleUpdate() {
     // Start download
-    await CapacitorNativeUpdate.startFlexibleUpdate();
+    await NativeUpdate.startFlexibleUpdate();
 
     // Track progress
-    CapacitorNativeUpdate.addListener(
+    NativeUpdate.addListener(
       'onAppUpdateDownloadProgress',
       (progress) => {
         this.downloadProgress = Math.round(
@@ -246,7 +246,7 @@ export class AndroidUpdateProgress {
     );
 
     // Handle completion
-    CapacitorNativeUpdate.addListener('onAppUpdateDownloaded', async () => {
+    NativeUpdate.addListener('onAppUpdateDownloaded', async () => {
       const alert = await this.alertController.create({
         header: 'Update Ready',
         message: 'Update has been downloaded. Install now?',
@@ -254,7 +254,7 @@ export class AndroidUpdateProgress {
           { text: 'Later' },
           {
             text: 'Install',
-            handler: () => CapacitorNativeUpdate.completeFlexibleUpdate(),
+            handler: () => NativeUpdate.completeFlexibleUpdate(),
           },
         ],
       });
@@ -274,7 +274,7 @@ Request ratings without users leaving your app!
 export class AppReviewService {
   async requestReview() {
     try {
-      const result = await CapacitorNativeUpdate.requestReview();
+      const result = await NativeUpdate.requestReview();
 
       if (result.displayed) {
         console.log('Review prompt shown');
@@ -307,7 +307,7 @@ export class SmartReviewService {
     const enjoying = await this.askIfEnjoying();
 
     if (enjoying) {
-      await CapacitorNativeUpdate.requestReview();
+      await NativeUpdate.requestReview();
     } else {
       await this.askForFeedback();
     }
@@ -388,7 +388,7 @@ Here's everything working together:
 
 ```typescript
 import { Component, OnInit } from '@angular/core';
-import { CapacitorNativeUpdate } from 'capacitor-native-update';
+import { NativeUpdate } from 'native-update';
 import { Capacitor } from '@capacitor/core';
 
 @Component({
@@ -422,11 +422,11 @@ export class AppComponent implements OnInit {
   // Live Updates
   private async checkLiveUpdates() {
     try {
-      const { available } = await CapacitorNativeUpdate.checkForUpdate();
+      const { available } = await NativeUpdate.checkForUpdate();
 
       if (available) {
         // Auto-download in background
-        await CapacitorNativeUpdate.downloadUpdate();
+        await NativeUpdate.downloadUpdate();
 
         // Notify user
         const toast = await this.toastCtrl.create({
@@ -435,7 +435,7 @@ export class AppComponent implements OnInit {
           buttons: [
             {
               text: 'Restart',
-              handler: () => CapacitorNativeUpdate.applyUpdate(),
+              handler: () => NativeUpdate.applyUpdate(),
             },
           ],
         });
@@ -462,12 +462,12 @@ export class AppComponent implements OnInit {
 
   private async checkNativeUpdates() {
     try {
-      const result = await CapacitorNativeUpdate.checkAppUpdate();
+      const result = await NativeUpdate.checkAppUpdate();
 
       if (result.updateAvailable && result.flexibleUpdateAllowed) {
         // Start background download for Android
         if (Capacitor.getPlatform() === 'android') {
-          await CapacitorNativeUpdate.startFlexibleUpdate();
+          await NativeUpdate.startFlexibleUpdate();
         }
       }
     } catch (error) {
@@ -492,7 +492,7 @@ export class AppComponent implements OnInit {
     const canAsk = await this.canAskForReview();
 
     if (canAsk) {
-      await CapacitorNativeUpdate.requestReview();
+      await NativeUpdate.requestReview();
       await this.markReviewRequested();
     }
   }
@@ -545,10 +545,10 @@ curl -X POST http://localhost:3000/api/v1/bundles \
 
 ```typescript
 // Enable debug mode
-await CapacitorNativeUpdate.setReviewDebugMode({ enabled: true });
+await NativeUpdate.setReviewDebugMode({ enabled: true });
 
 // Force show review (debug only)
-await CapacitorNativeUpdate.requestReview({ force: true });
+await NativeUpdate.requestReview({ force: true });
 ```
 
 ## What's Next?
@@ -578,10 +578,10 @@ Now that you have the basics working:
 
 ```typescript
 // Enable debug logging
-await CapacitorNativeUpdate.setDebugMode({ enabled: true });
+await NativeUpdate.setDebugMode({ enabled: true });
 
 // Check configuration
-const config = await CapacitorNativeUpdate.getConfiguration();
+const config = await NativeUpdate.getConfiguration();
 console.log('Update URL:', config.updateUrl);
 ```
 
@@ -599,8 +599,8 @@ console.log('Update URL:', config.updateUrl);
 
 ## Support
 
-- 📖 [Documentation](https://github.com/aoneahsan/capacitor-native-update)
-- 🐛 [Issue Tracker](https://github.com/aoneahsan/capacitor-native-update/issues)
-- 💬 [Discussions](https://github.com/aoneahsan/capacitor-native-update/discussions)
+- 📖 [Documentation](https://github.com/aoneahsan/native-update)
+- 🐛 [Issue Tracker](https://github.com/aoneahsan/native-update/issues)
+- 💬 [Discussions](https://github.com/aoneahsan/native-update/discussions)
 
 Happy updating! 🚀

package/docs/README.md

@@ -56,9 +56,9 @@ Created by **Ahsan Mahmood** and open-sourced for the developer community, this
 
 ## 🚀 Quick Links
 
-- **NPM Package**: [capacitor-native-update](https://www.npmjs.com/package/capacitor-native-update)
-- **GitHub Repository**: [aoneahsan/capacitor-native-update](https://github.com/aoneahsan/capacitor-native-update)
-- **Issue Tracker**: [GitHub Issues](https://github.com/aoneahsan/capacitor-native-update/issues)
+- **NPM Package**: [native-update](https://www.npmjs.com/package/native-update)
+- **GitHub Repository**: [aoneahsan/native-update](https://github.com/aoneahsan/native-update)
+- **Issue Tracker**: [GitHub Issues](https://github.com/aoneahsan/native-update/issues)
 - **Author**: [Ahsan Mahmood](https://aoneahsan.com)
 
 ## 💡 Key Features
@@ -92,11 +92,11 @@ Consistent API across iOS, Android, and Web platforms with platform-specific opt
 
 ## 🤝 Contributing
 
-We welcome contributions from the community! Please see our [Contributing Guide](https://github.com/aoneahsan/capacitor-native-update/blob/main/CONTRIBUTING.md) for details.
+We welcome contributions from the community! Please see our [Contributing Guide](https://github.com/aoneahsan/native-update/blob/main/CONTRIBUTING.md) for details.
 
 ## 📄 License
 
-This project is licensed under the MIT License. See the [LICENSE](https://github.com/aoneahsan/capacitor-native-update/blob/main/LICENSE) file for details.
+This project is licensed under the MIT License. See the [LICENSE](https://github.com/aoneahsan/native-update/blob/main/LICENSE) file for details.
 
 ## 👨‍💻 About the Author
 

package/docs/api/app-review-api.md

@@ -9,7 +9,7 @@ Complete API documentation for in-app review functionality.
 Request an in-app review dialog.
 
 ```typescript
-const result = await CapacitorNativeUpdate.requestReview({
+const result = await NativeUpdate.requestReview({
   force?: boolean;  // Bypass rate limiting (testing only)
 });
 // Returns:
@@ -27,7 +27,7 @@ const result = await CapacitorNativeUpdate.requestReview({
 Check if a review can be requested (respects rate limits).
 
 ```typescript
-const result = await CapacitorNativeUpdate.canRequestReview();
+const result = await NativeUpdate.canRequestReview();
 // Returns:
 {
   canRequest: boolean;
@@ -43,7 +43,7 @@ const result = await CapacitorNativeUpdate.canRequestReview();
 Open the app store review page directly.
 
 ```typescript
-await CapacitorNativeUpdate.openStoreReview();
+await NativeUpdate.openStoreReview();
 // Opens app store with review section focused
 ```
 
@@ -52,7 +52,7 @@ await CapacitorNativeUpdate.openStoreReview();
 Get the store review URL without opening it.
 
 ```typescript
-const result = await CapacitorNativeUpdate.getStoreReviewUrl();
+const result = await NativeUpdate.getStoreReviewUrl();
 // Returns:
 {
   url: string;  // Direct review URL
@@ -65,7 +65,7 @@ const result = await CapacitorNativeUpdate.getStoreReviewUrl();
 Reset review request history (testing only).
 
 ```typescript
-await CapacitorNativeUpdate.resetReviewPrompts();
+await NativeUpdate.resetReviewPrompts();
 ```
 
 ### setReviewConditions(conditions)
@@ -73,7 +73,7 @@ await CapacitorNativeUpdate.resetReviewPrompts();
 Set conditions for when to show review prompts.
 
 ```typescript
-await CapacitorNativeUpdate.setReviewConditions({
+await NativeUpdate.setReviewConditions({
   minimumDaysSinceInstall?: number;    // Default: 3
   minimumDaysSinceLastPrompt?: number; // Default: 90
   minimumAppLaunches?: number;         // Default: 5
@@ -86,7 +86,7 @@ await CapacitorNativeUpdate.setReviewConditions({
 Track significant events for review timing.
 
 ```typescript
-await CapacitorNativeUpdate.trackSignificantEvent(eventName: string);
+await NativeUpdate.trackSignificantEvent(eventName: string);
 // Examples: 'purchase_completed', 'level_completed', 'content_shared'
 ```
 
@@ -97,7 +97,7 @@ await CapacitorNativeUpdate.trackSignificantEvent(eventName: string);
 Fired when review prompt is shown.
 
 ```typescript
-CapacitorNativeUpdate.addListener('reviewPromptDisplayed', (event) => {
+NativeUpdate.addListener('reviewPromptDisplayed', (event) => {
   console.log('Review prompt shown on:', event.platform);
   analytics.track('review_prompt_displayed');
 });
@@ -108,7 +108,7 @@ CapacitorNativeUpdate.addListener('reviewPromptDisplayed', (event) => {
 Fired when review prompt is dismissed.
 
 ```typescript
-CapacitorNativeUpdate.addListener('reviewPromptDismissed', (event) => {
+NativeUpdate.addListener('reviewPromptDismissed', (event) => {
   console.log('Review prompt dismissed');
   analytics.track('review_prompt_dismissed');
 });
@@ -151,9 +151,9 @@ async function onPurchaseComplete() {
   
   // Wait a bit, then request review
   setTimeout(async () => {
-    const { canRequest } = await CapacitorNativeUpdate.canRequestReview();
+    const { canRequest } = await NativeUpdate.canRequestReview();
     if (canRequest) {
-      await CapacitorNativeUpdate.requestReview();
+      await NativeUpdate.requestReview();
     }
   }, 2000);
 }
@@ -173,7 +173,7 @@ const SIGNIFICANT_EVENTS = [
 
 async function trackUserAction(action: string) {
   if (SIGNIFICANT_EVENTS.includes(action)) {
-    await CapacitorNativeUpdate.trackSignificantEvent(action);
+    await NativeUpdate.trackSignificantEvent(action);
   }
 }
 ```
@@ -182,7 +182,7 @@ async function trackUserAction(action: string) {
 
 ```typescript
 // Configure smart conditions
-await CapacitorNativeUpdate.setReviewConditions({
+await NativeUpdate.setReviewConditions({
   minimumDaysSinceInstall: 7,      // Week after install
   minimumDaysSinceLastPrompt: 120, // 4 months between
   minimumAppLaunches: 10,           // Regular user
@@ -195,13 +195,13 @@ await CapacitorNativeUpdate.setReviewConditions({
 ```typescript
 async function requestReviewSmart() {
   try {
-    const { displayed } = await CapacitorNativeUpdate.requestReview();
+    const { displayed } = await NativeUpdate.requestReview();
     
     if (!displayed) {
       // Fallback: Show custom UI with store link
       const response = await showCustomReviewDialog();
       if (response === 'yes') {
-        await CapacitorNativeUpdate.openStoreReview();
+        await NativeUpdate.openStoreReview();
       }
     }
   } catch (error) {