react-native-update 10.23.0 → 10.24.0

package/README.md

@@ -22,7 +22,7 @@
 ### 本地开发
 
 ```
-$ git clone git@github.com:reactnativecn/react-native-pushy.git
+$ git clone git@github.com:reactnativecn/react-native-update.git
 $ cd react-native-pushy/Example/testHotUpdate
 $ yarn
 $ yarn start
@@ -34,4 +34,4 @@ $ yarn start
 
 本组件由[React Native 中文网](https://reactnative.cn/)独家发布，如有定制需求可以[联系我们](https://reactnative.cn/about.html#content)。
 
-关于此插件发现任何问题，可以前往[Issues](https://github.com/reactnativecn/react-native-pushy/issues)发帖提问。
+关于此插件发现任何问题，可以前往[Issues](https://github.com/reactnativecn/react-native-update/issues)发帖提问。

package/endpoints_cresc.json

@@ -0,0 +1 @@
+["https://cresc-server-pthxtmvcnf.ap-southeast-1.fcapp.run"]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-update",
-  "version": "10.23.0",
+  "version": "10.24.0",
   "description": "react-native hot update",
   "main": "src/index",
   "scripts": {
@@ -26,7 +26,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/reactnativecn/react-native-pushy.git"
+    "url": "git+https://github.com/reactnativecn/react-native-update.git"
   },
   "keywords": [
     "react-native",
@@ -37,13 +37,13 @@
   "author": "reactnativecn",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/reactnativecn/react-native-pushy/issues"
+    "url": "https://github.com/reactnativecn/react-native-update/issues"
   },
   "peerDependencies": {
     "react": ">=16.8.0",
     "react-native": ">=0.59.0"
   },
-  "homepage": "https://github.com/reactnativecn/react-native-pushy#readme",
+  "homepage": "https://github.com/reactnativecn/react-native-update#readme",
   "dependencies": {
     "nanoid": "^3.3.3",
     "react-native-url-polyfill": "^2.0.0"
@@ -74,6 +74,5 @@
     "react-native": "0.73",
     "ts-jest": "^29.2.5",
     "typescript": "^5.6.3"
-  },
-  "packageManager": "yarn@1.22.21+sha1.1959a18351b811cdeedbd484a8f86c3cc3bbaf72"
+  }
 }

package/react-native-update.podspec

@@ -18,7 +18,7 @@ Pod::Spec.new do |s|
   s.cocoapods_version = '>= 1.6.0'
   s.platform = :ios, "8.0"
   s.platforms = { :ios => "11.0" }
-  s.source = { :git => 'https://github.com/reactnativecn/react-native-pushy.git', :tag => '#{s.version}' }
+  s.source = { :git => 'https://github.com/reactnativecn/react-native-update.git', :tag => '#{s.version}' }
   s.source_files    = "ios/**/*.{h,m,mm,swift}"
   s.libraries = 'bz2', 'z'
   s.vendored_libraries = 'RCTPushy/libRCTPushy.a'

package/src/client.ts

@@ -1,4 +1,4 @@
-import { CheckResult, PushyOptions, ProgressData, EventType } from './type';
+import { CheckResult, ClientOptions, ProgressData, EventType } from './type';
 import { emptyObj, joinUrls, log, noop, promiseAny, testUrls } from './utils';
 import { EmitterSubscription, Platform } from 'react-native';
 import { PermissionsAndroid } from './permissions';
@@ -15,31 +15,48 @@ import {
   isRolledBack,
 } from './core';
 
-const defaultServer = {
-  main: 'https://update.react-native.cn/api',
-  backups: ['https://update.reactnative.cn/api'],
-  queryUrls: [
-    'https://gitee.com/sunnylqm/react-native-pushy/raw/master/endpoints.json',
-    'https://cdn.jsdelivr.net/gh/reactnativecn/react-native-pushy@master/endpoints.json',
-  ],
+const SERVER_PRESETS = {
+  // cn
+  pushy: {
+    main: 'https://update.react-native.cn/api',
+    backups: ['https://update.reactnative.cn/api'],
+    queryUrls: [
+      'https://gitee.com/sunnylqm/react-native-pushy/raw/master/endpoints.json',
+      'https://cdn.jsdelivr.net/gh/reactnativecn/react-native-update@master/endpoints.json',
+    ],
+  },
+  // i18n
+  cresc: {
+    main: 'https://api.cresc.dev',
+    backups: ['https://api.cresc.app'],
+    queryUrls: [
+      'https://cdn.jsdelivr.net/gh/reactnativecn/react-native-update@master/endpoints_cresc.json',
+    ],
+  },
 };
-
 if (Platform.OS === 'web') {
-  console.warn('react-native-update 不支持 web 端热更，不会执行操作');
+  console.warn(
+    'react-native-update does not support hot updates on the web platform and will not perform any operations',
+  );
 }
 
+const defaultClientOptions: ClientOptions = {
+  appKey: '',
+  autoMarkSuccess: true,
+  updateStrategy: __DEV__ ? 'alwaysAlert' : 'alertUpdateAndIgnoreError',
+  checkStrategy: 'both',
+  logger: noop,
+  debug: false,
+  throwError: false,
+};
+
+// for China users
 export class Pushy {
-  options: PushyOptions = {
-    appKey: '',
-    server: defaultServer,
-    autoMarkSuccess: true,
-    updateStrategy: __DEV__ ? 'alwaysAlert' : 'alertUpdateAndIgnoreError',
-    checkStrategy: 'both',
-    logger: noop,
-    debug: false,
-    throwError: false,
+  options: ClientOptions = {
+    ...defaultClientOptions,
+    server: SERVER_PRESETS.pushy,
   };
-
+  clientType: 'pushy' | 'cresc' = 'pushy';
   lastChecking?: number;
   lastRespJson?: Promise<any>;
 
@@ -50,7 +67,7 @@ export class Pushy {
 
   static marked = false;
   static applyingUpdate = false;
-  version = cInfo.pushy;
+  version = cInfo.rnu;
   loggerPromise = (() => {
     let resolve: (value?: unknown) => void = () => {};
     const promise = new Promise(res => {
@@ -62,7 +79,7 @@ export class Pushy {
     };
   })();
 
-  constructor(options: PushyOptions) {
+  constructor(options: ClientOptions) {
     if (Platform.OS === 'ios' || Platform.OS === 'android') {
       if (!options.appKey) {
         throw new Error('appKey is required');
@@ -79,7 +96,7 @@ export class Pushy {
     }
   }
 
-  setOptions = (options: Partial<PushyOptions>) => {
+  setOptions = (options: Partial<ClientOptions>) => {
     for (const [key, value] of Object.entries(options)) {
       if (value !== undefined) {
         (this.options as any)[key] = value;
@@ -124,10 +141,10 @@ export class Pushy {
     return `${endpoint}/checkUpdate/${this.options.appKey}`;
   };
   static assertHash = (hash: string) => {
-    if (!Pushy.downloadedHash) {
+    if (!this.downloadedHash) {
       return;
     }
-    if (hash !== Pushy.downloadedHash) {
+    if (hash !== this.downloadedHash) {
       log(`use downloaded hash ${Pushy.downloadedHash} first`);
       return;
     }
@@ -144,7 +161,7 @@ export class Pushy {
   switchVersion = async (hash: string) => {
     if (__DEV__) {
       console.warn(
-        '您调用了switchVersion方法，但是当前是开发环境，不会进行任何操作。',
+        'switchVersion() is not supported in development environment; no action taken.',
       );
       return;
     }
@@ -158,7 +175,7 @@ export class Pushy {
   switchVersionLater = async (hash: string) => {
     if (__DEV__) {
       console.warn(
-        '您调用了switchVersionLater方法，但是当前是开发环境，不会进行任何操作。',
+        'switchVersionLater() is not supported in development environment; no action taken.',
       );
       return;
     }
@@ -170,19 +187,19 @@ export class Pushy {
   checkUpdate = async (extra?: Record<string, any>) => {
     if (__DEV__ && !this.options.debug) {
       console.info(
-        '您当前处于开发环境且未启用 debug，不会进行热更检查。如需在开发环境中调试热更，请在 client 中设置 debug 为 true',
+        'You are currently in the development environment and have not enabled debug mode. The hot update check will not be performed. If you need to debug hot updates in the development environment, please set debug to true in the client.',
       );
       return;
     }
     if (Platform.OS === 'web') {
-      console.warn('web 端不支持热更新检查');
+      console.warn('web platform does not support hot update check');
       return;
     }
     if (
       this.options.beforeCheckUpdate &&
       (await this.options.beforeCheckUpdate()) === false
     ) {
-      log('beforeCheckUpdate 返回 false, 忽略检查');
+      log('beforeCheckUpdate returned false, skipping check');
       return;
     }
     const now = Date.now();
@@ -310,7 +327,7 @@ export class Pushy {
       this.options.beforeDownloadUpdate &&
       (await this.options.beforeDownloadUpdate(info)) === false
     ) {
-      log('beforeDownloadUpdate 返回 false, 忽略下载');
+      log('beforeDownloadUpdate returned false, skipping download');
       return;
     }
     if (!info.update || !hash) {
@@ -489,3 +506,12 @@ export class Pushy {
     }
   };
 }
+
+// for international users
+export class Cresc extends Pushy {
+  clientType: 'cresc' | 'pushy' = 'cresc';
+  options: ClientOptions = {
+    ...defaultClientOptions,
+    server: SERVER_PRESETS.cresc,
+  };
+}

package/src/context.ts

@@ -1,6 +1,6 @@
 import { createContext, useContext } from 'react';
 import { CheckResult, ProgressData } from './type';
-import { Pushy } from './client';
+import { Pushy, Cresc } from './client';
 
 const noop = () => {};
 const asyncNoop = () => Promise.resolve();
@@ -19,7 +19,7 @@ export const defaultContext = {
   packageVersion: '',
 };
 
-export const PushyContext = createContext<{
+export const UpdateContext = createContext<{
   checkUpdate: () => Promise<void>;
   switchVersion: () => Promise<void>;
   switchVersionLater: () => Promise<void>;
@@ -35,10 +35,14 @@ export const PushyContext = createContext<{
   parseTestQrCode: (code: string) => boolean;
   currentHash: string;
   packageVersion: string;
-  client?: Pushy;
+  client?: Pushy | Cresc;
   progress?: ProgressData;
   updateInfo?: CheckResult;
   lastError?: Error;
 }>(defaultContext);
 
-export const usePushy = () => useContext(PushyContext);
+export const useUpdate = () => useContext(UpdateContext);
+
+export const usePushy = useUpdate;
+
+export const useCresc = useUpdate;

package/src/core.ts

@@ -13,8 +13,12 @@ export const PushyModule =
     ? require('./NativePushy').default
     : NativeModules.Pushy;
 
+export const UpdateModule = PushyModule;
+
 if (!PushyModule) {
-  throw new Error('react-native-update 模块无法加载，请对照安装文档检查配置。');
+  throw new Error(
+    'Failed to load react-native-update native module, please try to recompile',
+  );
 }
 
 const PushyConstants = isTurboModuleEnabled
@@ -31,12 +35,6 @@ export const isRolledBack: boolean = typeof rolledBackVersion === 'string';
 export const buildTime: string = PushyConstants.buildTime;
 let uuid = PushyConstants.uuid;
 
-if (Platform.OS === 'android' && !PushyConstants.isUsingBundleUrl) {
-  throw new Error(
-    'react-native-update 模块无法加载，请对照文档检查 Bundle URL 的配置',
-  );
-}
-
 export function setLocalHashInfo(hash: string, info: Record<string, any>) {
   PushyModule.setLocalHashInfo(hash, JSON.stringify(info));
 }
@@ -63,7 +61,7 @@ if (!uuid) {
 log('uuid: ' + uuid);
 
 export const cInfo = {
-  pushy: require('../package.json').version,
+  rnu: require('../package.json').version,
   rn: RNVersion,
   os: Platform.OS + ' ' + Platform.Version,
   uuid,

package/src/index.ts

@@ -1,4 +1,4 @@
-export { Pushy } from './client';
-export { PushyContext, usePushy } from './context';
-export { PushyProvider } from './provider';
-export { PushyModule } from './core';
+export { Pushy, Cresc } from './client';
+export { UpdateContext, usePushy, useCresc } from './context';
+export { PushyProvider, UpdateProvider } from './provider';
+export { PushyModule, UpdateModule } from './core';

package/src/provider.tsx

@@ -12,19 +12,19 @@ import {
   Platform,
   Linking,
 } from 'react-native';
-import { Pushy } from './client';
+import { Pushy, Cresc } from './client';
 import { currentVersion, packageVersion, getCurrentVersionInfo } from './core';
-import { CheckResult, ProgressData, PushyTestPayload } from './type';
-import { PushyContext } from './context';
+import { CheckResult, ProgressData, UpdateTestPayload } from './type';
+import { UpdateContext } from './context';
 import { URL } from 'react-native-url-polyfill';
 import { isInRollout } from './isInRollout';
 import { log } from './utils';
 
-export const PushyProvider = ({
+export const UpdateProvider = ({
   client,
   children,
 }: {
-  client: Pushy;
+  client: Pushy | Cresc;
   children: ReactNode;
 }) => {
   const { options } = client;
@@ -275,8 +275,8 @@ export const PushyProvider = ({
   }, [checkUpdate, options, dismissError, markSuccess]);
 
   const parseTestPayload = useCallback(
-    (payload: PushyTestPayload) => {
-      if (payload && payload.type && payload.type.startsWith('__rnPushy')) {
+    (payload: UpdateTestPayload) => {
+      if (payload && payload.type && payload.type.startsWith('__rnUpdate')) {
         const logger = options.logger || (() => {});
         options.logger = ({ type, data }) => {
           logger({ type, data });
@@ -286,8 +286,8 @@ export const PushyProvider = ({
           checkUpdate({ extra: { toHash: payload.data } }).then(() => {
             if (updateInfoRef.current && updateInfoRef.current.upToDate) {
               Alert.alert(
-                '提示',
-                '当前尚未检测到更新版本，如果是首次扫码，请等待服务器端生成补丁包后再试（约10秒）',
+                'Info',
+                'No update found, please wait 10s for the server to generate the patch package',
               );
             }
             options.logger = logger;
@@ -301,7 +301,7 @@ export const PushyProvider = ({
   );
 
   const parseTestQrCode = useCallback(
-    (code: string | PushyTestPayload) => {
+    (code: string | UpdateTestPayload) => {
       try {
         const payload = typeof code === 'string' ? JSON.parse(code) : code;
         return parseTestPayload(payload);
@@ -335,7 +335,7 @@ export const PushyProvider = ({
   }, [parseTestPayload]);
 
   return (
-    <PushyContext.Provider
+    <UpdateContext.Provider
       value={{
         checkUpdate,
         switchVersion,
@@ -354,6 +354,8 @@ export const PushyProvider = ({
         parseTestQrCode,
       }}>
       {children}
-    </PushyContext.Provider>
+    </UpdateContext.Provider>
   );
 };
+
+export const PushyProvider = UpdateProvider;

package/src/type.ts

@@ -44,7 +44,7 @@ export type EventType =
 export interface EventData {
   currentVersion: string;
   cInfo: {
-    pushy: string;
+    rnu: string;
     rn: string;
     os: string;
     uuid: string;
@@ -65,15 +65,15 @@ export type UpdateEventsLogger = ({
   data: EventData;
 }) => void;
 
-export interface PushyServerConfig {
+export interface UpdateServerConfig {
   main: string;
   backups?: string[];
   queryUrls?: string[];
 }
 
-export interface PushyOptions {
+export interface ClientOptions {
   appKey: string;
-  server?: PushyServerConfig;
+  server?: UpdateServerConfig;
   logger?: UpdateEventsLogger;
   updateStrategy?:
     | 'alwaysAlert'
@@ -90,7 +90,7 @@ export interface PushyOptions {
   beforeDownloadUpdate?: (info: CheckResult) => Promise<boolean>;
 }
 
-export interface PushyTestPayload {
+export interface UpdateTestPayload {
   type: '__rnPushyVersionHash' | string | null;
   data: any;
 }

package/src/utils.ts

@@ -1,7 +1,7 @@
 import { Platform } from 'react-native';
 
 export function log(...args: any[]) {
-  console.log('pushy: ', ...args);
+  console.log('react-native-update: ', ...args);
 }
 
 export function promiseAny<T>(promises: Promise<T>[]) {