#if __has_include() #import #elif __has_include("RCTEventEmitter.h") #import "RCTEventEmitter.h" #else #import "React/RCTEventEmitter.h" // Required when used as a Pod in a Swift project #endif #import @interface CodePush : RCTEventEmitter + (NSURL *)binaryBundleURL; /* * This method is used to retrieve the URL for the most recent * version of the JavaScript bundle. This could be either the * bundle that was packaged with the app binary, or the bundle * that was downloaded as part of a CodePush update. The value returned * should be used to "bootstrap" the React Native bridge. * * This method assumes that your JS bundle is named "main.jsbundle" * and therefore, if it isn't, you should use either the bundleURLForResource: * or bundleURLForResource:withExtension: methods to override that behavior. */ + (NSURL *)bundleURL; + (NSURL *)bundleURLForResource:(NSString *)resourceName; + (NSURL *)bundleURLForResource:(NSString *)resourceName withExtension:(NSString *)resourceExtension; + (NSURL *)bundleURLForResource:(NSString *)resourceName withExtension:(NSString *)resourceExtension subdirectory:(NSString *)resourceSubdirectory; + (NSURL *)bundleURLForResource:(NSString *)resourceName withExtension:(NSString *)resourceExtension subdirectory:(NSString *)resourceSubdirectory bundle:(NSBundle *)resourceBundle; + (NSString *)getApplicationSupportDirectory; + (NSString *)bundleAssetsPath; /* * This method allows the version of the app's binary interface * to be specified, which would otherwise default to the * binary version of the app. */ + (void)overrideAppVersion:(NSString *)appVersion; /* * This method allows dynamically setting the app's * release channel public ID, in addition to setting it via * the Info.plist file's CodePushReleaseChannelPublicId setting. */ + (void)setReleaseChannelPublicId:(NSString *)releaseChannelPublicId; /* * This method checks to see whether a specific package hash * has previously failed installation. */ + (BOOL)isFailedHash:(NSString*)packageHash; /** * Reports a deployment failure for the currently-running CodePush update, * queuing it for upload via `/report_status/deploy` on the next `sync()` / * `notifyAppReady()` call from JS. * * Behaviour: * - Persists the current package together with `{errorCode, errorMessage, * failedPhase}` into the same storage slot used by the auto-rollback * mechanism (FAILED_UPDATES_KEY). * - Sets the internal `needToReportRollback` flag so the next * `getNewStatusReport()` returns a failure report (status = * `DeploymentFailed`) carrying the supplied detail fields. * - Does NOT actually roll back the running bundle. If the caller also * wants to roll back, it should invoke its existing rollback / restart * logic separately. * - No-ops (with a log) if there is no current CodePush package on disk. * Callers are expected to verify the presence of a current package * before invoking. * * Recommended `errorCode` dictionary (server does not enforce, but * consistency matters for the aggregate Top-N view): * NETWORK_ERROR / HASH_MISMATCH / UNZIP_FAILED / SIGNATURE_INVALID / * DISK_FULL / BUNDLE_LOAD_FAILED / NATIVE_CRASH / USER_ROLLBACK / * TIMEOUT / UNKNOWN. Server caps at 64 chars. * * `failedPhase` must be one of `download` / `install` / `runtime` / * `unknown`; any other value is coerced to `unknown` by the JS SDK before * upload. Capped at 20 chars. * * `errorMessage` is free-form (may be nil). Capped at 500 chars by the JS * SDK before upload. */ + (void)reportDeploymentFailureWithErrorCode:(NSString *)errorCode errorMessage:(NSString *)errorMessage failedPhase:(NSString *)failedPhase; /* * This method is used to save information about the latest rollback. * This information will be used to decide whether the application * should ignore the update or not. */ + (void)setLatestRollbackInfo:(NSString*)packageHash; /* * This method is used to get the count of rollback for the package * using the latest rollback information. */ + (int)getRollbackCountForPackage:(NSString*) packageHash fromLatestRollbackInfo:(NSMutableDictionary*) latestRollbackInfo; /* * This method checks to see whether a specific package hash * represents a downloaded and installed update, that hasn't * been applied yet via an app restart. */ + (BOOL)isPendingUpdate:(NSString*)packageHash; // The below methods are only used during tests. + (BOOL)isUsingTestConfiguration; + (void)setUsingTestConfiguration:(BOOL)shouldUseTestConfiguration; + (void)clearUpdates; @end @interface CodePushConfig : NSObject @property (copy) NSString *appVersion; @property (readonly) NSString *buildVersion; @property (readonly) NSDictionary *configuration; @property (copy) NSString *releaseChannelPublicId; @property (readonly) NSString *clientUniqueId; @property (copy) NSString *serverURL; @property (copy) NSString *publicKey; @property (nonatomic) BOOL telemetryEnabled; @property (nonatomic) BOOL dataTransmissionEnabled; + (instancetype)current; @end @interface CodePushDownloadHandler : NSObject @property (strong) NSOutputStream *outputFileStream; @property long long expectedContentLength; @property long long receivedContentLength; @property dispatch_queue_t operationQueue; @property (copy) void (^progressCallback)(long long, long long); @property (copy) void (^doneCallback)(BOOL); @property (copy) void (^failCallback)(NSError *err); @property NSString *downloadUrl; - (id)init:(NSString *)downloadFilePath operationQueue:(dispatch_queue_t)operationQueue progressCallback:(void (^)(long long, long long))progressCallback doneCallback:(void (^)(BOOL))doneCallback failCallback:(void (^)(NSError *err))failCallback; - (void)download:(NSString*)url; @end @interface CodePushErrorUtils : NSObject + (NSError *)errorWithMessage:(NSString *)errorMessage; + (BOOL)isCodePushError:(NSError *)error; @end @interface CodePushPackage : NSObject + (void)downloadPackage:(NSDictionary *)updatePackage expectedBundleFileName:(NSString *)expectedBundleFileName publicKey:(NSString *)publicKey operationQueue:(dispatch_queue_t)operationQueue progressCallback:(void (^)(long long, long long))progressCallback doneCallback:(void (^)())doneCallback failCallback:(void (^)(NSError *err))failCallback; + (NSDictionary *)getCurrentPackage:(NSError **)error; + (NSDictionary *)getPreviousPackage:(NSError **)error; /* * Reads the `package` sub-object from .app/main-bundle-meta.json (embedded by the * "Embed main-bundle-meta.json" Xcode build phase via scripts/ota/pull-baseline-bundle.sh). * * Acts as the version metadata source for the APK/IPA-builtin bundle, so callers * (e.g. Crashlytics trackers) can report a label/packageHash even before any OTA * package has been downloaded. Returns nil on any failure (file missing, malformed * JSON, dev mode without a baked bundle), letting the caller degrade gracefully. */ + (NSDictionary *)getBuiltInPackageInfo; + (NSString *)getCurrentPackageFolderPath:(NSError **)error; + (NSString *)getCurrentPackageBundlePath:(NSError **)error; + (NSString *)getCurrentPackageHash:(NSError **)error; + (NSDictionary *)getPackage:(NSString *)packageHash error:(NSError **)error; + (NSString *)getPackageFolderPath:(NSString *)packageHash; + (BOOL)installPackage:(NSDictionary *)updatePackage removePendingUpdate:(BOOL)removePendingUpdate error:(NSError **)error; + (void)rollbackPackage; // The below methods are only used during tests. + (void)clearUpdates; + (void)downloadAndReplaceCurrentBundle:(NSString *)remoteBundleUrl; @end @interface CodePushTelemetryManager : NSObject + (NSDictionary *)getBinaryUpdateReport:(NSString *)appVersion; + (NSDictionary *)getRetryStatusReport; + (NSDictionary *)getRollbackReport:(NSDictionary *)lastFailedPackage; + (NSDictionary *)getUpdateReport:(NSDictionary *)currentPackage; + (void)recordStatusReported:(NSDictionary *)statusReport; + (void)saveStatusReportForRetry:(NSDictionary *)statusReport; @end @interface CodePushUpdateUtils : NSObject + (BOOL)copyEntriesInFolder:(NSString *)sourceFolder destFolder:(NSString *)destFolder error:(NSError **)error; + (NSString *)findMainBundleInFolder:(NSString *)folderPath expectedFileName:(NSString *)expectedFileName error:(NSError **)error; + (NSString *)assetsFolderName; + (NSString *)getHashForBinaryContents:(NSURL *)binaryBundleUrl error:(NSError **)error; + (NSString *)manifestFolderPrefix; + (NSString *)modifiedDateStringOfFileAtURL:(NSURL *)fileURL; + (BOOL)isHashIgnoredFor:(NSString *) relativePath; + (BOOL)verifyFolderHash:(NSString *)finalUpdateFolder expectedHash:(NSString *)expectedHash error:(NSError **)error; // remove BEGIN / END tags and line breaks from public key string + (NSString *)getKeyValueFromPublicKeyString:(NSString *)publicKeyString; + (NSString *)getSignatureFilePath:(NSString *)updateFolderPath; + (NSDictionary *) verifyAndDecodeJWT:(NSString *) jwt withPublicKey:(NSString *)publicKey error:(NSError **)error; + (BOOL)verifyUpdateSignatureFor:(NSString *)updateFolderPath expectedHash:(NSString *)newUpdateHash withPublicKey:(NSString *)publicKeyString error:(NSError **)error; @end #ifdef __cplusplus extern "C" { #endif void CPLog(NSString *formatString, ...); #ifdef __cplusplus } #endif typedef NS_ENUM(NSInteger, CodePushInstallMode) { CodePushInstallModeImmediate, CodePushInstallModeOnNextRestart, CodePushInstallModeOnNextResume, CodePushInstallModeOnNextSuspend }; typedef NS_ENUM(NSInteger, CodePushUpdateState) { CodePushUpdateStateRunning, CodePushUpdateStatePending, CodePushUpdateStateLatest };