SDK API 参考

import { Pakta } from 'rn-update';

const client = new Pakta({
  appKey: '<你的 appKey>',
  updateStrategy: 'silentAndLater',
});

// 运行中动态更新配置（合并新配置，并通知 Provider）
client.setOptions({ checkStrategy: 'onAppResume' });

// 手动上报 JS 异常（默认自动监听未捕获的 JS 错误）
client.captureException(error, { context: 'checkout' });

import { Pakta, UpdateProvider, PaktaProvider, useUpdate, usePakta, useUpdateProgress } from 'rn-update';

interface CheckResult {
  upToDate?: boolean;      // 已是最新
  update?: boolean;        // 有可用更新
  expired?: boolean;       // 原生包过期，downloadUrl 指向新安装包
  paused?: 'app' | 'package'; // 应用或原生包暂停
  downloadUrl?: string;    // 过期安装包地址
  bundleStatus?: 'matched' | 'rebuiltSameJs' | 'unknownBundle';
  name?: string;           // 版本名
  hash?: string;           // 版本 hash
  description?: string;    // 版本描述
  metaInfo?: string;       // 自定义元信息（JSON 字符串）
  config?: { rollout?: Record<string, number>; forceBoot?: boolean };
  pdiff?: string;          // 精确差分包地址
  diff?: string;           // 普通差分包地址
  full?: string;           // 全量包地址
}

import * as Sentry from '@sentry/react-native';
import { attachToSentry, getUpdateMetadata } from 'rn-update';

// 在已有 Sentry 初始化之后调用。
attachToSentry(Sentry);
const metadata = getUpdateMetadata();

checkUpdate(params?: { extra?: { toHash?: string } }): Promise<CheckResult | undefined>

const { checkUpdate, lastError } = useUpdate();

async function onCheck() {
  const info = await checkUpdate();
  if (!info) return;
  if (info.expired) {
    // 当前安装包需要升级，下载地址在 info.downloadUrl。
    return;
  }
  if (info.paused) return;
  if (info.upToDate) return;
  if (info.update) {
    // 后续下载和生效行为取决于 updateStrategy。
  }
}

downloadUpdate(info?: CheckResult): Promise<boolean | undefined>

const { updateInfo, downloadUpdate } = useUpdate();

async function onDownload() {
  if (!updateInfo?.update) return;
  const completed = await downloadUpdate(updateInfo);
  if (!completed) return;
}

downloadAndInstallApk(url: string): Promise<void>

<uses-permission android:name="android.permission.REQUEST_INSTALL_PACKAGES" />

import { useState } from 'react';
import { Button, Platform, Text, View } from 'react-native';
import { useUpdate, useUpdateProgress } from 'rn-update';

export function NativeUpgradeButton({ apkUrl }: { apkUrl: string }) {
  const { downloadAndInstallApk, lastError } = useUpdate();
  const progress = useUpdateProgress();
  const [busy, setBusy] = useState(false);
  const [error, setError] = useState('');

  async function install() {
    if (busy || !apkUrl) return;
    setBusy(true);
    setError('');
    try {
      await downloadAndInstallApk(apkUrl);
    } catch (cause) {
      setError(cause instanceof Error ? cause.message : String(cause));
    } finally {
      setBusy(false);
    }
  }

  if (Platform.OS !== 'android') return null;
  const percent = progress?.hash === 'downloadingApk' && progress.total > 0
    ? Math.round(progress.received / progress.total * 100)
    : undefined;
  return (
    <View>
      <Button title={busy ? '正在下载' : '升级安装包'}
        disabled={busy || !apkUrl} onPress={() => { void install(); }} />
      {percent !== undefined ? <Text>{percent}%</Text> : null}
      {error || lastError ? <Text>{error || lastError?.message}</Text> : null}
    </View>
  );
}

markSuccess(): Promise<boolean | undefined>

autoMarkSuccess: false,

const { markSuccess } = useUpdate();

async function confirmReady() {
  try {
    const accepted = await markSuccess();
    if (accepted === false) {
      // 未接受确认，保留诊断信息。
    }
  } catch (error) {
    // 展示或记录确认失败，不要当成已成功。
  }
}

currentVersionInfo: {
  name?: string;
  description?: string;
  metaInfo?: string;
} | null

const { currentVersionInfo, currentHash, packageVersion } = useUpdate();
const label = currentVersionInfo?.name || '安装包自带版本';

getCurrentVersionInfo(): Promise<{
  name?: string;
  description?: string;
  metaInfo?: string;
}>

const { getCurrentVersionInfo } = useUpdate();
const version = await getCurrentVersionInfo();

restartApp(): Promise<void>

const { restartApp } = useUpdate();
await restartApp();

resetToPackagedBundle(options?: { restart?: boolean }): Promise<boolean | undefined>

const { resetToPackagedBundle } = useUpdate();
const reset = await resetToPackagedBundle({ restart: true });
if (!reset) {
  // 重置没有成功，不要向用户显示“已恢复”。
}

switchVersion(info?: CheckResult): Promise<boolean | undefined>

const { switchVersion, updateInfo } = useUpdate();
if (updateInfo?.hash) await switchVersion(updateInfo);

switchVersionLater(info?: CheckResult): Promise<void>

const { switchVersionLater, updateInfo } = useUpdate();
if (updateInfo?.hash) await switchVersionLater(updateInfo);

parseTestQrCode(code: string | UpdateTestPayload): boolean

const { parseTestQrCode } = useUpdate();
const accepted = parseTestQrCode({
  type: '__rnPaktaVersionHash',
  data: '替换成控制台里目标更新的完整 hash',
});

import { Text } from 'react-native';
import { useUpdateProgress } from 'rn-update';

export function DownloadProgress() {
  const data = useUpdateProgress();
  if (!data) return null;
  const percent = data.progress ?? (data.total > 0
    ? Math.round(data.received / data.total * 100) : undefined);
  return <Text>{percent === undefined ? '正在下载' : `${percent}%`}</Text>;
}

const { lastError, dismissError } = useUpdate();
// 在用户关闭错误提示时调用 dismissError()。

import { useState } from 'react';
import { Button, Text, View } from 'react-native';
import { useUpdate } from 'rn-update';

export function ManualUpdateButton() {
  const { client } = useUpdate();
  const [busy, setBusy] = useState(false);
  const [message, setMessage] = useState('');
  async function update() {
    if (!client || busy) return;
    setBusy(true);
    try {
      const info = await client.checkUpdate();
      if (!info?.update) {
        setMessage(info?.expired ? '请升级安装包' : '暂无可下载更新');
        return;
      }
      const hash = await client.downloadUpdate(info, (data) => {
        setMessage(data.progress === undefined ? '正在下载' : `${data.progress}%`);
      });
      if (!hash) return;
      await client.switchVersionLater(hash);
      setMessage('下载完成，下次启动生效');
    } catch (error) {
      setMessage(error instanceof Error ? error.message : String(error));
    } finally {
      setBusy(false);
    }
  }
  return <View>
    <Button title="检查并下载" disabled={busy} onPress={() => { void update(); }} />
    <Text>{message}</Text>
  </View>;
}

beforeReload: async ({ type }) => {
  if (type === 'switchVersion') {
    const saved = await savePendingDrafts();
    return saved;
  }
  return true;
},

const { client } = useUpdate();
try {
  await submitOrder();
} catch (error) {
  client?.captureException(error, { context: 'checkout' });
}

import cn.reactnative.modules.update.UpdateContext;

UpdateContext.setCustomInstanceManager(reactInstanceManager);