@swiftpatch/react-native 2.0.0

package/src/native/NativeSwiftPatch.ts

@@ -0,0 +1,205 @@
+import { NativeModules, NativeEventEmitter, Platform } from 'react-native';
+import type { BundleInfo, DownloadProgress, SlotMetadata } from '../types';
+import { NativeEvents } from '../constants';
+
+const LINKING_ERROR =
+  `The package '@swiftpatch/react-native' doesn't seem to be linked. Make sure: \n\n` +
+  Platform.select({ ios: "- You have run 'pod install'\n", default: '' }) +
+  '- You rebuilt the app after installing the package\n' +
+  '- You are not using Expo Go\n';
+
+// Try to get TurboModule first (New Architecture), fallback to legacy
+let SwiftPatchNative: any;
+let isTurboModuleEnabled = false;
+
+try {
+  // @ts-ignore - TurboModuleRegistry is not typed
+  const TurboModuleRegistry = require('react-native').TurboModuleRegistry;
+  if (TurboModuleRegistry) {
+    SwiftPatchNative = TurboModuleRegistry.get('SwiftPatch');
+    if (SwiftPatchNative) {
+      isTurboModuleEnabled = true;
+    }
+  }
+} catch (e) {
+  // TurboModuleRegistry not available, will use legacy
+}
+
+// Fallback to legacy NativeModules if TurboModule not available
+if (!SwiftPatchNative) {
+  SwiftPatchNative = NativeModules.SwiftPatch
+    ? NativeModules.SwiftPatch
+    : new Proxy(
+        {},
+        {
+          get() {
+            throw new Error(LINKING_ERROR);
+          },
+        }
+      );
+}
+
+// Event emitter for native events
+export const swiftPatchEmitter = new NativeEventEmitter(SwiftPatchNative);
+
+// Export whether TurboModule is enabled for debugging
+export const IS_TURBO_MODULE_ENABLED = isTurboModuleEnabled;
+
+/**
+ * Native module interface
+ */
+export interface NativeSwiftPatchModule {
+  // ─── Initialization ────────────────────────────────────────
+
+  initialize(config: {
+    deploymentKey: string;
+    serverUrl: string;
+    publicKey: string | null;
+  }): Promise<void>;
+
+  getJSBundleFile(): string | null;
+
+  setDebugMode(enabled: boolean): void;
+
+  // ─── Mount State (crash detection) ─────────────────────────
+
+  markMounted(): Promise<void>;
+
+  markUnmounted(): Promise<void>;
+
+  // ─── Bundle Information ────────────────────────────────────
+
+  getCurrentBundle(): Promise<BundleInfo | null>;
+
+  getSlotMetadata(): Promise<SlotMetadata>;
+
+  getDeviceId(): Promise<string>;
+
+  getAppVersion(): Promise<string>;
+
+  // ─── Environment ───────────────────────────────────────────
+
+  switchEnvironment(environment: string): Promise<SlotMetadata>;
+
+  // ─── Download & Install ────────────────────────────────────
+
+  downloadUpdate(
+    url: string,
+    expectedHash: string,
+    isPatch: boolean,
+    signature: string | null
+  ): Promise<void>;
+
+  downloadStageBundle(url: string, expectedHash: string): Promise<void>;
+
+  installUpdate(bundleHash: string): Promise<void>;
+
+  hasPendingInstall(): Promise<boolean>;
+
+  confirmInstall(): Promise<void>;
+
+  // ─── Stabilization ─────────────────────────────────────────
+
+  stabilize(): Promise<SlotMetadata>;
+
+  // ─── Restart & Rollback ────────────────────────────────────
+
+  restart(): void;
+
+  rollback(): Promise<string>;
+
+  clearPendingUpdate(): Promise<void>;
+
+  // ─── Event Queue ───────────────────────────────────────────
+
+  popEvents(): Promise<Array<Record<string, unknown>>>;
+
+  acknowledgeEvents(eventIdsJson: string): Promise<void>;
+
+  // ─── Launch Tracking ───────────────────────────────────────
+
+  recordSuccessfulLaunch(bundleHash: string): Promise<number>;
+
+  getLaunchCount(bundleHash: string): Promise<number>;
+
+  // ─── Status Reporting ──────────────────────────────────────
+
+  reportStatus(
+    releaseId: string,
+    status: 'downloaded' | 'installed' | 'crashed' | 'rolledBack'
+  ): Promise<void>;
+
+  // ─── Legacy / Advanced ─────────────────────────────────────
+
+  computeHash(filePath: string): Promise<string>;
+
+  applyPatch(
+    currentBundlePath: string,
+    patchPath: string,
+    outputPath: string
+  ): Promise<string>;
+
+  verifySignature(
+    data: string,
+    signature: string,
+    publicKey: string
+  ): Promise<boolean>;
+
+  cancelDownload(): Promise<void>;
+
+  getDownloadedBundlePath(bundleHash: string): Promise<string>;
+}
+
+export default SwiftPatchNative as NativeSwiftPatchModule;
+
+/**
+ * Subscribe to download progress events
+ */
+export function onDownloadProgress(
+  callback: (progress: DownloadProgress) => void
+): () => void {
+  const subscription = swiftPatchEmitter.addListener(
+    NativeEvents.DOWNLOAD_PROGRESS,
+    callback
+  );
+  return () => subscription.remove();
+}
+
+/**
+ * Subscribe to rollback events
+ */
+export function onRollback(
+  callback: (reason: string) => void
+): () => void {
+  const subscription = swiftPatchEmitter.addListener(
+    NativeEvents.ROLLBACK_OCCURRED,
+    (event: { reason: string }) => callback(event.reason)
+  );
+  return () => subscription.remove();
+}
+
+/**
+ * Subscribe to version change events
+ */
+export function onVersionChanged(
+  callback: (reason: string) => void
+): () => void {
+  const subscription = swiftPatchEmitter.addListener(
+    NativeEvents.VERSION_CHANGED,
+    (event: { reason: string }) => callback(event.reason)
+  );
+  return () => subscription.remove();
+}
+
+/**
+ * Subscribe to native SDK events
+ */
+export function onNativeEvent(
+  callback: (event: Record<string, unknown>) => void
+): () => void {
+  const subscription = swiftPatchEmitter.addListener(
+    NativeEvents.NATIVE_EVENT,
+    callback
+  );
+  return () => subscription.remove();
+}

package/src/native/NativeSwiftPatchSpec.ts

@@ -0,0 +1,139 @@
+/**
+ * TurboModule Spec for SwiftPatch
+ *
+ * This file defines the interface for the New Architecture TurboModule.
+ * Codegen will use this to generate native code for iOS and Android.
+ */
+
+import type { TurboModule } from 'react-native';
+import { TurboModuleRegistry } from 'react-native';
+
+export interface BundleInfo {
+  hash: string;
+  version: string;
+  installedAt: string;
+  isOriginal: boolean;
+  slot: string;
+  environment: string;
+}
+
+export interface SlotMetadata {
+  environment: string;
+  prod: {
+    currentSlot: string;
+    newHash: string | null;
+    stableHash: string | null;
+    tempHash: string | null;
+  };
+  stage: {
+    newHash: string | null;
+  };
+}
+
+export interface Spec extends TurboModule {
+  // ─── Initialization ────────────────────────────────────────
+
+  initialize(config: {
+    deploymentKey: string;
+    serverUrl: string;
+    publicKey: string | null;
+  }): Promise<void>;
+
+  getJSBundleFile(): string | null;
+
+  setDebugMode(enabled: boolean): void;
+
+  // ─── Mount State (crash detection) ─────────────────────────
+
+  markMounted(): Promise<void>;
+
+  markUnmounted(): Promise<void>;
+
+  // ─── Bundle Information ────────────────────────────────────
+
+  getCurrentBundle(): Promise<BundleInfo | null>;
+
+  getSlotMetadata(): Promise<SlotMetadata>;
+
+  getDeviceId(): Promise<string>;
+
+  getAppVersion(): Promise<string>;
+
+  // ─── Environment ───────────────────────────────────────────
+
+  switchEnvironment(environment: string): Promise<SlotMetadata>;
+
+  // ─── Download & Install ────────────────────────────────────
+
+  downloadUpdate(
+    url: string,
+    expectedHash: string,
+    isPatch: boolean,
+    signature: string | null
+  ): Promise<void>;
+
+  downloadStageBundle(url: string, expectedHash: string): Promise<void>;
+
+  installUpdate(bundleHash: string): Promise<void>;
+
+  hasPendingInstall(): Promise<boolean>;
+
+  confirmInstall(): Promise<void>;
+
+  // ─── Stabilization ─────────────────────────────────────────
+
+  stabilize(): Promise<SlotMetadata>;
+
+  // ─── Restart & Rollback ────────────────────────────────────
+
+  restart(): void;
+
+  rollback(): Promise<string>;
+
+  clearPendingUpdate(): Promise<void>;
+
+  // ─── Event Queue ───────────────────────────────────────────
+
+  popEvents(): Promise<Array<Record<string, unknown>>>;
+
+  acknowledgeEvents(eventIdsJson: string): Promise<void>;
+
+  // ─── Launch Tracking ───────────────────────────────────────
+
+  recordSuccessfulLaunch(bundleHash: string): Promise<number>;
+
+  getLaunchCount(bundleHash: string): Promise<number>;
+
+  // ─── Status Reporting ──────────────────────────────────────
+
+  reportStatus(
+    releaseId: string,
+    status: 'downloaded' | 'installed' | 'crashed' | 'rolledBack'
+  ): Promise<void>;
+
+  // ─── Legacy / Advanced ─────────────────────────────────────
+
+  computeHash(filePath: string): Promise<string>;
+
+  applyPatch(
+    currentBundlePath: string,
+    patchPath: string,
+    outputPath: string
+  ): Promise<string>;
+
+  verifySignature(
+    data: string,
+    signature: string,
+    publicKey: string
+  ): Promise<boolean>;
+
+  cancelDownload(): Promise<void>;
+
+  getDownloadedBundlePath(bundleHash: string): Promise<string>;
+
+  // Event emitter support
+  addListener(eventName: string): void;
+  removeListeners(count: number): void;
+}
+
+export default TurboModuleRegistry.getEnforcing<Spec>('SwiftPatch');

package/src/types.ts

@@ -0,0 +1,336 @@
+/**
+ * SwiftPatch SDK Configuration
+ */
+export interface SwiftPatchConfig {
+  /** Deployment key from SwiftPatch dashboard */
+  deploymentKey: string;
+
+  /** Server URL (defaults to cloud) */
+  serverUrl?: string;
+
+  /** Check for updates when app comes to foreground */
+  checkOnResume?: boolean;
+
+  /** Minimum interval between update checks (ms) */
+  checkInterval?: number;
+
+  /** Install mode for non-mandatory updates */
+  installMode?: InstallMode;
+
+  /** Install mode for mandatory updates */
+  mandatoryInstallMode?: InstallMode;
+
+  /** Enable debug logging */
+  debug?: boolean;
+
+  /** Custom headers for API requests */
+  customHeaders?: Record<string, string>;
+
+  /** Public key for bundle verification (optional) */
+  publicKey?: string;
+
+  /** Auto-stabilize after N successful launches (0 = manual only) */
+  autoStabilizeAfterLaunches?: number;
+
+  /** SDK PIN for in-app dashboard access (optional) */
+  sdkPin?: string;
+}
+
+/**
+ * When to install downloaded updates
+ */
+export enum InstallMode {
+  /** Install immediately and restart */
+  IMMEDIATE = 'immediate',
+
+  /** Install on next app restart */
+  ON_NEXT_RESTART = 'onNextRestart',
+
+  /** Install on next resume from background */
+  ON_NEXT_RESUME = 'onNextResume',
+}
+
+/**
+ * Current update status
+ */
+export enum UpdateStatus {
+  /** Checking for updates */
+  CHECKING = 'checking',
+
+  /** No update available */
+  UP_TO_DATE = 'upToDate',
+
+  /** Update available, not downloaded */
+  UPDATE_AVAILABLE = 'updateAvailable',
+
+  /** Downloading update */
+  DOWNLOADING = 'downloading',
+
+  /** Download complete, ready to install */
+  READY_TO_INSTALL = 'readyToInstall',
+
+  /** Installing update */
+  INSTALLING = 'installing',
+
+  /** Update installed, restart required */
+  RESTART_REQUIRED = 'restartRequired',
+
+  /** Error occurred */
+  ERROR = 'error',
+}
+
+/**
+ * Slot states for the dual-slot architecture
+ */
+export enum SlotState {
+  DEFAULT_SLOT = 'DEFAULT_SLOT',
+  STABLE_SLOT = 'STABLE_SLOT',
+  NEW_SLOT = 'NEW_SLOT',
+}
+
+/**
+ * Environment mode
+ */
+export enum EnvironmentMode {
+  PRODUCTION = 'PROD',
+  STAGING = 'STAGE',
+}
+
+/**
+ * Information about an available release
+ */
+export interface ReleaseInfo {
+  /** Unique release ID */
+  id: string;
+
+  /** Semantic version (e.g., "1.2.3") */
+  version: string;
+
+  /** Release notes */
+  releaseNote: string | null;
+
+  /** Whether update is mandatory */
+  isMandatory: boolean;
+
+  /** SHA-256 hash of the bundle */
+  bundleHash: string;
+
+  /** Download URL (patch or full bundle) */
+  downloadUrl: string;
+
+  /** Size in bytes */
+  downloadSize: number;
+
+  /** Whether this is a patch (true) or full bundle (false) */
+  isPatch: boolean;
+
+  /** Cryptographic signature (if signing enabled) */
+  signature?: string;
+
+  /** Release timestamp */
+  releasedAt: string;
+}
+
+/**
+ * Current bundle information
+ */
+export interface BundleInfo {
+  /** SHA-256 hash of current bundle */
+  hash: string;
+
+  /** Version string */
+  version: string;
+
+  /** When bundle was installed */
+  installedAt: string;
+
+  /** Whether this is the original bundled bundle */
+  isOriginal: boolean;
+
+  /** Current slot state */
+  slot: SlotState;
+
+  /** Current environment */
+  environment: EnvironmentMode;
+}
+
+/**
+ * Slot metadata for the dual-slot system
+ */
+export interface SlotMetadata {
+  environment: EnvironmentMode;
+  prod: {
+    currentSlot: SlotState;
+    newHash: string | null;
+    stableHash: string | null;
+    tempHash: string | null;
+  };
+  stage: {
+    newHash: string | null;
+  };
+}
+
+/**
+ * Download progress information
+ */
+export interface DownloadProgress {
+  /** Bytes downloaded so far */
+  downloadedBytes: number;
+
+  /** Total bytes to download */
+  totalBytes: number;
+
+  /** Progress percentage (0-100) */
+  percentage: number;
+}
+
+/**
+ * SDK event types for analytics
+ */
+export enum SwiftPatchEventType {
+  DOWNLOAD_PROD_STARTED = 'DOWNLOAD_PROD_STARTED',
+  DOWNLOAD_PROD_COMPLETED = 'DOWNLOAD_PROD_COMPLETED',
+  DOWNLOAD_PROD_FAILED = 'DOWNLOAD_PROD_FAILED',
+  INSTALLED_PROD = 'INSTALLED_PROD',
+  ROLLBACK_PROD = 'ROLLBACK_PROD',
+  STABILIZE_PROD = 'STABILIZE_PROD',
+  CORRUPTION_PROD = 'CORRUPTION_PROD',
+  DOWNLOAD_STAGE_STARTED = 'DOWNLOAD_STAGE_STARTED',
+  DOWNLOAD_STAGE_COMPLETED = 'DOWNLOAD_STAGE_COMPLETED',
+  DOWNLOAD_STAGE_FAILED = 'DOWNLOAD_STAGE_FAILED',
+  INSTALLED_STAGE = 'INSTALLED_STAGE',
+  SYNC_ERROR = 'SYNC_ERROR',
+  VERSION_CHANGED = 'VERSION_CHANGED',
+  CRASH_DETECTED = 'CRASH_DETECTED',
+}
+
+/**
+ * A queued SDK event
+ */
+export interface SwiftPatchEvent {
+  id: string;
+  eventType: SwiftPatchEventType;
+  timestamp: number;
+  releaseHash?: string;
+  errorMessage?: string;
+  metadata?: Record<string, unknown>;
+}
+
+/**
+ * SwiftPatch state exposed via hook
+ */
+export interface SwiftPatchState {
+  /** Current update status */
+  status: UpdateStatus;
+
+  /** Download progress (if downloading) */
+  downloadProgress: DownloadProgress | null;
+
+  /** Currently installed bundle info */
+  currentBundle: BundleInfo | null;
+
+  /** Available update info */
+  availableUpdate: ReleaseInfo | null;
+
+  /** Whether restart is required to apply update */
+  isRestartRequired: boolean;
+
+  /** Last error (if status is ERROR) */
+  error: SwiftPatchError | null;
+
+  /** Last check timestamp */
+  lastCheckedAt: Date | null;
+
+  /** Current slot metadata */
+  slotMetadata: SlotMetadata | null;
+
+  /** Current environment */
+  environment: EnvironmentMode;
+}
+
+/**
+ * SwiftPatch actions exposed via hook
+ */
+export interface SwiftPatchActions {
+  /** Check for available updates */
+  checkForUpdate: () => Promise<ReleaseInfo | null>;
+
+  /** Download available update */
+  downloadUpdate: () => Promise<void>;
+
+  /** Install downloaded update */
+  installUpdate: () => Promise<void>;
+
+  /** Restart app to apply update */
+  restart: () => void;
+
+  /** Manually rollback to previous version */
+  rollback: () => Promise<void>;
+
+  /** Clear pending update */
+  clearPendingUpdate: () => Promise<void>;
+
+  /** Get current bundle info */
+  getCurrentBundle: () => Promise<BundleInfo | null>;
+
+  /** Stabilize current bundle (promote NEW → STABLE) */
+  stabilize: () => Promise<SlotMetadata>;
+
+  /** Switch environment (PROD / STAGE) */
+  switchEnvironment: (env: EnvironmentMode) => Promise<SlotMetadata>;
+
+  /** Get slot metadata */
+  getSlotMetadata: () => Promise<SlotMetadata>;
+
+  /** Mark app as mounted (for crash detection) */
+  markMounted: () => void;
+
+  /** Download a stage bundle for testing */
+  downloadStageBundle: (url: string, hash: string) => Promise<void>;
+}
+
+/**
+ * Combined hook return type
+ */
+export type UseSwiftPatchReturn = SwiftPatchState & SwiftPatchActions;
+
+/**
+ * Simplified update hook return type
+ */
+export interface UseSwiftPatchUpdateReturn {
+  isRestartRequired: boolean;
+  newReleaseBundle: ReleaseInfo | null;
+  currentBundle: BundleInfo | null;
+  status: UpdateStatus;
+  restart: () => void;
+}
+
+/**
+ * SwiftPatch error
+ */
+export interface SwiftPatchError {
+  code: SwiftPatchErrorCode;
+  message: string;
+  details?: unknown;
+}
+
+export enum SwiftPatchErrorCode {
+  NETWORK_ERROR = 'NETWORK_ERROR',
+  DOWNLOAD_ERROR = 'DOWNLOAD_ERROR',
+  VERIFICATION_ERROR = 'VERIFICATION_ERROR',
+  PATCH_ERROR = 'PATCH_ERROR',
+  INSTALL_ERROR = 'INSTALL_ERROR',
+  CONFIG_ERROR = 'CONFIG_ERROR',
+  STABILIZE_ERROR = 'STABILIZE_ERROR',
+  ENVIRONMENT_ERROR = 'ENVIRONMENT_ERROR',
+  UNKNOWN_ERROR = 'UNKNOWN_ERROR',
+}
+
+/**
+ * Modal hook return type
+ */
+export interface UseSwiftPatchModalReturn {
+  showModal: () => void;
+  hideModal: () => void;
+  isModalVisible: boolean;
+}

package/src/useSwiftPatch.ts

@@ -0,0 +1,29 @@
+import { useSwiftPatchContext } from './SwiftPatchProvider';
+import type {
+  UseSwiftPatchReturn,
+  UseSwiftPatchUpdateReturn,
+} from './types';
+
+/**
+ * Main hook for accessing all SwiftPatch state and actions.
+ * Must be used within SwiftPatchProvider.
+ */
+export function useSwiftPatch(): UseSwiftPatchReturn {
+  return useSwiftPatchContext();
+}
+
+/**
+ * Simplified hook that only exposes update-related state.
+ * Useful for showing update banners or restart prompts.
+ */
+export function useSwiftPatchUpdate(): UseSwiftPatchUpdateReturn {
+  const ctx = useSwiftPatchContext();
+
+  return {
+    isRestartRequired: ctx.isRestartRequired,
+    newReleaseBundle: ctx.availableUpdate,
+    currentBundle: ctx.currentBundle,
+    status: ctx.status,
+    restart: ctx.restart,
+  };
+}