@bravemobile/react-native-code-push 12.4.1 → 13.1.0-beta.0

package/cpp/binarypatch/vendor/zstd/zstd_errors.h

@@ -0,0 +1,107 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ * All rights reserved.
+ *
+ * This source code is licensed under both the BSD-style license (found in the
+ * LICENSE file in the root directory of this source tree) and the GPLv2 (found
+ * in the COPYING file in the root directory of this source tree).
+ * You may select, at your option, one of the above-listed licenses.
+ */
+
+#ifndef ZSTD_ERRORS_H_398273423
+#define ZSTD_ERRORS_H_398273423
+
+#if defined (__cplusplus)
+extern "C" {
+#endif
+
+/* =====   ZSTDERRORLIB_API : control library symbols visibility   ===== */
+#ifndef ZSTDERRORLIB_VISIBLE
+   /* Backwards compatibility with old macro name */
+#  ifdef ZSTDERRORLIB_VISIBILITY
+#    define ZSTDERRORLIB_VISIBLE ZSTDERRORLIB_VISIBILITY
+#  elif defined(__GNUC__) && (__GNUC__ >= 4) && !defined(__MINGW32__)
+#    define ZSTDERRORLIB_VISIBLE __attribute__ ((visibility ("default")))
+#  else
+#    define ZSTDERRORLIB_VISIBLE
+#  endif
+#endif
+
+#ifndef ZSTDERRORLIB_HIDDEN
+#  if defined(__GNUC__) && (__GNUC__ >= 4) && !defined(__MINGW32__)
+#    define ZSTDERRORLIB_HIDDEN __attribute__ ((visibility ("hidden")))
+#  else
+#    define ZSTDERRORLIB_HIDDEN
+#  endif
+#endif
+
+#if defined(ZSTD_DLL_EXPORT) && (ZSTD_DLL_EXPORT==1)
+#  define ZSTDERRORLIB_API __declspec(dllexport) ZSTDERRORLIB_VISIBLE
+#elif defined(ZSTD_DLL_IMPORT) && (ZSTD_DLL_IMPORT==1)
+#  define ZSTDERRORLIB_API __declspec(dllimport) ZSTDERRORLIB_VISIBLE /* It isn't required but allows to generate better code, saving a function pointer load from the IAT and an indirect jump.*/
+#else
+#  define ZSTDERRORLIB_API ZSTDERRORLIB_VISIBLE
+#endif
+
+/*-*********************************************
+ *  Error codes list
+ *-*********************************************
+ *  Error codes _values_ are pinned down since v1.3.1 only.
+ *  Therefore, don't rely on values if you may link to any version < v1.3.1.
+ *
+ *  Only values < 100 are considered stable.
+ *
+ *  note 1 : this API shall be used with static linking only.
+ *           dynamic linking is not yet officially supported.
+ *  note 2 : Prefer relying on the enum than on its value whenever possible
+ *           This is the only supported way to use the error list < v1.3.1
+ *  note 3 : ZSTD_isError() is always correct, whatever the library version.
+ **********************************************/
+typedef enum {
+  ZSTD_error_no_error = 0,
+  ZSTD_error_GENERIC  = 1,
+  ZSTD_error_prefix_unknown                = 10,
+  ZSTD_error_version_unsupported           = 12,
+  ZSTD_error_frameParameter_unsupported    = 14,
+  ZSTD_error_frameParameter_windowTooLarge = 16,
+  ZSTD_error_corruption_detected = 20,
+  ZSTD_error_checksum_wrong      = 22,
+  ZSTD_error_literals_headerWrong = 24,
+  ZSTD_error_dictionary_corrupted      = 30,
+  ZSTD_error_dictionary_wrong          = 32,
+  ZSTD_error_dictionaryCreation_failed = 34,
+  ZSTD_error_parameter_unsupported   = 40,
+  ZSTD_error_parameter_combination_unsupported = 41,
+  ZSTD_error_parameter_outOfBound    = 42,
+  ZSTD_error_tableLog_tooLarge       = 44,
+  ZSTD_error_maxSymbolValue_tooLarge = 46,
+  ZSTD_error_maxSymbolValue_tooSmall = 48,
+  ZSTD_error_cannotProduce_uncompressedBlock = 49,
+  ZSTD_error_stabilityCondition_notRespected = 50,
+  ZSTD_error_stage_wrong       = 60,
+  ZSTD_error_init_missing      = 62,
+  ZSTD_error_memory_allocation = 64,
+  ZSTD_error_workSpace_tooSmall= 66,
+  ZSTD_error_dstSize_tooSmall = 70,
+  ZSTD_error_srcSize_wrong    = 72,
+  ZSTD_error_dstBuffer_null   = 74,
+  ZSTD_error_noForwardProgress_destFull = 80,
+  ZSTD_error_noForwardProgress_inputEmpty = 82,
+  /* following error codes are __NOT STABLE__, they can be removed or changed in future versions */
+  ZSTD_error_frameIndex_tooLarge = 100,
+  ZSTD_error_seekableIO          = 102,
+  ZSTD_error_dstBuffer_wrong     = 104,
+  ZSTD_error_srcBuffer_wrong     = 105,
+  ZSTD_error_sequenceProducer_failed = 106,
+  ZSTD_error_externalSequences_invalid = 107,
+  ZSTD_error_maxCode = 120  /* never EVER use this value directly, it can change in future versions! Use ZSTD_isError() instead */
+} ZSTD_ErrorCode;
+
+ZSTDERRORLIB_API const char* ZSTD_getErrorString(ZSTD_ErrorCode code);   /**< Same as ZSTD_getErrorName, but using a `ZSTD_ErrorCode` enum argument */
+
+
+#if defined (__cplusplus)
+}
+#endif
+
+#endif /* ZSTD_ERRORS_H_398273423 */

package/ios/CodePush/CodePush.h

@@ -1,14 +1,40 @@
-#if __has_include(<React/RCTEventEmitter.h>)
-#import <React/RCTEventEmitter.h>
-#elif __has_include("RCTEventEmitter.h")
-#import "RCTEventEmitter.h"
+#import <Foundation/Foundation.h>
+
+#ifdef RCT_NEW_ARCH_ENABLED
+  #if defined(__cplusplus)
+    #if __has_include(<RNCodePushSpec/RNCodePushSpec.h>)
+      #import <RNCodePushSpec/RNCodePushSpec.h>
+    #elif __has_include("RNCodePushSpec.h")
+      #import "RNCodePushSpec.h"
+    #endif
+  #else
+    #if __has_include(<React/RCTBridgeModule.h>)
+      #import <React/RCTBridgeModule.h>
+    #elif __has_include("RCTBridgeModule.h")
+      #import "RCTBridgeModule.h"
+    #else
+      #import "React/RCTBridgeModule.h"
+    #endif
+  #endif
 #else
-#import "React/RCTEventEmitter.h"   // Required when used as a Pod in a Swift project
+  #if __has_include(<React/RCTEventEmitter.h>)
+    #import <React/RCTEventEmitter.h>
+  #elif __has_include("RCTEventEmitter.h")
+    #import "RCTEventEmitter.h"
+  #else
+    #import "React/RCTEventEmitter.h"   // Required when used as a Pod in a Swift project
+  #endif
 #endif
 
-#import <Foundation/Foundation.h>
-
+#ifdef RCT_NEW_ARCH_ENABLED
+  #if defined(__cplusplus)
+@interface CodePush : NativeCodePushSpecBase
+  #else
+@interface CodePush : NSObject <RCTBridgeModule>
+  #endif
+#else
 @interface CodePush : RCTEventEmitter
+#endif
 
 + (NSURL *)binaryBundleURL;
 /*
@@ -68,7 +94,7 @@
  * This information will be used to decide whether the application
  * should ignore the update or not.
  */
-+ (NSDictionary*)getRollbackInfo;
++ (NSDictionary*)getLatestRollbackInfo;
 /*
  * This method is used to save information about the latest rollback.
  * This information will be used to decide whether the application
@@ -137,11 +163,16 @@ failCallback:(void (^)(NSError *err))failCallback;
 
 @interface CodePushPackage : NSObject
 
+/*
+ * doneCallback is given what the attempt at installing the update from its binary patch
+ * archive ended in, or nil when the update had no patch archive to attempt. The result
+ * describes the download and not the update: it is never part of the update's metadata.
+ */
 + (void)downloadPackage:(NSDictionary *)updatePackage
  expectedBundleFileName:(NSString *)expectedBundleFileName
          operationQueue:(dispatch_queue_t)operationQueue
        progressCallback:(void (^)(long long, long long))progressCallback
-           doneCallback:(void (^)())doneCallback
+           doneCallback:(void (^)(NSDictionary *binaryPatchResult))doneCallback
            failCallback:(void (^)(NSError *err))failCallback;
 
 + (NSDictionary *)getCurrentPackage:(NSError **)error;
@@ -180,6 +211,18 @@ failCallback:(void (^)(NSError *err))failCallback;
 
 @interface CodePushUpdateUtils : NSObject
 
+/*
+ * The SHA-256 of some bytes, written the way every hash of an update's
+ * contents is: lower case hex.
+ */
++ (NSString *)computeHashForData:(NSData *)inputData;
+
+/*
+ * The same hash, of the contents of a file. Returns nil when the file
+ * cannot be read.
+ */
++ (NSString *)computeHashForFileAtPath:(NSString *)filePath;
+
 + (BOOL)copyEntriesInFolder:(NSString *)sourceFolder
                  destFolder:(NSString *)destFolder
                       error:(NSError **)error;
@@ -203,7 +246,13 @@ failCallback:(void (^)(NSError *err))failCallback;
 
 @end
 
+#if defined(__cplusplus)
+extern "C" {
+#endif
 void CPLog(NSString *formatString, ...);
+#if defined(__cplusplus)
+}
+#endif
 
 typedef NS_ENUM(NSInteger, CodePushInstallMode) {
     CodePushInstallModeImmediate,

package/ios/CodePush/{CodePush.m → CodePush.mm}

@@ -8,7 +8,11 @@
 
 #import "CodePush.h"
 
-@interface CodePush () <RCTBridgeModule, RCTFrameUpdateObserver>
+@interface CodePush () <RCTFrameUpdateObserver
+#ifdef RCT_NEW_ARCH_ENABLED
+, NativeCodePushSpec
+#endif
+>
 @end
 
 @implementation CodePush {
@@ -57,11 +61,16 @@ static NSString *const BinaryBundleDateKey = @"binaryDate";
 static NSString *const PackageHashKey = @"packageHash";
 static NSString *const PackageIsPendingKey = @"isPending";
 
+// Not one of those keys: the field a download that tried a binary patch reports its outcome
+// under, on the package it resolves with and on no package it stores.
+static NSString *const BinaryPatchResultKey = @"binaryPatchResult";
+
 #pragma mark - Static variables
 
 static BOOL isRunningBinaryVersion = NO;
 static BOOL needToReportRollback = NO;
 static BOOL testConfigurationFlag = NO;
+static BOOL hasInitializedUpdateAfterRestartForCurrentLoad = NO;
 
 // These values are used to save the NS bundle, name, extension and subdirectory
 // for the JS bundle in the binary.
@@ -246,6 +255,9 @@ static NSString *const LatestRollbackCountKey = @"count";
 
 #pragma mark - Private API methods
 
+#ifdef RCT_NEW_ARCH_ENABLED
+@synthesize bridge = _bridge;
+#endif
 @synthesize methodQueue = _methodQueue;
 @synthesize pauseCallback = _pauseCallback;
 @synthesize paused = _paused;
@@ -269,7 +281,7 @@ static NSString *const LatestRollbackCountKey = @"count";
 - (void)clearDebugUpdates
 {
     dispatch_async(dispatch_get_main_queue(), ^{
-        if ([super.bridge.bundleURL.scheme hasPrefix:@"http"]) {
+        if ([self.bridge.bundleURL.scheme hasPrefix:@"http"]) {
             NSError *error;
             NSString *binaryAppVersion = [[CodePushConfig current] appVersion];
             NSDictionary *currentPackageMetadata = [CodePushPackage getCurrentPackage:&error];
@@ -283,28 +295,6 @@ static NSString *const LatestRollbackCountKey = @"count";
     });
 }
 
-/*
- * This method is used by the React Native bridge to allow
- * our plugin to expose constants to the JS-side. In our case
- * we're simply exporting enum values so that the JS and Native
- * sides of the plugin can be in sync.
- */
-- (NSDictionary *)constantsToExport
-{
-    // Export the values of the CodePushInstallMode and CodePushUpdateState
-    // enums so that the script-side can easily stay in sync
-    return @{
-             @"codePushInstallModeOnNextRestart":@(CodePushInstallModeOnNextRestart),
-             @"codePushInstallModeImmediate": @(CodePushInstallModeImmediate),
-             @"codePushInstallModeOnNextResume": @(CodePushInstallModeOnNextResume),
-             @"codePushInstallModeOnNextSuspend": @(CodePushInstallModeOnNextSuspend),
-
-             @"codePushUpdateStateRunning": @(CodePushUpdateStateRunning),
-             @"codePushUpdateStatePending": @(CodePushUpdateStatePending),
-             @"codePushUpdateStateLatest": @(CodePushUpdateStateLatest)
-            };
-};
-
 + (BOOL)requiresMainQueueSetup
 {
     return YES;
@@ -319,13 +309,16 @@ static NSString *const LatestRollbackCountKey = @"count";
 
 - (void)dispatchDownloadProgressEvent {
   // Notify the script-side about the progress
-  [self sendEventWithName:DownloadProgressEvent
-                     body:@{
-                       @"totalBytes" : [NSNumber
-                           numberWithLongLong:_latestExpectedContentLength],
-                       @"receivedBytes" : [NSNumber
-                           numberWithLongLong:_latestReceivedConentLength]
-                     }];
+  NSDictionary *progress = @{
+    @"totalBytes" : [NSNumber numberWithLongLong:_latestExpectedContentLength],
+    @"receivedBytes" : [NSNumber numberWithLongLong:_latestReceivedConentLength]
+  };
+
+#ifndef RCT_NEW_ARCH_ENABLED
+  [self sendEventWithName:DownloadProgressEvent body:progress];
+#else
+  [self emitOnDownloadProgress:progress];
+#endif
 }
 
 - (void)dispatchThrottledDownloadProgressEventWithForce:(BOOL)force
@@ -385,7 +378,12 @@ static NSString *const LatestRollbackCountKey = @"count";
 
     self = [super init];
     if (self) {
-        [self initializeUpdateAfterRestart];
+        @synchronized([CodePush class]) {
+            if (!hasInitializedUpdateAfterRestartForCurrentLoad) {
+                hasInitializedUpdateAfterRestartForCurrentLoad = YES;
+                [self initializeUpdateAfterRestart];
+            }
+        }
     }
 
     return self;
@@ -535,6 +533,10 @@ static NSString *const LatestRollbackCountKey = @"count";
  */
 - (void)loadBundle
 {
+    @synchronized([CodePush class]) {
+        hasInitializedUpdateAfterRestartForCurrentLoad = NO;
+    }
+
     // This needs to be async dispatched because the bridge is not set on init
     // when the app first starts, therefore rollbacks will not take effect.
     dispatch_async(dispatch_get_main_queue(), ^{
@@ -542,8 +544,8 @@ static NSString *const LatestRollbackCountKey = @"count";
         // is debugging and therefore, shouldn't be redirected to a local
         // file (since Chrome wouldn't support it). Otherwise, update
         // the current bundle URL to point at the latest update
-        if ([CodePush isUsingTestConfiguration] || ![super.bridge.bundleURL.scheme hasPrefix:@"http"]) {
-            [super.bridge setValue:[CodePush bundleURL] forKey:@"bundleURL"];
+        if ([CodePush isUsingTestConfiguration] || ![self.bridge.bundleURL.scheme hasPrefix:@"http"]) {
+            [self.bridge setValue:[CodePush bundleURL] forKey:@"bundleURL"];
         }
 
         RCTTriggerReloadCommandListeners(@"CodePush reload");
@@ -713,8 +715,8 @@ static NSString *const LatestRollbackCountKey = @"count";
  */
 RCT_EXPORT_METHOD(downloadUpdate:(NSDictionary*)updatePackage
                   notifyProgress:(BOOL)notifyProgress
-                        resolver:(RCTPromiseResolveBlock)resolve
-                        rejecter:(RCTPromiseRejectBlock)reject)
+                         resolve:(RCTPromiseResolveBlock)resolve
+                          reject:(RCTPromiseRejectBlock)reject)
 {
     NSDictionary *mutableUpdatePackage = [updatePackage mutableCopy];
     NSURL *binaryBundleURL = [CodePush binaryBundleURL];
@@ -757,13 +759,24 @@ RCT_EXPORT_METHOD(downloadUpdate:(NSDictionary*)updatePackage
             }
         }
         // The download completed
-        doneCallback:^{
+        doneCallback:^(NSDictionary *binaryPatchResult) {
             NSError *err;
             NSDictionary *newPackage = [CodePushPackage getPackage:mutableUpdatePackage[PackageHashKey] error:&err];
 
             if (err) {
                 return reject([NSString stringWithFormat: @"%lu", (long)err.code], err.localizedDescription, err);
             }
+
+            if (binaryPatchResult) {
+                // The result describes this download rather than the update, so it is put on
+                // what this call resolves with and nowhere else: the metadata that was
+                // written for the update knows nothing about it, and whoever asked for the
+                // download decides what the result is worth.
+                NSMutableDictionary *downloadedPackage = [newPackage mutableCopy];
+                downloadedPackage[BinaryPatchResultKey] = binaryPatchResult;
+                return resolve(downloadedPackage);
+            }
+
             resolve(newPackage);
         }
         // The download failed
@@ -813,7 +826,7 @@ RCT_EXPORT_METHOD(downloadUpdate:(NSDictionary*)updatePackage
  * app version, as well as the deployment key that was configured in the Info.plist file.
  */
 RCT_EXPORT_METHOD(getConfiguration:(RCTPromiseResolveBlock)resolve
-                          rejecter:(RCTPromiseRejectBlock)reject)
+                            reject:(RCTPromiseRejectBlock)reject)
 {
     NSDictionary *configuration = [[CodePushConfig current] configuration];
     NSError *error;
@@ -846,10 +859,11 @@ RCT_EXPORT_METHOD(getConfiguration:(RCTPromiseResolveBlock)resolve
 /*
  * This method is the native side of the CodePush.getUpdateMetadata method.
  */
-RCT_EXPORT_METHOD(getUpdateMetadata:(CodePushUpdateState)updateState
-                           resolver:(RCTPromiseResolveBlock)resolve
-                           rejecter:(RCTPromiseRejectBlock)reject)
+RCT_EXPORT_METHOD(getUpdateMetadata:(double)updateStateValue
+                            resolve:(RCTPromiseResolveBlock)resolve
+                             reject:(RCTPromiseRejectBlock)reject)
 {
+    CodePushUpdateState updateState = (CodePushUpdateState)updateStateValue;
     NSError *error;
     NSMutableDictionary *package = [[CodePushPackage getCurrentPackage:&error] mutableCopy];
 
@@ -895,11 +909,13 @@ RCT_EXPORT_METHOD(getUpdateMetadata:(CodePushUpdateState)updateState
  * This method is the native side of the LocalPackage.install method.
  */
 RCT_EXPORT_METHOD(installUpdate:(NSDictionary*)updatePackage
-                    installMode:(CodePushInstallMode)installMode
-      minimumBackgroundDuration:(int)minimumBackgroundDuration
-                       resolver:(RCTPromiseResolveBlock)resolve
-                       rejecter:(RCTPromiseRejectBlock)reject)
+                    installMode:(double)installModeValue
+      minimumBackgroundDuration:(double)minimumBackgroundDurationValue
+                         resolve:(RCTPromiseResolveBlock)resolve
+                          reject:(RCTPromiseRejectBlock)reject)
 {
+    CodePushInstallMode installMode = (CodePushInstallMode)installModeValue;
+    int minimumBackgroundDuration = (int)minimumBackgroundDurationValue;
     NSError *error;
     [CodePushPackage installPackage:updatePackage
                 removePendingUpdate:[[self class] isPendingUpdate:nil]
@@ -965,7 +981,7 @@ RCT_EXPORT_METHOD(setLatestRollbackInfo:(NSString *)packageHash
 
 
 RCT_EXPORT_METHOD(getLatestRollbackInfo:(RCTPromiseResolveBlock)resolve
-                  rejecter:(RCTPromiseRejectBlock)reject)
+                            reject:(RCTPromiseRejectBlock)reject)
 {
     NSDictionary *latestRollbackInfo = [[self class] getLatestRollbackInfo];
     resolve(latestRollbackInfo);
@@ -977,7 +993,7 @@ RCT_EXPORT_METHOD(getLatestRollbackInfo:(RCTPromiseResolveBlock)resolve
  */
 RCT_EXPORT_METHOD(isFirstRun:(NSString *)packageHash
                      resolve:(RCTPromiseResolveBlock)resolve
-                    rejecter:(RCTPromiseRejectBlock)reject)
+                      reject:(RCTPromiseRejectBlock)reject)
 {
     NSError *error;
     BOOL isFirstRun = _isFirstRunAfterUpdate
@@ -992,14 +1008,13 @@ RCT_EXPORT_METHOD(isFirstRun:(NSString *)packageHash
  * This method is the native side of the CodePush.notifyApplicationReady() method.
  */
 RCT_EXPORT_METHOD(notifyApplicationReady:(RCTPromiseResolveBlock)resolve
-                                rejecter:(RCTPromiseRejectBlock)reject)
+                                  reject:(RCTPromiseRejectBlock)reject)
 {
     [CodePush removePendingUpdate];
     resolve(nil);
 }
 
-RCT_EXPORT_METHOD(allow:(RCTPromiseResolveBlock)resolve
-                    rejecter:(RCTPromiseRejectBlock)reject)
+RCT_EXPORT_METHOD(allow)
 {
     CPLog(@"Re-allowing restarts.");
     _allowed = YES;
@@ -1010,34 +1025,25 @@ RCT_EXPORT_METHOD(allow:(RCTPromiseResolveBlock)resolve
         [_restartQueue removeObjectAtIndex:0];
         [self restartAppInternal:buf];
     }
-
-    resolve(nil);
 }
 
-RCT_EXPORT_METHOD(clearPendingRestart:(RCTPromiseResolveBlock)resolve
-                    rejecter:(RCTPromiseRejectBlock)reject)
+RCT_EXPORT_METHOD(clearPendingRestart)
 {
     [_restartQueue removeAllObjects];
-    resolve(nil);
 }
 
-RCT_EXPORT_METHOD(disallow:(RCTPromiseResolveBlock)resolve
-                    rejecter:(RCTPromiseRejectBlock)reject)
+RCT_EXPORT_METHOD(disallow)
 {
     CPLog(@"Disallowing restarts.");
     _allowed = NO;
-    resolve(nil);
 }
 
 /*
  * This method is the native side of the CodePush.restartApp() method.
  */
-RCT_EXPORT_METHOD(restartApp:(BOOL)onlyIfUpdateIsPending
-                     resolve:(RCTPromiseResolveBlock)resolve
-                    rejecter:(RCTPromiseRejectBlock)reject)
+RCT_EXPORT_METHOD(restartApp:(BOOL)onlyIfUpdateIsPending)
 {
     [self restartAppInternal:onlyIfUpdateIsPending];
-    resolve(nil);
 }
 
 /*
@@ -1071,7 +1077,7 @@ RCT_EXPORT_METHOD(downloadAndReplaceCurrentBundle:(NSString *)remoteBundleUrl)
  * or an update failed) and return its details (version label, status).
  */
 RCT_EXPORT_METHOD(getNewStatusReport:(RCTPromiseResolveBlock)resolve
-                            rejecter:(RCTPromiseRejectBlock)reject)
+                              reject:(RCTPromiseRejectBlock)reject)
 {
     if (needToReportRollback) {
         needToReportRollback = NO;
@@ -1128,4 +1134,12 @@ RCT_EXPORT_METHOD(saveStatusReportForRetry:(NSDictionary *)statusReport)
     _didUpdateProgress = NO;
 }
 
+#ifdef RCT_NEW_ARCH_ENABLED
+- (std::shared_ptr<facebook::react::TurboModule>)getTurboModule:
+    (const facebook::react::ObjCTurboModule::InitParams &)params
+{
+    return std::make_shared<facebook::react::NativeCodePushSpecJSI>(params);
+}
+#endif
+
 @end

package/ios/CodePush/CodePushBinaryPatch.h

@@ -0,0 +1,80 @@
+#import <Foundation/Foundation.h>
+
+/*
+ * Why an update that was downloaded as a binary patch has to be downloaded in full
+ * instead.
+ *
+ * A failed restore is not an error the user ever hears about: it is the signal to
+ * download the update's full archive. These reasons are the vocabulary the appliers of
+ * every platform report, and the logs a rollout is judged from are read for exactly
+ * these words, so they must not be reworded.
+ */
+
+/** The bundle inside the app binary could not be opened or read. */
+extern NSString *const CodePushBinaryPatchReasonBaseBundleUnavailable;
+
+/** The bundle inside the app binary is not the one the patch was computed against. */
+extern NSString *const CodePushBinaryPatchReasonBaseHashMismatch;
+
+/** The manifest is missing, malformed, points outside the archive, or asks for too much. */
+extern NSString *const CodePushBinaryPatchReasonInvalidManifest;
+
+/** The patch was produced by a format or a codec this client cannot apply. */
+extern NSString *const CodePushBinaryPatchReasonUnsupportedFormat;
+
+/** The applier refused the patch, or the restored bundle could not be written. */
+extern NSString *const CodePushBinaryPatchReasonPatchApplyFailed;
+
+/** The restored bundle is not the one the manifest promised. */
+extern NSString *const CodePushBinaryPatchReasonTargetVerificationFailed;
+
+/**
+ * The update restored from the patch did not pass the checks every update passes before
+ * it is installed - the folder hash above all.
+ *
+ * This one is reported by the caller rather than by the applier: by the time it applies,
+ * the applier has already handed back a bundle it was happy with.
+ */
+extern NSString *const CodePushBinaryPatchReasonPackageVerificationFailed;
+
+/**
+ * Rebuilds the JS bundle of an update that was downloaded as a binary patch archive.
+ *
+ * A patch archive holds everything the full archive holds except the JS bundle, which it
+ * carries as a patch against the bundle that shipped inside the app binary, plus a
+ * manifest describing how to rebuild it. Restoring means applying that patch, verifying
+ * the result, moving it to where the bundle belongs and deleting the two patch-only
+ * files. What is left is byte for byte the contents of the full archive, so the folder
+ * hash check that follows the install is unchanged and stays the last line of defence.
+ *
+ * Nothing here trusts the patch. Neither the diff format nor the zstd streams inside it
+ * carry a checksum of the data they produce, so an apply that reports success is not
+ * proof of a correct result: a base bundle of the right size but the wrong content, or a
+ * corrupted patch body, both produce wrong bytes without any error. The base bundle is
+ * hashed before the patch is applied and the restored bundle is hashed afterwards, and
+ * the restored bytes only reach the update contents once both checks have passed.
+ *
+ * Every failure is reported as a reason, never as an exception: the caller answers all
+ * of them the same way, by downloading the full archive instead.
+ */
+@interface CodePushBinaryPatch : NSObject
+
+/**
+ * Turns the contents of a downloaded patch archive into the contents of the full one.
+ *
+ * This reads and hashes whole bundles, so it belongs on the queue the download runs on
+ * and never on the main queue.
+ *
+ * @param unzippedFolderPath the unzipped archive, which is modified in place
+ * @param workingFolderPath  scratch directory for the restored bundle, emptied before
+ *                           and after the attempt so an interrupted run leaves nothing
+ * @param baseBundleURL      the JS bundle that shipped inside the app binary
+ * @param failureReason      set to the reason the full archive has to be downloaded
+ *                           instead, whenever this returns NO
+ */
++ (BOOL)restoreBundleInUnzippedFolder:(NSString *)unzippedFolderPath
+                        workingFolder:(NSString *)workingFolderPath
+                        baseBundleURL:(NSURL *)baseBundleURL
+                        failureReason:(NSString **)failureReason;
+
+@end