@turbopush/react-native-code-push 10.2.5 → 10.2.6

package/LICENSE.md

@@ -1,5 +1,7 @@
-Microsoft CodePush Plugin for React Native
+Turbopush React Native Plugin for CodePush
+Copyright (c) Turbopush
 
+Based on Microsoft CodePush Plugin for React Native
 Copyright (c) Microsoft Corporation
 
 All rights reserved. 

package/README.md

@@ -1,44 +1,86 @@
-# React Native Module for CodePush
-## 🌐 [Turbopush](https://turbopush.org)
-## 🚀 [Sign up](https://accounts.turbopush.org/sign-up) to use Turbopush
-## 📚 [Documentation](https://docs.turbopush.org) to get started
+# Turbopush — React Native Plugin for CodePush
 
-This plugin provides client-side integration for the [Turbopush service](https://turbopush.org/), allowing you to easily add a dynamic update experience to your React Native or Expo app(s).
+[![npm version](https://img.shields.io/npm/v/@turbopush/react-native-code-push.svg)](https://www.npmjs.com/package/@turbopush/react-native-code-push)
+[![license](https://img.shields.io/npm/l/@turbopush/react-native-code-push.svg)](LICENSE.md)
+
+## [Sign up](https://accounts.turbopush.org/sign-up?utm_source=readme) to use Turbopush | [Documentation](https://turbopush.org/docs?utm_source=readme) to get started
+
+This plugin provides client-side integration for the [Turbopush service](https://turbopush.org/?utm_source=readme), allowing you to easily add a dynamic update experience to your React Native or Expo app(s).
+
+---
+
+## Table of Contents
+
+- [How does it work?](#how-does-it-work)
+- [Key Features](#key-features)
+- [Requirements](#requirements)
+- [React Native Setup](#react-native-setup)
+- [Expo Setup](#expo-setup)
+- [Basic Usage](#basic-usage)
+- [Store Guideline Compliance](#store-guideline-compliance)
+- [Contributing](#contributing)
+- [License](#license)
+
+---
 
 ## How does it work?
 
 A React Native app is composed of JavaScript files and any accompanying [images](https://reactnative.dev/docs/image), which are bundled together by the [metro bundler](https://github.com/facebook/metro) and distributed as part of a platform-specific binary (i.e. an `.ipa` or `.apk` file). Once the app is released, updating either the JavaScript code (e.g. making bug fixes, adding new features) or image assets, requires you to recompile and redistribute the entire binary, which of course, includes any review time associated with the store(s) you are publishing to.
 
-The Turbopush plugin helps get product improvements in front of your end users instantly, by keeping your JavaScript and images synchronized with updates you release to the Turbopush server. This way, your app gets the benefits of an offline mobile experience, as well as the "web-like" agility of side-loading updates as soon as they are available. It's a win-win!
+The Turbopush plugin helps get product improvements in front of your end users instantly, by keeping your JavaScript and images synchronized with updates you release to the Turbopush server. This way, your app gets the benefits of an offline mobile experience, as well as the "web-like" agility of side-loading updates as soon as they are available.
+
+In order to ensure that your end users always have a functioning version of your app, the Turbopush plugin maintains a copy of the previous update, so that in the event that you accidentally push an update which includes a crash, it can automatically roll back. This way, you can rest assured that your newfound release agility won't result in users becoming blocked before you have a chance to roll back on the server.
+
+> **Note:** Any product changes which touch native code (e.g. modifying your `AppDelegate.mm`/`MainActivity.java`/`MainActivity.kt`/`AppDelegate.swift` file, adding a new plugin) cannot be distributed via Turbopush, and therefore, must be updated via the appropriate store(s).
+
+---
+
+## Key Features
+
+- **Automatic Rollback**: If an update causes a crash, the plugin automatically rolls back to the previous working version.
+- **Multiple Platforms**: Supports Android and iOS.
+- **Multiple Channels**: Release updates to different groups of users via separate channels.
+- **Multiple Environments**: Test updates in staging before releasing to all users.
+- **Expo Support**: First-class support via our [Expo plugin](https://turbopush.org/docs/setup/expo-setup?utm_source=readme).
+- **New Architecture**: Supports both React Native old and new architecture (Fabric/TurboModules).
+
+---
 
-In order to ensure that your end users always have a functioning version of your app, the Turbopush plugin maintains a copy of the previous update, so that in the event that you accidentally push an update which includes a crash, it can automatically roll back. This way, you can rest assured that your newfound release agility won't result in users becoming blocked before you have a chance to roll back on the server. It's a win-win-win!
+## Requirements
 
-*Note: Any product changes which touch native code (e.g. modifying your `AppDelegate.mm`/`MainActivity.java`/`MainActivity.kt`/`AppDelegate.swift` file, adding a new plugin) cannot be distributed via Turbopush, and therefore, must be updated via the appropriate store(s).*
+- **React Native**: 0.70 or higher
+- **iOS**: 15.5 or higher
+- **Android**: API level 21 (Android 5.0) or higher
+- **Node**: 16 or higher
+
+---
 
 ## React Native Setup
 
-Yarn:
+NPM:
 ```bash
-yarn add @turbopush/react-native-code-push
+npm install --save @turbopush/react-native-code-push
 ```
 
-NPM:
+Yarn:
 ```bash
-npm install --save @turbopush/react-native-code-push
+yarn add @turbopush/react-native-code-push
 ```
 
-Follow the [Getting Started](https://docs.turbopush.org/?platform=react-native) guide to configure your app.
+Follow the [Getting Started](https://turbopush.org/docs/?platform=react-native&utm_source=readme) guide to configure your app.
+
+---
 
 ## Expo Setup
 
-Yarn:
+NPM:
 ```bash
-yarn add @turbopush/react-native-code-push @turbopush/turbopush-expo-plugin expo-build-properties
+npm install --save @turbopush/react-native-code-push @turbopush/turbopush-expo-plugin expo-build-properties
 ```
 
-NPM:
+Yarn:
 ```bash
-npm install --save @turbopush/react-native-code-push @turbopush/turbopush-expo-plugin expo-build-properties
+yarn add @turbopush/react-native-code-push @turbopush/turbopush-expo-plugin expo-build-properties
 ```
 
 Add the following to your `app.json` or `app.config.ts` file:
@@ -50,57 +92,94 @@ Add the following to your `app.json` or `app.config.ts` file:
       "expo-build-properties",
       {
         "ios": {
-          "deploymentTarget": "15.5",
-        },
-      },
+          "deploymentTarget": "15.5"
+        }
+      }
     ],
     [
       "@turbopush/turbopush-expo-plugin",
       {
         "android": {
-          "CodePushDeploymentKey": "YOUR_ANDROID_CODE_PUSH_KEY",
+          "CodePushDeploymentKey": "YOUR_ANDROID_CODE_PUSH_KEY"
         },
         "ios": {
-          "CodePushDeploymentKey": "YOUR_IOS_CODE_PUSH_KEY",
-        },
+          "CodePushDeploymentKey": "YOUR_IOS_CODE_PUSH_KEY"
+        }
       }
     ]
   ]
 }
 ```
 
-For more information, see the [Getting Started](https://docs.turbopush.org/?platform=expo) guide.
+For more information, see the [Getting Started](https://turbopush.org/docs/?platform=expo&utm_source=readme) guide.
 
-## Key Features
+---
 
-- **Rollback**: If an update causes a crash, the plugin can automatically roll back to the previous version.
-- **Multiple Platforms**: Supports Android and iOS.
-- **Multiple Channels**: You can create multiple channels to release updates to different groups of users.
-- **Multiple Environments**: You can create multiple environments to test your updates before releasing them to all users.
-- **Expo Support**: You can use our [Expo plugin](https://docs.turbopush.org/setup/expo-setup) for Expo apps.
+## Basic Usage
+
+The simplest way to integrate Turbopush is to wrap your root component with the `codePush` HOC. This will automatically check for and apply updates on each app launch.
+
+```tsx
+import React from 'react';
+import { View, Text } from 'react-native';
+import codePush from '@turbopush/react-native-code-push';
+
+function App() {
+  return (
+    <View>
+      <Text>My App</Text>
+    </View>
+  );
+}
+
+export default codePush(App);
+```
+
+You can also trigger a manual update check at any point:
+
+```tsx
+import codePush from '@turbopush/react-native-code-push';
+
+async function checkForUpdate() {
+  const update = await codePush.checkForUpdate();
+  if (update) {
+    await codePush.sync();
+  }
+}
+```
+
+For advanced configuration options (update dialogs, install modes, rollback handling), see the [full documentation](https://turbopush.org/docs?utm_source=readme).
+
+---
 
 ## Store Guideline Compliance
 
-Android Google Play and iOS App Store have corresponding guidelines that have rules you should be aware of before integrating the CodePush solution within your application.
+### Google Play
 
-### Google play
+The third paragraph of [Device and Network Abuse](https://support.google.com/googleplay/android-developer/answer/9888379?hl=en) states that updating source code by any method other than Google Play's update mechanism is restricted. However, this restriction does not apply to updating JavaScript bundles:
 
-Third paragraph of [Device and Network Abuse](https://support.google.com/googleplay/android-developer/answer/9888379?hl=en) topic describe that updating source code by any method other than Google Play's update mechanism is restricted. But this restriction does not apply to updating javascript bundles.
 > This restriction does not apply to code that runs in a virtual machine and has limited access to Android APIs (such as JavaScript in a webview or browser).
 
-That fully allow CodePush as it updates just JS bundles and can't update native code part.
+Turbopush only updates JS bundles and cannot update native code, so it is fully compliant.
 
 ### App Store
 
-Paragraph **3.3.2**, since back in 2015's [Apple Developer Program License Agreement](https://developer.apple.com/programs/ios/information/) fully allowed performing over-the-air updates of JavaScript and assets -  and in its latest version (20170605) [downloadable here](https://developer.apple.com/terms/) this ruling is even broader:
+Paragraph **3.3.2** of the [Apple Developer Program License Agreement](https://developer.apple.com/terms/) allows over-the-air updates of JavaScript and assets:
 
 > Interpreted code may be downloaded to an Application but only so long as such code: (a) does not change the primary purpose of the Application by providing features or functionality that are inconsistent with the intended and advertised purpose of the Application as submitted to the App Store, (b) does not create a store or storefront for other code or applications, and (c) does not bypass signing, sandbox, or other security features of the OS.
 
-CodePush allows you to follow these rules in full compliance so long as the update you push does not significantly deviate your product from its original App Store approved intent.
+Turbopush allows you to follow these rules in full compliance as long as the update you push does not significantly deviate your product from its original App Store approved intent.
+
+> **Tip:** For App Store-distributed apps, we suggest not enabling the `updateDialog` option when calling `sync`, as Apple's [App Store Review Guidelines](https://developer.apple.com/app-store/review/guidelines/) discourage prompts that require user action to access app functionality.
+
+---
+
+## Contributing
 
-To further remain in compliance with Apple's guidelines we suggest that App Store-distributed apps don't enable the `updateDialog` option when calling `sync`, since in the [App Store Review Guidelines](https://developer.apple.com/app-store/review/guidelines/) it is written that:
+Bug reports and feature requests are welcome via [GitHub Issues](https://github.com/turbopushdev/react-native-code-push/issues).
 
-> Apps must not force users to rate the app, review the app, download other apps, or other similar actions in order to access functionality, content, or use of the app.
+---
 
-This is not necessarily the case for `updateDialog`, since it won't force the user to download the new version, but at least you should be aware of that ruling if you decide to show it.
+## License
 
+MIT — see [LICENSE.md](LICENSE.md) for details.

package/android/app/src/debug/AndroidManifest.xml

@@ -0,0 +1,9 @@
+<manifest xmlns:android="http://schemas.android.com/apk/res/android">
+
+    <uses-permission android:name="android.permission.INTERNET" />
+
+    <application>
+        <activity android:name="com.facebook.react.devsupport.DevSettingsActivity" />
+    </application>
+
+</manifest>

package/package.json

@@ -1,9 +1,22 @@
 {
   "name": "@turbopush/react-native-code-push",
-  "version": "10.2.5",
+  "version": "10.2.6",
   "description": "React Native plugin for the CodePush service",
   "main": "CodePush.js",
   "typings": "typings/react-native-code-push.d.ts",
+  "files": [
+    "android/",
+    "ios/",
+    "scripts/",
+    "typings/",
+    "AlertAdapter.js",
+    "CodePush.js",
+    "CodePush.podspec",
+    "logging.js",
+    "package-mixins.js",
+    "react-native.config.js",
+    "request-fetch-adapter.js"
+  ],
   "homepage": "https://turbopush.org",
   "keywords": [
     "react-native",
@@ -72,17 +85,7 @@
     "tslint": "^6.1.3",
     "typescript": "^4.4.3"
   },
-  "rnpm": {
-    "android": {
-      "packageInstance": "new CodePush(getResources().getString(R.string.CodePushDeploymentKey), getApplicationContext(), BuildConfig.DEBUG)"
-    },
-    "ios": {
-      "sharedLibraries": [
-        "libz"
-      ]
-    }
-  },
   "bugs": {
     "url": "https://github.com/turbopushdev/react-native-code-push/issues"
   }
-}
+}

package/.azurepipelines/build-rn-code-push-1es.yml

@@ -1,104 +0,0 @@
-trigger:
-- master
-
-pr:
-- master
-
-resources:
-  repositories:
-  - repository: 1ESPipelineTemplates
-    type: git
-    name: 1ESPipelineTemplates/1ESPipelineTemplates
-    ref: refs/tags/release
-name: $(Build.SourceBranchName)_$(date:yyyyMMdd)$(rev:.r)
-
-extends:
-  ${{ if eq(variables['Build.SourceBranch'], 'refs/heads/master') }}:
-    template: v1/1ES.Official.PipelineTemplate.yml@1ESPipelineTemplates
-  ${{ else }}:
-    template: v1/1ES.Unofficial.PipelineTemplate.yml@1ESPipelineTemplates
-  parameters:
-    pool:
-      name: 1ES-PT-CBL-Mariner-2.0-Gen2
-      os: linux
-    customBuildTags:
-    - ES365AIMigrationTooling-BulkMigrated
-    sdl:
-      sourceAnalysisPool: 1ES-PT-Windows-2022
-      credscan:
-        suppressionsFile: $(Build.SourcesDirectory)/.config/CredScanSuppressions.json
-    stages:
-    - stage: Stage
-      jobs:
-      - job: HostJob
-        templateContext:
-          outputs:
-          - output: pipelineArtifact
-            displayName: "Publish Artifact: artifacts"
-            path: '$(Build.ArtifactStagingDirectory)/npm'
-            artifactName: npm
-            
-        steps:
-        - task: NodeTool@0
-          inputs:
-            versionSpec: '14.x'
-          displayName: 'Install Node.js'
-
-        - script: |
-            npm pack
-            npm install -g react-native-code-push*.tgz
-          displayName: 'Package react-native-code-push'
-          workingDirectory: $(Build.SourcesDirectory)
-
-        - task: DeleteFiles@1
-          inputs:
-            contents: node_modules
-          displayName: 'Delete node_modules'
-
-        - task: ArchiveFiles@2
-          inputs:
-            rootFolderOrFile: '$(Build.SourcesDirectory)'
-            includeRootFolder: false
-            archiveType: 'tar'
-            archiveFile: '$(Build.ArtifactStagingDirectory)/npm/$(Build.BuildId).tgz'
-            replaceExistingArchive: true
-            verbose: true
-          displayName: 'Prepare npm artifact'
-
-    - stage: APIScan
-      dependsOn: Stage
-      pool:
-        name: 1ES-PT-Windows-2022
-        os: windows
-      variables:
-        "agent.source.skip": true
-      jobs:
-      - job: APIScan
-        steps:
-        - task: DownloadPipelineArtifact@2
-          displayName: Download Build Artifacts for APIScan
-          inputs:
-            artifactName: npm
-            targetPath: '$(Agent.BuildDirectory)/npm'
-        - task: ExtractFiles@1
-          inputs:
-            archiveFilePatterns: '$(Agent.BuildDirectory)/npm/*.tgz'
-            destinationFolder: '$(Agent.BuildDirectory)/npm_extracted'
-        - task: AzureKeyVault@2
-          inputs:
-            azureSubscription: 'AC - Dev Infra & Build Pool'
-            KeyVaultName: 'mobile-center-sdk'
-            SecretsFilter: 'appcenter-sdk-managed-identity-clientid'
-            RunAsPreJob: false
-        - task: APIScan@2
-          displayName: 'Run APIScan'
-          inputs:
-            softwareFolder: '$(Agent.BuildDirectory)\npm_extracted'
-            softwareName: 'react-native-code-push'
-            softwareVersionNum: '$(Build.BuildId)'
-            isLargeApp: false
-            toolVersion: 'Latest'
-            verbosityLevel: verbose
-          condition: and(succeeded(), ne(variables['DisableAPIScan'], 'true'))
-          env:
-            AzureServicesAuthConnectionString: 'runAs=App;AppId=$(appcenter-sdk-managed-identity-clientid)'

package/.azurepipelines/test-rn-code-push.yml

@@ -1,94 +0,0 @@
-trigger:
-- master
-
-pr:
-- master
-
-variables:
-- name: api-level
-  value: '27' 
-
-pool:
-  vmImage: 'macOS-12'
-
-stages:
-- stage: RunTests
-  displayName: 'Run Android & IOS tests'
-  jobs:
-  - job: TestAndroid
-    timeoutInMinutes: 120
-    displayName: 'Test android'
-    steps:
-
-    - script: |
-        adb devices
-      displayName: 'Start adb server'
-
-    - script: |
-        $ANDROID_HOME/tools/bin/sdkmanager "system-images;android-$(api-level);google_apis;x86"
-      displayName: 'Download system image'
-
-    - script: |
-        $ANDROID_HOME/tools/bin/avdmanager create avd --force --name TestEmulator --abi google_apis/x86 --package 'system-images;android-$(api-level);google_apis;x86' --device "Nexus 6P"
-      displayName: 'Creating Android emulator'
-
-    - script: |
-        $ANDROID_HOME/emulator/emulator -avd TestEmulator -noaudio -no-window -no-snapshot-save -no-boot-anim -memory 6144 &
-      displayName: 'Start Android emulator'
-
-    - script: |
-        $ANDROID_HOME/platform-tools/adb wait-for-device shell 'while [[ -z $(getprop sys.boot_completed | tr -d '\r') ]]; do sleep 1; done'
-      displayName: 'Wait for emulator to boot'
-   
-    - script: |
-         adb shell settings put global window_animation_scale 0.0    
-      displayName: 'Disable animations and transitions'  
-
-    - script: |
-         adb shell settings put global transition_animation_scale 0.0
-      displayName: 'Disable animations and transitions'
-
-    - script: |
-         adb shell settings put global animator_duration_scale 0.0   
-      displayName: 'Disable animations and transitions'
-
-    
-    - task: JavaToolInstaller@0
-      inputs:
-        versionSpec: '11'
-        jdkArchitectureOption: 'x64'
-        jdkSourceOption: 'PreInstalled'
-      displayName: 'Change Java version'
-
-    - script: |
-        npm install
-      displayName: 'Package Installation'
-
-    - script: |
-        npm run build:tests && npm run test:setup:android
-      displayName: 'Setup Android tests'
-
-    - script: |
-        npm run test:fast:android
-      displayName: 'Run Android test'
-
-  - job: TestIOS
-    timeoutInMinutes: 120
-    displayName: 'Test IOS'
-    steps:
-
-    - script: |
-        npm install
-      displayName: 'Install dependencies'
-
-    - script: |
-        npm run build:tests && npm run test:setup:ios
-      displayName: 'Setup iOS tests'
-
-    - script: |
-        npm run test:fast:ios
-      displayName: 'Run tests'
-
-    
-          
-

package/.config/CredScanSuppressions.json

@@ -1,14 +0,0 @@
-{
-  "tool": "Credential Scanner",
-    "suppressions": [        
-      {
-        "file": "/Examples/CodePushDemoApp/android/app/debug.keystore",
-        "_justification": "Used only in DemoApp"
-      },
-      {
-        "file": "/Examples/CodePushDemoAppCpp/windows/CodePushDemoAppCpp/CodePushDemoAppCpp_TemporaryKey.pfx",
-        "_justification": "Used only in DemoApp"
-      }
-    ]
-}
-  

package/.gitconfig

@@ -1,6 +0,0 @@
-[user]
-    email = 220655984+dreamer-turbopush@users.noreply.github.com
-    name = dreamer-turbopush
-
-[core]
-    sshCommand = ssh -i ~/.ssh/id_rsa_tp

package/CONTRIBUTING.md

@@ -1,134 +0,0 @@
-# Contributing
-
-## Using the plugin
-
-### Environment setup
-
-`node.js` and `npm` are needed for using this project. `npm` comes bundled with the `node.js` installer. You can download the `node.js` installer here: https://nodejs.org/download/.
-
-Once you have installed `node.js` and `npm`, install the dev dependencies for the project.
-
-```
-npm install
-```
-
-### Using the plugin manually
-
-Follow these steps to test your modifications to the plugin manually:
-- clone this repository
-- install the dependencies
-
-	Navigate to the root folder from your command line console and run:
-	```
-	npm install
-	```
-- install the plugin in a React-Native project
-
-	Navigate to the root folder of your React-Native project from your command line console and run:
-	```
-	npm install local_path_to_your_clone_of_this_repo
-	```
-- configure the plugin using the steps in the README.md
-- build and run your app on an emulator or device
-
-## Test
-
-### Environment setup
-
-First, make sure you have installed the dependencies for the plugin by following the steps above.
-
-Then, make sure you have installed `react-native`.
-
-```
-npm install -g react-native
-```
-
-To run Android tests, make sure you have `sdk\tools`, `sdk\emulator` and  `sdk\platform-tools` in your PATH.
-
-To run iOS tests, make sure you've installed CocoaPods and have `.gem/bin` in your PATH.
-
-### Supported platforms
-
-The plugin has end to end tests for Android and iOS. Depending on your development machine OS, you can run some or all the tests.
-
-OS            | Supported tests
-------------- | -------------
-OS X          | Android, iOS
-Windows       | Android
-
-### Test descriptions
-
-The tests first build the app.
-
-They then check if the required emulators are currently running.
-
-If an Android emulator is not running, it attempts to boot the latest Android emulator. You can specify an emulator by adding env variable `ANDROID_EMU=yourEmulatorNameHere` to the npm command. For example: `ANDROID_EMU=yourEmulatorNameHere npm run test:android`.
-
-If an iOS simulator is not running, it attempts to boot the latest iOS iPhone simulator. You can specify a simulator by adding env variable `IOS_EMU=yourSimulatorNameHere` to the npm command. For example: `IOS_EMU="iPhone 8 (0567DFF8-329E-41A3-BD6D-E48E9DD5EF39)" npm run test:ios`.
-
-If all the required emulators are not running and the tests fail to boot them, the tests will fail.
-
-If you would like the tests to always restart the necessary emulators (killing them if they are currently running), setup a env variable `CLEAN=true` to the command. For example: `CLEAN=true npm run test`.
-
-The desired unit tests are then run.
-
-If you would like to skip building, add a `:fast` in the command you'd like to run. For example, `npm run test:ios` becomes `npm run test:fast:ios` or `npm run test:android` becomes `npm run test:fast:android`.
-
-There is a both a full unit test suite and a "core" set of unit tests that you may run. If you would like to run only the core tests, setup a env variable `CORE=true` to the command. For example: `CORE=true npm run test:android`.
-
-If you would like to pull the plugin from NPM rather than running the tests on the local version, setup a env variable `NPM=true` to the command. For example: `NPM=true npm run test:ios`.
-
-#### Default
-
-To run all of the unit tests on Android and iOS:
-```
-npm run test
-```
-
-#### iOS
-
-To run all of the unit tests on iOS:
-```
-npm run test:ios
-```
-
-#### Android
-
-To run all of the unit tests on Android:
-```
-npm run test:android
-```
-
-#### More examples
-
-All possible testing configurations have tasks!
-
-The platforms are ordered as follows, and ran in that order:
-android, ios
-
-To run the core unit tests on Android:
-```
-CORE=true npm run test:android
-```
-
-To run all of the unit tests on iOS and pull the plugin from NPM:
-```
-NPM=true npm run test:ios
-```
-
-To run all of the unit tests on Android and iOS without building first:
-```
-npm run test:fast
-```
-
-To run all of the unit tests on iOS and restart the emulators:
-```
-CLEAN=true npm run test:ios
-```
-
-To run the core unit tests on Android and pull the plugin from NPM:
-```
-NPM=true CORE=true npm run test:android
-```
-
-...and so on!