native-update 1.0.0 → 1.0.1

package/docs/features/live-updates.md

@@ -57,7 +57,7 @@ Live Updates, also known as Over-The-Air (OTA) updates, allow you to deploy Java
 
 ```typescript
 // 1. Configure live updates
-await CapacitorNativeUpdate.configure({
+await NativeUpdate.configure({
   liveUpdate: {
     appId: 'com.myapp.example',
     serverUrl: 'https://updates.myserver.com',
@@ -66,7 +66,7 @@ await CapacitorNativeUpdate.configure({
 });
 
 // 2. Sync updates (automatic with autoUpdate: true)
-const result = await CapacitorNativeUpdate.LiveUpdate.sync();
+const result = await NativeUpdate.LiveUpdate.sync();
 
 // 3. Handle the result
 switch (result.status) {
@@ -87,7 +87,7 @@ class LiveUpdateManager {
 
   async initialize() {
     // Configure with advanced options
-    await CapacitorNativeUpdate.configure({
+    await NativeUpdate.configure({
       liveUpdate: {
         appId: 'com.myapp.example',
         serverUrl: 'https://updates.myserver.com',
@@ -108,7 +108,7 @@ class LiveUpdateManager {
 
   private setupUpdateListeners() {
     // Download progress
-    CapacitorNativeUpdate.LiveUpdate.addListener(
+    NativeUpdate.LiveUpdate.addListener(
       'downloadProgress',
       (progress) => {
         this.updateDownloadProgress(progress.percent);
@@ -116,7 +116,7 @@ class LiveUpdateManager {
     );
 
     // State changes
-    CapacitorNativeUpdate.LiveUpdate.addListener(
+    NativeUpdate.LiveUpdate.addListener(
       'updateStateChanged',
       (event) => {
         this.handleStateChange(event);
@@ -126,8 +126,8 @@ class LiveUpdateManager {
 
   async checkForUpdates() {
     try {
-      const latest = await CapacitorNativeUpdate.LiveUpdate.getLatest();
-      const current = await CapacitorNativeUpdate.LiveUpdate.current();
+      const latest = await NativeUpdate.LiveUpdate.getLatest();
+      const current = await NativeUpdate.LiveUpdate.current();
 
       if (this.isNewerVersion(latest.version, current.version)) {
         this.updateAvailable = true;
@@ -142,7 +142,7 @@ class LiveUpdateManager {
     if (!this.updateAvailable) return;
 
     try {
-      const bundle = await CapacitorNativeUpdate.LiveUpdate.download({
+      const bundle = await NativeUpdate.LiveUpdate.download({
         version: 'latest',
         onProgress: (progress) => {
           console.log(`Download: ${progress.percent}%`);
@@ -150,7 +150,7 @@ class LiveUpdateManager {
       });
 
       // Validate the bundle
-      const validation = await CapacitorNativeUpdate.LiveUpdate.validateUpdate({
+      const validation = await NativeUpdate.LiveUpdate.validateUpdate({
         bundleId: bundle.bundleId,
       });
 
@@ -166,10 +166,10 @@ class LiveUpdateManager {
 
   async installUpdate(bundle: BundleInfo) {
     // Set the bundle as active
-    await CapacitorNativeUpdate.LiveUpdate.set(bundle);
+    await NativeUpdate.LiveUpdate.set(bundle);
 
     // Notify app is ready (important for rollback mechanism)
-    await CapacitorNativeUpdate.LiveUpdate.notifyAppReady();
+    await NativeUpdate.LiveUpdate.notifyAppReady();
 
     // Schedule reload based on user preference
     this.scheduleReload();
@@ -177,12 +177,12 @@ class LiveUpdateManager {
 
   private scheduleReload() {
     // Option 1: Immediate reload
-    // await CapacitorNativeUpdate.LiveUpdate.reload();
+    // await NativeUpdate.LiveUpdate.reload();
 
     // Option 2: Reload on next app resume
     App.addListener('appStateChange', ({ isActive }) => {
       if (isActive) {
-        CapacitorNativeUpdate.LiveUpdate.reload();
+        NativeUpdate.LiveUpdate.reload();
       }
     });
 
@@ -254,7 +254,7 @@ The plugin uses semantic versioning (MAJOR.MINOR.PATCH):
 
 ```typescript
 // Version comparison
-const current = await CapacitorNativeUpdate.LiveUpdate.current();
+const current = await NativeUpdate.LiveUpdate.current();
 console.log(current.version); // "1.2.3"
 
 // Check if update is major/minor/patch
@@ -273,7 +273,7 @@ function getUpdateType(oldVersion: string, newVersion: string) {
 
 ```typescript
 // List all downloaded bundles
-const bundles = await CapacitorNativeUpdate.LiveUpdate.list();
+const bundles = await NativeUpdate.LiveUpdate.list();
 
 bundles.forEach((bundle) => {
   console.log(`Version: ${bundle.version}`);
@@ -283,7 +283,7 @@ bundles.forEach((bundle) => {
 });
 
 // Clean up old bundles
-await CapacitorNativeUpdate.LiveUpdate.delete({
+await NativeUpdate.LiveUpdate.delete({
   keepNewest: 3, // Keep only 3 most recent bundles
 });
 ```
@@ -302,7 +302,7 @@ async function onAppReady() {
     await performHealthCheck();
 
     // Notify that app started successfully
-    await CapacitorNativeUpdate.LiveUpdate.notifyAppReady();
+    await NativeUpdate.LiveUpdate.notifyAppReady();
   } catch (error) {
     // Don't call notifyAppReady() - automatic rollback will occur
     console.error('App startup failed:', error);
@@ -314,14 +314,14 @@ async function onAppReady() {
 
 ```typescript
 // Reset to original bundle
-await CapacitorNativeUpdate.LiveUpdate.reset();
+await NativeUpdate.LiveUpdate.reset();
 
 // Or rollback to previous version
-const bundles = await CapacitorNativeUpdate.LiveUpdate.list();
+const bundles = await NativeUpdate.LiveUpdate.list();
 const previousBundle = bundles[bundles.length - 2];
 if (previousBundle) {
-  await CapacitorNativeUpdate.LiveUpdate.set(previousBundle);
-  await CapacitorNativeUpdate.LiveUpdate.reload();
+  await NativeUpdate.LiveUpdate.set(previousBundle);
+  await NativeUpdate.LiveUpdate.reload();
 }
 ```
 
@@ -334,7 +334,7 @@ Use channels to manage different release tracks.
 ```typescript
 // Set channel based on user preference
 const channel = getUserPreference('updateChannel') || 'production';
-await CapacitorNativeUpdate.LiveUpdate.setChannel(channel);
+await NativeUpdate.LiveUpdate.setChannel(channel);
 
 // Available channels examples:
 // - 'production': Stable releases
@@ -349,7 +349,7 @@ await CapacitorNativeUpdate.LiveUpdate.setChannel(channel);
 ```typescript
 // Enable features based on channel
 async function getFeatureFlags() {
-  const bundle = await CapacitorNativeUpdate.LiveUpdate.current();
+  const bundle = await NativeUpdate.LiveUpdate.current();
 
   switch (bundle.metadata?.channel) {
     case 'alpha':
@@ -379,7 +379,7 @@ async function getFeatureFlags() {
 2. **Implement delta updates** (coming soon):
    ```typescript
    // Future API
-   const delta = await CapacitorNativeUpdate.LiveUpdate.downloadDelta({
+   const delta = await NativeUpdate.LiveUpdate.downloadDelta({
      fromVersion: current.version,
      toVersion: latest.version,
    });
@@ -410,12 +410,12 @@ async function getFeatureFlags() {
 
 ```typescript
 // Monitor storage usage
-const storage = await CapacitorNativeUpdate.LiveUpdate.getStorageInfo();
+const storage = await NativeUpdate.LiveUpdate.getStorageInfo();
 console.log(`Used: ${storage.usedBytes} / ${storage.totalBytes}`);
 
 // Clean up when needed
 if (storage.usedBytes > storage.totalBytes * 0.8) {
-  await CapacitorNativeUpdate.LiveUpdate.delete({
+  await NativeUpdate.LiveUpdate.delete({
     olderThan: Date.now() - 30 * 24 * 60 * 60 * 1000, // 30 days
   });
 }
@@ -427,7 +427,7 @@ if (storage.usedBytes > storage.totalBytes * 0.8) {
 
 ```typescript
 try {
-  await CapacitorNativeUpdate.LiveUpdate.sync();
+  await NativeUpdate.LiveUpdate.sync();
 } catch (error) {
   switch (error.code) {
     case 'NETWORK_ERROR':
@@ -442,7 +442,7 @@ try {
 
     case 'CHECKSUM_ERROR':
       // Bundle corrupted
-      await CapacitorNativeUpdate.LiveUpdate.delete({
+      await NativeUpdate.LiveUpdate.delete({
         bundleId: error.bundleId,
       });
       break;
@@ -474,7 +474,7 @@ class UpdateRetryManager {
 
   async syncWithRetry() {
     try {
-      await CapacitorNativeUpdate.LiveUpdate.sync();
+      await NativeUpdate.LiveUpdate.sync();
       this.retryCount = 0; // Reset on success
     } catch (error) {
       if (this.shouldRetry(error)) {
@@ -526,7 +526,7 @@ const devConfig = {
 };
 
 // Force update check
-await CapacitorNativeUpdate.LiveUpdate.sync({ forceCheck: true });
+await NativeUpdate.LiveUpdate.sync({ forceCheck: true });
 
 // Simulate different scenarios
 await testUpdateScenarios();
@@ -565,7 +565,7 @@ function shouldReceiveUpdate(userId: string, percentage: number): boolean {
 
 if (shouldReceiveUpdate(user.id, 10)) {
   // 10% rollout
-  await CapacitorNativeUpdate.LiveUpdate.setChannel('beta');
+  await NativeUpdate.LiveUpdate.setChannel('beta');
 }
 ```
 
@@ -573,7 +573,7 @@ if (shouldReceiveUpdate(user.id, 10)) {
 
 ```typescript
 // Notify users about updates
-CapacitorNativeUpdate.LiveUpdate.addListener('updateStateChanged', (event) => {
+NativeUpdate.LiveUpdate.addListener('updateStateChanged', (event) => {
   if (event.status === 'READY') {
     showNotification({
       title: 'Update Ready',

package/docs/getting-started/configuration.md

@@ -17,7 +17,7 @@ This guide covers all configuration options available in Capacitor Native Update
 The plugin is configured using the `configure()` method with an `UpdateConfig` object:
 
 ```typescript
-await CapacitorNativeUpdate.configure({
+await NativeUpdate.configure({
   liveUpdate: {
     /* Live update settings */
   },
@@ -264,7 +264,7 @@ security: {
 ```typescript
 const isDevelopment = process.env.NODE_ENV === 'development';
 
-await CapacitorNativeUpdate.configure({
+await NativeUpdate.configure({
   liveUpdate: {
     appId: 'com.yourcompany.app.dev',
     serverUrl: isDevelopment
@@ -315,7 +315,7 @@ const environments: Record<string, Environment> = {
 
 const currentEnv = environments[process.env.APP_ENV || 'production'];
 
-await CapacitorNativeUpdate.configure({
+await NativeUpdate.configure({
   liveUpdate: {
     appId: 'com.yourcompany.app',
     serverUrl: currentEnv.serverUrl,
@@ -332,13 +332,13 @@ await CapacitorNativeUpdate.configure({
 
 ```typescript
 // Change update channel
-await CapacitorNativeUpdate.LiveUpdate.setChannel('beta');
+await NativeUpdate.LiveUpdate.setChannel('beta');
 
 // Change server URL
-await CapacitorNativeUpdate.LiveUpdate.setUpdateUrl('https://new-server.com');
+await NativeUpdate.LiveUpdate.setUpdateUrl('https://new-server.com');
 
 // Update security settings
-await CapacitorNativeUpdate.Security.updateConfig({
+await NativeUpdate.Security.updateConfig({
   enforceHttps: true,
   requireSignature: true,
 });
@@ -354,7 +354,7 @@ async function loadRemoteConfig() {
     const remoteConfig = await response.json();
 
     // Apply remote configuration
-    await CapacitorNativeUpdate.configure({
+    await NativeUpdate.configure({
       liveUpdate: {
         appId: remoteConfig.appId,
         serverUrl: remoteConfig.updateServer,
@@ -448,7 +448,7 @@ The plugin validates all configuration options and will throw descriptive errors
 
 ```typescript
 try {
-  await CapacitorNativeUpdate.configure(config);
+  await NativeUpdate.configure(config);
 } catch (error) {
   if (error.code === 'INVALID_CONFIG') {
     console.error('Configuration error:', error.message);

package/docs/getting-started/installation.md

@@ -110,10 +110,10 @@ No additional setup is required for web platform. The plugin provides fallback i
 In your app's initialization code (e.g., `main.ts`, `app.component.ts`, or `App.jsx`):
 
 ```typescript
-import { CapacitorNativeUpdate } from 'native-update';
+import { NativeUpdate } from 'native-update';
 
 // Basic initialization
-await CapacitorNativeUpdate.configure({
+await NativeUpdate.configure({
   liveUpdate: {
     appId: 'your-app-id',
     serverUrl: 'https://your-update-server.com',
@@ -141,11 +141,11 @@ To verify the installation:
 
    ```typescript
    // Get current bundle info
-   const currentBundle = await CapacitorNativeUpdate.LiveUpdate.current();
+   const currentBundle = await NativeUpdate.LiveUpdate.current();
    console.log('Current bundle:', currentBundle);
 
    // Check for updates
-   const latest = await CapacitorNativeUpdate.LiveUpdate.getLatest();
+   const latest = await NativeUpdate.LiveUpdate.getLatest();
    console.log('Latest version available:', latest);
    ```
 

package/docs/getting-started/quick-start.md

@@ -19,11 +19,11 @@ Get up and running with Capacitor Native Update in just a few minutes! This guid
 ### 1. Import and Configure
 
 ```typescript
-import { CapacitorNativeUpdate } from 'native-update';
+import { NativeUpdate } from 'native-update';
 
 // Initialize the plugin with your configuration
 async function initializeUpdates() {
-  await CapacitorNativeUpdate.configure({
+  await NativeUpdate.configure({
     liveUpdate: {
       appId: 'com.yourcompany.app',
       serverUrl: 'https://updates.yourserver.com',
@@ -54,7 +54,7 @@ initializeUpdates();
 // Sync with server and apply updates if available
 async function syncUpdates() {
   try {
-    const result = await CapacitorNativeUpdate.LiveUpdate.sync();
+    const result = await NativeUpdate.LiveUpdate.sync();
 
     if (result.status === 'UPDATE_INSTALLED') {
       console.log('Update installed:', result.bundle.version);
@@ -73,8 +73,8 @@ async function syncUpdates() {
 ```typescript
 // Check for updates without downloading
 async function checkForUpdates() {
-  const latest = await CapacitorNativeUpdate.LiveUpdate.getLatest();
-  const current = await CapacitorNativeUpdate.LiveUpdate.current();
+  const latest = await NativeUpdate.LiveUpdate.getLatest();
+  const current = await NativeUpdate.LiveUpdate.current();
 
   if (latest.version !== current.version) {
     console.log(`Update available: ${latest.version}`);
@@ -87,15 +87,15 @@ async function checkForUpdates() {
 async function downloadAndInstallUpdate() {
   try {
     // Download the latest version
-    const bundle = await CapacitorNativeUpdate.LiveUpdate.download({
+    const bundle = await NativeUpdate.LiveUpdate.download({
       version: 'latest',
     });
 
     // Set it as active
-    await CapacitorNativeUpdate.LiveUpdate.set(bundle);
+    await NativeUpdate.LiveUpdate.set(bundle);
 
     // Reload the app to apply
-    await CapacitorNativeUpdate.LiveUpdate.reload();
+    await NativeUpdate.LiveUpdate.reload();
   } catch (error) {
     console.error('Update failed:', error);
   }
@@ -106,7 +106,7 @@ async function downloadAndInstallUpdate() {
 
 ```typescript
 // Add download progress listener
-const progressListener = await CapacitorNativeUpdate.LiveUpdate.addListener(
+const progressListener = await NativeUpdate.LiveUpdate.addListener(
   'downloadProgress',
   (progress) => {
     console.log(`Download: ${progress.percent}% complete`);
@@ -125,14 +125,14 @@ const progressListener = await CapacitorNativeUpdate.LiveUpdate.addListener(
 ```typescript
 async function checkAppStoreUpdate() {
   try {
-    const updateInfo = await CapacitorNativeUpdate.AppUpdate.getAppUpdateInfo();
+    const updateInfo = await NativeUpdate.AppUpdate.getAppUpdateInfo();
 
     if (updateInfo.updateAvailable) {
       console.log(`New version available: ${updateInfo.availableVersion}`);
 
       if (updateInfo.updatePriority >= 4) {
         // High priority - immediate update
-        await CapacitorNativeUpdate.AppUpdate.performImmediateUpdate();
+        await NativeUpdate.AppUpdate.performImmediateUpdate();
       } else {
         // Optional update
         showUpdateDialog(updateInfo);
@@ -146,7 +146,7 @@ async function checkAppStoreUpdate() {
 function showUpdateDialog(updateInfo) {
   // Show your custom update UI
   if (userAcceptsUpdate) {
-    CapacitorNativeUpdate.AppUpdate.openAppStore();
+    NativeUpdate.AppUpdate.openAppStore();
   }
 }
 ```
@@ -156,10 +156,10 @@ function showUpdateDialog(updateInfo) {
 ```typescript
 // Start downloading in background
 async function startFlexibleUpdate() {
-  await CapacitorNativeUpdate.AppUpdate.startFlexibleUpdate();
+  await NativeUpdate.AppUpdate.startFlexibleUpdate();
 
   // Listen for download completion
-  const listener = await CapacitorNativeUpdate.AppUpdate.addListener(
+  const listener = await NativeUpdate.AppUpdate.addListener(
     'flexibleUpdateStateChanged',
     (state) => {
       if (state.status === 'DOWNLOADED') {
@@ -172,7 +172,7 @@ async function startFlexibleUpdate() {
 
 // Complete the update
 async function completeUpdate() {
-  await CapacitorNativeUpdate.AppUpdate.completeFlexibleUpdate();
+  await NativeUpdate.AppUpdate.completeFlexibleUpdate();
   // App will restart with new version
 }
 ```
@@ -185,11 +185,11 @@ async function completeUpdate() {
 async function requestReviewIfAppropriate() {
   try {
     // Check if we can request a review
-    const canRequest = await CapacitorNativeUpdate.AppReview.canRequestReview();
+    const canRequest = await NativeUpdate.AppReview.canRequestReview();
 
     if (canRequest.allowed) {
       // Request the review
-      const result = await CapacitorNativeUpdate.AppReview.requestReview();
+      const result = await NativeUpdate.AppReview.requestReview();
 
       if (result.shown) {
         console.log('Review dialog was shown');
@@ -214,12 +214,12 @@ requestReviewIfAppropriate();
 ```typescript
 // In your main app component
 import { App } from '@capacitor/app';
-import { CapacitorNativeUpdate } from 'native-update';
+import { NativeUpdate } from 'native-update';
 
 App.addListener('appStateChange', async ({ isActive }) => {
   if (isActive) {
     // Check for updates when app becomes active
-    await CapacitorNativeUpdate.LiveUpdate.sync({
+    await NativeUpdate.LiveUpdate.sync({
       installMode: 'ON_NEXT_RESUME',
     });
   }
@@ -232,7 +232,7 @@ App.addListener('appStateChange', async ({ isActive }) => {
 class UpdateManager {
   async initialize() {
     // Configure plugin
-    await CapacitorNativeUpdate.configure({
+    await NativeUpdate.configure({
       liveUpdate: {
         appId: 'your-app-id',
         serverUrl: 'https://your-server.com',
@@ -249,7 +249,7 @@ class UpdateManager {
 
   setupListeners() {
     // Listen for update state changes
-    CapacitorNativeUpdate.LiveUpdate.addListener(
+    NativeUpdate.LiveUpdate.addListener(
       'updateStateChanged',
       (event) => {
         console.log('Update state:', event.status);
@@ -260,7 +260,7 @@ class UpdateManager {
 
   async checkForUpdates() {
     try {
-      const result = await CapacitorNativeUpdate.LiveUpdate.sync();
+      const result = await NativeUpdate.LiveUpdate.sync();
 
       if (result.status === 'UPDATE_INSTALLED') {
         // Notify user about update
@@ -290,13 +290,13 @@ class UpdateManager {
 ### Error Handling Best Practices
 
 ```typescript
-import { CapacitorNativeUpdateError } from 'capacitor-native-update';
+import { NativeUpdateError } from 'native-update';
 
 async function safeUpdateCheck() {
   try {
-    await CapacitorNativeUpdate.LiveUpdate.sync();
+    await NativeUpdate.LiveUpdate.sync();
   } catch (error) {
-    if (error instanceof CapacitorNativeUpdateError) {
+    if (error instanceof NativeUpdateError) {
       switch (error.code) {
         case 'NETWORK_ERROR':
           // Handle network issues
@@ -325,13 +325,13 @@ async function safeUpdateCheck() {
 1. **Use staging channel for testing**:
 
    ```typescript
-   await CapacitorNativeUpdate.LiveUpdate.setChannel('staging');
+   await NativeUpdate.LiveUpdate.setChannel('staging');
    ```
 
 2. **Enable debug mode for app reviews**:
 
    ```typescript
-   await CapacitorNativeUpdate.configure({
+   await NativeUpdate.configure({
      appReview: {
        debugMode: true, // Bypass time restrictions
      },
@@ -341,7 +341,7 @@ async function safeUpdateCheck() {
 3. **Force update check**:
    ```typescript
    // Clear cache and check
-   await CapacitorNativeUpdate.LiveUpdate.sync({
+   await NativeUpdate.LiveUpdate.sync({
      forceCheck: true,
    });
    ```

package/docs/guides/deployment-guide.md

@@ -100,7 +100,7 @@ const keys = await generateKeyPair();
 ### 2. Configure Plugin
 
 ```typescript
-await CapacitorNativeUpdate.configure({
+await NativeUpdate.configure({
   serverUrl: 'https://updates.your-domain.com',
   publicKey: PRODUCTION_PUBLIC_KEY,
   channel: 'production',
@@ -303,7 +303,7 @@ aws s3 sync ./storage/bundles s3://your-backup-bucket/bundles
 
 ```typescript
 // Enable debug logging in production
-CapacitorNativeUpdate.configure({
+NativeUpdate.configure({
   debug: process.env.NODE_ENV !== 'production',
   serverUrl: 'https://updates.your-domain.com',
 });

package/docs/guides/migration-from-codepush.md

@@ -38,7 +38,7 @@ Replace CodePush imports:
 import codePush from 'react-native-code-push';
 
 // New (Capacitor Native Update)
-import { CapacitorNativeUpdate } from 'capacitor-native-update';
+import { NativeUpdate } from 'native-update';
 ```
 
 ### 3. Configure Plugin
@@ -53,7 +53,7 @@ const codePushOptions = {
 };
 
 // New (Capacitor Native Update)
-await CapacitorNativeUpdate.configure({
+await NativeUpdate.configure({
   serverUrl: 'https://your-update-server.com',
   channel: 'production',
   autoCheck: true,
@@ -73,10 +73,10 @@ codePush.sync({
 });
 
 // New (Capacitor Native Update)
-const update = await CapacitorNativeUpdate.checkForUpdate();
+const update = await NativeUpdate.checkForUpdate();
 if (update.available) {
-  await CapacitorNativeUpdate.downloadUpdate();
-  await CapacitorNativeUpdate.applyUpdate();
+  await NativeUpdate.downloadUpdate();
+  await NativeUpdate.applyUpdate();
 }
 ```