@algocare/react-native-code-push 9.0.0-beta.3

package/cli/utils/hash-utils.js

@@ -0,0 +1,227 @@
+/**
+ * code based on appcenter-cli
+ */
+
+/**
+ * NOTE!!! This utility file is duplicated for use by the CodePush service (for server-driven hashing/
+ * integrity checks) and Management SDK (for end-to-end code signing), please keep them in sync.
+ */
+
+const crypto = require('crypto');
+const fs = require('fs');
+const path = require('path');
+const { isDirectory } = require('./file-utils');
+const { walk } = require('./promisfied-fs');
+
+// Do not throw an exception if either of these modules are missing, as they may not be needed by the
+// consumer of this file.
+const HASH_ALGORITHM = 'sha256';
+class PackageManifest {
+    /**
+     * @type {Map<string, string>}
+     * @private
+     */
+    _map;
+
+    /**
+     * @param map {Map<string, string>?}
+     * @public
+     */
+    constructor(map) {
+        if (map == null) {
+            map = new Map();
+        }
+        this._map = map;
+    }
+
+    /**
+     * @return {Map<string, string>}
+     * @public
+     */
+    toMap() {
+        return this._map;
+    }
+
+    /**
+     * @return {string}
+     * @public
+     */
+    computePackageHash() {
+        /**
+         * @type {string[]}
+         */
+        let entries = [];
+        this._map.forEach((hash, name) => {
+            entries.push(name + ':' + hash);
+        });
+
+        // Make sure this list is alphabetically ordered so that other clients
+        // can also compute this hash easily given the update contents.
+        entries = entries.sort();
+
+        return crypto.createHash(HASH_ALGORITHM).update(JSON.stringify(entries)).digest('hex');
+    }
+
+    /**
+     * @return {string}
+     * @public
+     */
+    serialize() {
+        const obj = {};
+
+        this._map.forEach(function (value, key) {
+            obj[key] = value;
+        });
+
+        return JSON.stringify(obj);
+    }
+
+    /**
+     * @param filePath {string}
+     * @return {string}
+     * @public
+     */
+    static normalizePath(filePath) {
+        //replace all backslashes coming from cli running on windows machines by slashes
+        return filePath.replace(/\\/g, '/');
+    }
+
+    /**
+     * @param relativeFilePath {string}
+     * @return {boolean}
+     * @public
+     */
+    static isIgnored(relativeFilePath) {
+        const __MACOSX = '__MACOSX/';
+        const DS_STORE = '.DS_Store';
+        const CODEPUSH_METADATA = '.codepushrelease';
+        return (
+            relativeFilePath.startsWith(__MACOSX) ||
+            relativeFilePath === DS_STORE ||
+            relativeFilePath.endsWith('/' + DS_STORE) ||
+            relativeFilePath === CODEPUSH_METADATA ||
+            relativeFilePath.endsWith('/' + CODEPUSH_METADATA)
+        );
+    }
+}
+
+/**
+ *
+ * @param directoryPath {string}
+ * @param basePath {string}
+ * @return {Promise<string>}
+ */
+async function generatePackageHashFromDirectory(directoryPath, basePath) {
+    try {
+        if (!isDirectory(directoryPath)) {
+            throw new Error('Not a directory. Please either create a directory, or use hashFile().');
+        }
+    } catch (error) {
+        throw new Error('Directory does not exist. Please either create a directory, or use hashFile().');
+    }
+
+    /**
+     * @type {PackageManifest}
+     */
+    const manifest = await generatePackageManifestFromDirectory(directoryPath, basePath);
+    return manifest.computePackageHash();
+}
+
+/**
+ *
+ * @param directoryPath {string}
+ * @param basePath {string}
+ * @return {Promise<PackageManifest>}
+ */
+function generatePackageManifestFromDirectory(directoryPath, basePath) {
+    // eslint-disable-next-line no-async-promise-executor
+    return new Promise(async (resolve, reject) => {
+        /**
+         * @type {Map<string, string>}
+         */
+        const fileHashesMap = new Map();
+
+        /**
+         * @type {string[]}
+         */
+        const files = await walk(directoryPath);
+
+        if (!files || files.length === 0) {
+            reject('Error: Cannot sign the release because no files were found.');
+            return;
+        }
+
+        /**
+         * @type {Promise<void>}
+         */
+        // Hash the files sequentially, because streaming them in parallel is not necessarily faster
+        const generateManifestPromise = files.reduce((soFar, filePath) => {
+            return soFar.then(() => {
+                /**
+                 * @type {string}
+                 */
+                const relativePath = PackageManifest.normalizePath(path.relative(basePath, filePath));
+                if (!PackageManifest.isIgnored(relativePath)) {
+                    return hashFile(filePath).then((hash) => {
+                        fileHashesMap.set(relativePath, hash);
+                    });
+                }
+            });
+        }, Promise.resolve(null));
+
+        generateManifestPromise.then(() => {
+            resolve(new PackageManifest(fileHashesMap));
+        }, reject);
+    });
+}
+
+/**
+ *
+ * @param filePath {string}
+ * @return {Promise<string>}
+ */
+function hashFile(filePath) {
+    /**
+     * @type {fs.ReadStream}
+     */
+    const readStream = fs.createReadStream(filePath);
+    return hashStream(readStream);
+}
+
+/**
+ *
+ * @param readStream {stream.Readable}
+ * @return {Promise<string>}
+ */
+function hashStream(readStream) {
+    return new Promise((resolve, reject) => {
+        /**
+         * @type {stream.Transform}
+         */
+        const _hashStream = crypto.createHash(HASH_ALGORITHM)
+
+        readStream
+            .on('error', (error) => {
+                _hashStream.end();
+                reject(error);
+            })
+            .on('end', () => {
+                _hashStream.end();
+
+                /**
+                 * @type {Buffer}
+                 */
+                const buffer = _hashStream.read();
+                /**
+                 * @type {string}
+                 */
+                const hash = buffer.toString('hex');
+
+                resolve(hash);
+            });
+
+        readStream.pipe(_hashStream);
+    });
+}
+
+module.exports = { generatePackageHashFromDirectory };

package/cli/utils/promisfied-fs.js

@@ -0,0 +1,29 @@
+/**
+ * code based on appcenter-cli
+ */
+
+const { promises: fs } = require('fs');
+const path = require('path');
+
+/**
+ *
+ * @param dir {string}
+ * @return {Promise<string[]>}
+ */
+async function walk(dir) {
+    const stats = await fs.stat(dir);
+    if (stats.isDirectory()) {
+        /**
+         * @type {string[]}
+         */
+        let files = [];
+        for (const file of await fs.readdir(dir)) {
+            files = files.concat(await walk(path.join(dir, file)));
+        }
+        return files;
+    } else {
+        return [dir];
+    }
+}
+
+module.exports = { walk };

package/cli/utils/showLogo.js

@@ -0,0 +1,23 @@
+function showLogo() {
+  const logo = `
+    
++------------------------------------------------------------------+
+|                                                                  |
+|             ______          __     ____             __           |
+|             / ____/___  ____/ /__  / __ \\__  _______/ /_         |
+|            / /   / __ \\/ __  / _ \\/ /_/ / / / / ___/ __ \\        |
+|           / /___/ /_/ / /_/ /  __/ ____/ /_/ (__  ) / / /        |
+|           \\____/\\____/\\__,_/\\___/_/    \\__,_/____/_/ /_/         |
+|                                                                  |
+|                                                                  |
+|              🚀 @algocare/react-native-code-push              |
++------------------------------------------------------------------+                                     
+
+Please refer to help command for more information.
+
+(interactive mode is not supported yet.)
+    `
+  console.log(logo)
+}
+
+module.exports = { showLogo }

package/cli/utils/zip.js

@@ -0,0 +1,89 @@
+/**
+ * code based on appcenter-cli
+ */
+
+const fs = require('fs');
+const path = require('path');
+const yazl = require('yazl');
+const { generateRandomFilename, normalizePath, isDirectory } = require('./file-utils');
+const { walk } = require('./promisfied-fs');
+
+/**
+ * @typedef {{ sourceLocation: string, targetLocation: string }} ReleaseFile
+ */
+
+/**
+ * @param updateContentsPath {string}
+ * @return {Promise<string>}
+ */
+function zip(updateContentsPath) {
+
+    // eslint-disable-next-line no-async-promise-executor
+    return new Promise(async (resolve, reject) => {
+        /**
+         * @type {ReleaseFile[]}
+         */
+        const releaseFiles = [];
+
+        try {
+            if (!isDirectory(updateContentsPath)) {
+                releaseFiles.push({
+                    sourceLocation: updateContentsPath,
+                    targetLocation: normalizePath(path.basename(updateContentsPath)), // Put the file in the root
+                });
+            }
+        } catch (error) {
+            error.message = error.message + ' Make sure you have added the platform you are making a release to.`.';
+            reject(error);
+        }
+
+        /**
+         * @type {string}
+         */
+        const directoryPath = updateContentsPath;
+        const baseDirectoryPath = path.join(directoryPath, '..'); // For legacy reasons, put the root directory in the zip
+
+        /**
+         * @type {string[]}
+         */
+        const files = await walk(updateContentsPath);
+
+        files.forEach((filePath) => {
+            /**
+             * @type {string}
+             */
+            const relativePath = path.relative(baseDirectoryPath, filePath);
+            releaseFiles.push({
+                sourceLocation: filePath,
+                targetLocation: normalizePath(relativePath),
+            });
+        });
+
+        /**
+         * @type {string}
+         */
+        const packagePath = path.join(process.cwd(), generateRandomFilename(15) + '.zip');
+        const zipFile = new yazl.ZipFile();
+        /**
+         * @type {fs.WriteStream}
+         */
+        const writeStream = fs.createWriteStream(packagePath);
+
+        zipFile.outputStream
+            .pipe(writeStream)
+            .on('error', (error) => {
+                reject(error);
+            })
+            .on('close', () => {
+                resolve(packagePath);
+            });
+
+        releaseFiles.forEach((releaseFile) => {
+            zipFile.addFile(releaseFile.sourceLocation, releaseFile.targetLocation);
+        });
+
+        zipFile.end();
+    });
+}
+
+module.exports = zip;

package/code-push.config.example.supabase.ts

@@ -0,0 +1,114 @@
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-nocheck
+
+import {
+  CliConfigInterface,
+  ReleaseHistoryInterface,
+} from '@algocare/react-native-code-push'
+import * as fs from 'fs'
+import axios from 'axios' // install as devDependency
+import * as SupabaseSDK from '@supabase/supabase-js' // install as devDependency
+
+const SUPABASE_URL = process.env.SUPABASE_URL
+const SUPABASE_KEY = process.env.SUPABASE_KEY
+const supabase = SupabaseSDK.createClient(SUPABASE_URL!, SUPABASE_KEY!)
+const BUCKET_NAME = 'codePush'
+const STORAGE_HOST = `${SUPABASE_URL}/storage/v1/object/public`
+
+function historyJsonFileRemotePath(
+  platform: 'ios' | 'android',
+  identifier: string,
+  binaryVersion: string
+) {
+  return `histories/${platform}/${identifier}/${binaryVersion}.json`
+}
+
+function bundleFileRemotePath(
+  platform: 'ios' | 'android',
+  identifier: string,
+  fileName: string
+) {
+  return `bundles/${platform}/${identifier}/${fileName}`
+}
+
+const Config: CliConfigInterface = {
+  bundleUploader: async (
+    source: string,
+    platform: 'ios' | 'android',
+    identifier = 'staging'
+  ): Promise<{ downloadUrl: string }> => {
+    const fileName = source.split('/').pop()
+    const fileStream = fs.createReadStream(source)
+    const remotePath = bundleFileRemotePath(platform, identifier, fileName!)
+
+    const { data, error } = await supabase.storage
+      .from(BUCKET_NAME)
+      .upload(remotePath, fileStream, {
+        contentType: 'application/zip',
+        duplex: 'half',
+      })
+
+    if (error) {
+      console.error('Error uploading file:', error.message)
+      throw error
+    }
+
+    console.log('Bundle File uploaded:', `${STORAGE_HOST}/${data.fullPath}`)
+
+    return {
+      downloadUrl: `${STORAGE_HOST}/${data.fullPath}`,
+    }
+  },
+
+  getReleaseHistory: async (
+    targetBinaryVersion: string,
+    platform: 'ios' | 'android',
+    identifier = 'staging'
+  ): Promise<ReleaseHistoryInterface> => {
+    const remoteJsonPath = historyJsonFileRemotePath(
+      platform,
+      identifier,
+      targetBinaryVersion
+    )
+    const { data } = await axios.get(
+      `${STORAGE_HOST}/${BUCKET_NAME}/${remoteJsonPath}`
+    )
+    return data as ReleaseHistoryInterface
+  },
+
+  setReleaseHistory: async (
+    targetBinaryVersion: string,
+    jsonFilePath: string,
+    releaseInfo: ReleaseHistoryInterface,
+    platform: 'ios' | 'android',
+    identifier = 'staging'
+  ): Promise<void> => {
+    // upload JSON file or call API using `releaseInfo` metadata.
+
+    const fileContent = fs.readFileSync(jsonFilePath, 'utf8')
+    const remoteJsonPath = historyJsonFileRemotePath(
+      platform,
+      identifier,
+      targetBinaryVersion
+    )
+
+    const { data, error } = await supabase.storage
+      .from(BUCKET_NAME)
+      .upload(remoteJsonPath, Buffer.from(fileContent), {
+        contentType: 'application/json',
+        cacheControl: '5',
+      })
+
+    if (error) {
+      console.error('Error uploading file:', error.message)
+      throw error
+    }
+
+    console.log(
+      'Release history File uploaded:',
+      `${STORAGE_HOST}/${data.fullPath}`
+    )
+  },
+}
+
+module.exports = Config

package/docs/api-android.md

@@ -0,0 +1,83 @@
+### Java API Reference (Android)
+
+### API for React Native 0.60 version and above
+
+Since `autolinking` uses `react-native.config.js` to link plugins, constructors are specified in that file. But you can override custom variables to manage the CodePush plugin by placing these values in string resources.
+
+* __Public Key__ - used for bundle verification in the Code Signing Feature. Please refer to [Code Signing](setup-android.md#code-signing-setup) section for more details about the Code Signing Feature.
+    To set the public key, you should add the content of the public key to `strings.xml` with name `CodePushPublicKey`. CodePush automatically gets this property and enables the Code Signing feature. For example:
+    ```xml
+    <string moduleConfig="true" name="CodePushPublicKey">your-public-key</string>
+    ```
+
+* __Server Url__ - used for specifying CodePush Server Url.
+    The Default value: "https://codepush.appcenter.ms/" is overridden by adding your path to `strings.xml` with name `CodePushServerUrl`. CodePush automatically gets this property and will use this path to send requests. For example:
+    ```xml
+    <string moduleConfig="true" name="CodePushServerUrl">https://yourcodepush.server.com</string>
+    ```
+
+### API for React Native lower than 0.60
+
+The Java API is made available by importing the `com.microsoft.codepush.react.CodePush` class into your `MainActivity.java` file, and consists of a single public class named `CodePush`.
+
+#### CodePush
+
+Constructs the CodePush client runtime and represents the `ReactPackage` instance that you add to you app's list of packages.
+
+##### Constructors
+
+- __CodePush(String deploymentKey, Activity mainActivity)__ - Creates a new instance of the CodePush runtime, that will be used to query the service for updates via the provided deployment key. The `mainActivity` parameter should always be set to `this` when configuring your React packages list inside the `MainActivity` class. This constructor puts the CodePush runtime into "release mode", so if you want to enable debugging behavior, use the following constructor instead.
+
+- __CodePush(String deploymentKey, Activity mainActivity, bool isDebugMode)__ - Equivalent to the previous constructor but allows you to specify whether you want the CodePush runtime to be in debug mode or not. When using this constructor, the `isDebugMode` parameter should always be set to `BuildConfig.DEBUG` in order to stay synchronized with your build type. When putting CodePush into debug mode, the following behaviors are enabled:
+
+    1. Old CodePush updates aren't deleted from storage whenever a new binary is deployed to the emulator/device. This behavior enables you to deploy new binaries, without bumping the version during development, and without continuously getting the same update every time your app calls `sync`.
+
+    2. The local cache that the React Native runtime maintains in debug mode is deleted whenever a CodePush update is installed. This ensures that when the app is restarted after an update is applied, you will see the expected changes. As soon as [this PR](https://github.com/facebook/react-native/pull/4738) is merged, we won't need to do this anymore.
+
+- __CodePush(String deploymentKey, Context context, boolean isDebugMode, Integer publicKeyResourceDescriptor)__ - Equivalent to the previous constructor, but allows you to specify the public key resource descriptor needed to read public key content. Please refer to [Code Signing](setup-android.md#code-signing-setup) section for more details about the Code Signing Feature.
+
+- __CodePush(String deploymentKey, Context context, boolean isDebugMode, String serverUrl)__ Constructor allows you to specify CodePush Server Url. The Default value: `"https://codepush.appcenter.ms/"` is overridden by value specified in `serverUrl`.
+
+##### Builder
+
+As an alternative to constructors *you can also use `CodePushBuilder`* to setup a CodePush instance configured with *only parameters you want*.
+
+```java
+    @Override
+    protected List<ReactPackage> getPackages() {
+      return Arrays.<ReactPackage>asList(
+            new MainReactPackage(),
+            new CodePushBuilder("deployment-key-here",getApplicationContext())
+                .setIsDebugMode(BuildConfig.DEBUG)
+                .setPublicKeyResourceDescriptor(R.string.publicKey)
+                .setServerUrl("https://yourcodepush.server.com")
+                .build() //return configured CodePush instance
+      );
+    }
+```
+
+`CodePushBuilder` methods:
+
+* __public CodePushBuilder(String deploymentKey, Context context)__ - setup same parameters as via __CodePush(String deploymentKey, Activity mainActivity)__
+
+* __public CodePushBuilder setIsDebugMode(boolean isDebugMode)__ - allows you to specify whether you want the CodePush runtime to be in debug mode or not. Default value: `false`.
+
+* __public CodePushBuilder setServerUrl(String serverUrl)__ - allows you to specify CodePush Server Url. Default value: `"https://codepush.appcenter.ms/"`.
+
+* __public CodePushBuilder setPublicKeyResourceDescriptor(int publicKeyResourceDescriptor)__ - allows you to specify Public Key resource descriptor which will be used for reading Public Key content for `strings.xml` file. Please refer to [Code Signing](setup-android.md#code-signing-setup) section for more detailed information about purpose of this parameter.
+
+* __public CodePush build()__ - return configured `CodePush` instance.
+
+##### Public Methods
+
+- __setDeploymentKey(String deploymentKey)__ - Sets the deployment key that the app should use when querying for updates. This is a dynamic alternative to setting the deployment key in Codepush constructor/builder and/or specifying a deployment key in JS when calling `checkForUpdate` or `sync`.
+
+##### Static Methods
+
+- __getBundleUrl()__ - Returns the path to the most recent version of your app's JS bundle file, assuming that the resource name is `index.android.bundle`. If your app is using a different bundle name, then use the overloaded version of this method which allows specifying it. This method has the same resolution behavior as the Objective-C equivalent described above.
+
+- __getBundleUrl(String bundleName)__ - Returns the path to the most recent version of your app's JS bundle file, using the specified resource name (like `index.android.bundle`). This method has the same resolution behavior as the Objective-C equivalent described above.
+
+- __getPackageFolder()__ - Returns the path to the current update folder.
+
+- __overrideAppVersion(String appVersionOverride)__ - Sets the version of the application's binary interface, which would otherwise default to the Play Store version specified as the `versionName` in the `build.gradle`. This should be called a single time, before the CodePush instance is constructed.

package/docs/api-ios.md

@@ -0,0 +1,31 @@
+### Objective-C API Reference (iOS)
+
+The Objective-C API is made available by importing the `CodePush.h` header into your `AppDelegate.m` file, and consists of a single public class named `CodePush`.
+
+#### CodePush
+
+Contains static methods for retreiving the `NSURL` that represents the most recent JavaScript bundle file, and can be passed to the `RCTRootView`'s `initWithBundleURL` method when bootstrapping your app in the `AppDelegate.m` file.
+
+The `CodePush` class' methods can be thought of as composite resolvers which always load the appropriate bundle, in order to accommodate the following scenarios:
+
+1. When an end-user installs your app from the store (like `1.0.0`), they will get the JS bundle that is contained within the binary. This is the behavior you would get without using CodePush, but we make sure it doesn't break :)
+
+2. As soon as you begin releasing CodePush updates, your end-users will get the JS bundle that represents the latest release for the configured deployment. This is the behavior that allows you to iterate beyond what you shipped to the store.
+
+3. As soon as you release an update to the app store (like `1.1.0`), and your end-users update it, they will once again get the JS bundle that is contained within the binary. This behavior ensures that CodePush updates that targetted a previous binary version aren't used (since we don't know if they would work), and your end-users always have a working version of your app.
+
+4. Repeat #2 and #3 as the CodePush releases and app store releases continue on into infinity (and beyond?)
+
+Because of this behavior, you can safely deploy updates to both the app store(s) and CodePush as necesary, and rest assured that your end-users will always get the most recent version.
+
+##### Methods
+
+- __(NSURL \*)bundleURL__ - Returns the most recent JS bundle `NSURL` as described above. This method assumes that the name of the JS bundle contained within your app binary is `main.jsbundle`.
+
+- __(NSURL \*)bundleURLForResource:(NSString \*)resourceName__ - Equivalent to the `bundleURL` method, but also allows customizing the name of the JS bundle that is looked for within the app binary. This is useful if you aren't naming this file `main` (which is the default convention). This method assumes that the JS bundle's extension is `*.jsbundle`.
+
+- __(NSURL \*)bundleURLForResource:(NSString \*)resourceName withExtension:(NSString \*)resourceExtension__: Equivalent to the `bundleURLForResource:` method, but also allows customizing the extension used by the JS bundle that is looked for within the app binary. This is useful if you aren't naming this file `*.jsbundle` (which is the default convention).
+
+- __(void)overrideAppVersion:(NSString \*)appVersionOverride__ - Sets the version of the application's binary interface, which would otherwise default to the App Store version specified as the `CFBundleShortVersionString` in the `Info.plist`. This should be called a single time, before the bundle URL is loaded.
+
+- __(void)setDeploymentKey:(NSString \*)deploymentKey__ - Sets the deployment key that the app should use when querying for updates. This is a dynamic alternative to setting the deployment key in your `Info.plist` and/or specifying a deployment key in JS when calling `checkForUpdate` or `sync`.