Continue Typescript migration

Author: Minishlink

src/checkForUpdates.ts

@@ -1,13 +1,13 @@
 import { requestFetchAdapter } from "./internals/utils/request-fetch-adapter";
 import { Platform } from "react-native";
 import { log } from "./internals/utils/log";
-import type {HandleBinaryVersionMismatchCallback, RemotePackage} from "./types";
+import type { HandleBinaryVersionMismatchCallback, RemotePackage } from "./types";
 import { NativeRNAppZungCodePushModule } from "./internals/NativeRNAppZungCodePushModule";
-import { packageMixins } from "./internals/packageMixins";
 import { getConfiguration } from "./internals/getConfiguration";
 import { getPromisifiedSdk, type PromisifiedSdkQueryPackage } from "./internals/getPromisifiedSdk";
 import type { Configuration } from "./internals/types";
 import { getCurrentPackage } from "./internals/getCurrentPackage";
+import { RemotePackageImpl } from "./internals/RemotePackageImplementation";
 
 /**
  * Asks the CodePush service whether the configured app release channel has an update available.
@@ -92,7 +92,8 @@ export async function checkForUpdate(releaseChannelPublicId?: string, handleBina
         return null;
     }
 
-    const remotePackage = { ...update, ...packageMixins.remote(sdk.reportStatusDownload) };
+    // @ts-expect-error sdk typing is wrong
+    const remotePackage = new RemotePackageImpl(update, sdk.reportStatusDownload);
     remotePackage.failedInstall = await NativeRNAppZungCodePushModule.isFailedUpdate(remotePackage.packageHash);
     remotePackage.releaseChannelPublicId = releaseChannelPublicId || nativeConfig.releaseChannelPublicId;
     return remotePackage;

src/getUpdateMetadata.ts

@@ -1,7 +1,7 @@
 import { UpdateState } from "./enums/UpdateState.enum";
 import { NativeRNAppZungCodePushModule } from "./internals/NativeRNAppZungCodePushModule";
-import { packageMixins } from "./internals/packageMixins";
 import type { LocalPackage } from "./types";
+import { LocalPackageImplementation } from "./internals/LocalPackageImplementation";
 
 /**
  * Retrieves the metadata for an installed update (e.g. description, mandatory).
@@ -14,7 +14,7 @@ export async function getUpdateMetadata(updateState?: UpdateState): Promise<Loca
         return null;
     }
 
-    const localPackage: LocalPackage = {...packageMixins.local, ...nativeUpdateMetadata };
+    const localPackage = new LocalPackageImplementation(nativeUpdateMetadata);
     localPackage.failedInstall = await NativeRNAppZungCodePushModule.isFailedUpdate(nativeUpdateMetadata.packageHash);
     localPackage.isFirstRun = await NativeRNAppZungCodePushModule.isFirstRun(nativeUpdateMetadata.packageHash);
     return localPackage;

src/internals/LocalPackageImplementation.ts

@@ -0,0 +1,35 @@
+import { NativeRNAppZungCodePushModule } from "./NativeRNAppZungCodePushModule";
+import type { LocalPackage } from "../types";
+import { cloneWithoutFunctions } from "./utils/cloneWithoutFunctions";
+
+export class LocalPackageImplementation implements LocalPackage {
+    constructor(localPackageData: LocalPackage) {
+        Object.assign(this, localPackageData);
+    }
+
+    appVersion!: string;
+    description!: string;
+    failedInstall!: boolean;
+    isFirstRun!: boolean;
+    isMandatory!: boolean;
+    isPending = false; // A local package wouldn't be pending until it was installed
+    label!: string;
+    packageHash!: string;
+    packageSize!: number;
+    releaseChannelPublicId!: string;
+
+    async install(installMode = NativeRNAppZungCodePushModule.codePushInstallModeOnNextRestart, minimumBackgroundDuration = 0, updateInstalledCallback?: () => (Promise<void> | void)) {
+        const localPackageCopy = cloneWithoutFunctions(this); // In dev mode, React Native deep freezes any object queued over the bridge
+        await NativeRNAppZungCodePushModule.installUpdate(localPackageCopy, installMode, minimumBackgroundDuration);
+
+        if (installMode === NativeRNAppZungCodePushModule.codePushInstallModeImmediate) {
+            await updateInstalledCallback?.();
+            NativeRNAppZungCodePushModule.restartApp(false);
+            return;
+        }
+
+        NativeRNAppZungCodePushModule.clearPendingRestart();
+        this.isPending = true; // Mark the package as pending since it hasn't been applied yet
+        await updateInstalledCallback?.();
+    }
+}

src/internals/RemotePackageImplementation.ts

@@ -0,0 +1,63 @@
+import { NativeEventEmitter } from "react-native";
+import { NativeRNAppZungCodePushModule } from "./NativeRNAppZungCodePushModule";
+import type { DownloadProgressCallback, RemotePackage } from "../types";
+import type { Package } from "code-push/script/acquisition-sdk";
+import { log } from "./utils/log";
+import { LocalPackageImplementation } from "./LocalPackageImplementation";
+import { cloneWithoutFunctions } from "./utils/cloneWithoutFunctions";
+
+export class RemotePackageImpl implements RemotePackage {
+    constructor(remotePackageData: Omit<RemotePackage, "download">, private readonly reportStatusDownload?: (downloadedPackage: Package) => Promise<void>) {
+        Object.assign(this, remotePackageData);
+    }
+
+    appVersion!: string;
+    description!: string;
+    downloadUrl!: string;
+    failedInstall!: boolean;
+    isFirstRun!: boolean;
+    isMandatory!: boolean;
+    isPending = false; // A remote package could never be in a pending state
+    label!: string;
+    packageHash!: string;
+    packageSize!: number;
+    releaseChannelPublicId!: string;
+
+    async download(downloadProgressCallback: DownloadProgressCallback) {
+        if (!this.downloadUrl) {
+            throw new Error("Cannot download an update without a download url");
+        }
+
+        let downloadProgressSubscription;
+
+        if (downloadProgressCallback) {
+            const codePushEventEmitter = new NativeEventEmitter(NativeRNAppZungCodePushModule);
+            // Use event subscription to obtain download progress.
+            downloadProgressSubscription = codePushEventEmitter.addListener(
+                "CodePushDownloadProgress",
+                downloadProgressCallback
+            );
+        }
+
+        // Use the downloaded package info. Native code will save the package info
+        // so that the client knows what the current package version is.
+        try {
+            const updatePackageCopy = cloneWithoutFunctions(this); // In dev mode, React Native deep freezes any object queued over the bridge
+            const downloadedPackage = await NativeRNAppZungCodePushModule.downloadUpdate(updatePackageCopy, !!downloadProgressCallback);
+
+            if (this.reportStatusDownload) {
+                this.reportStatusDownload({
+                    ...this,
+                    deploymentKey: this.releaseChannelPublicId,
+                })
+                    .catch((err) => {
+                        log(`Report download status failed: ${err}`);
+                    });
+            }
+
+            return new LocalPackageImplementation(downloadedPackage);
+        } finally {
+            downloadProgressSubscription && downloadProgressSubscription.remove();
+        }
+    }
+}

src/internals/package-mixins.js

@@ -0,0 +1,6 @@
+export function cloneWithoutFunctions(object: object) {
+    const copy = Object.assign({}, object);
+    // @ts-ignore
+    Object.keys(copy).forEach((key) => (typeof copy[key] === "function") && delete copy[key]);
+    return copy;
+}

src/internals/packageMixins.ts

@@ -7,6 +7,14 @@ declare module "react-native" {
     export interface NativeEventSubscription {
         remove(): void;
     }
+    export class NativeEventEmitter {
+        constructor(nativeModule?: any);
+        addListener(
+            eventType: string,
+            listener: (event: any) => void,
+            context?: Object,
+        ): NativeEventSubscription;
+    }
 
     type AppStateStatus = string;
     export interface AppStateStatic {