@onekeyfe/react-native-background-thread 3.0.157-alpha.273 → 3.0.157-alpha.276

package/README.md

@@ -0,0 +1,54 @@
+# @onekeyfe/react-native-background-thread
+
+A separate JavaScript runtime and shared native bridge for OneKey React Native
+applications on iOS and Android. The package exposes background runner startup,
+segment evaluation and runtime restart, together with primitive shared storage
+and inline RPC notifications.
+
+## Installation
+
+```sh
+yarn add @onekeyfe/react-native-background-thread
+```
+
+Install the application's iOS pods and rebuild the native application. Background
+startup also requires the application's native host and background entry bundle;
+this package does not create that entry or its module registry.
+
+## Usage
+
+```ts
+import {
+  BackgroundThread,
+  getSharedStore,
+} from '@onekeyfe/react-native-background-thread';
+
+BackgroundThread.installSharedBridge();
+const store = getSharedStore();
+store?.set('worker.status', 'ready');
+const status = store?.get('worker.status');
+```
+
+`getSharedStore()` and `getSharedRPC()` can return `undefined` before the native
+bridge has been installed in the calling runtime. Shared values are strings,
+numbers or booleans; callers must serialize structured data themselves.
+
+## Runtime and bridge API
+
+- `startBackgroundRunnerWithEntryURL(entryURL)` starts the background entry.
+- `loadSegmentInBackground(segmentId, path)` evaluates a background segment.
+- `restart('ui', reason)` restarts only the UI JavaScript runtime.
+- `restart('all', reason)` restarts both JavaScript runtimes.
+- SharedStore exposes `set`, `get`, `has`, `delete`, `keys`, `clear` and `size`.
+- SharedRPC exposes `write`, `onWrite` and `registerReadinessKey`; notifications
+  include both the call ID and primitive payload, without a read-back operation.
+
+An all-runtime restart preserves the iOS process but replaces the Android
+process. Do not assume native singleton or service state survives on both
+platforms. Bundle switches must restart both runtimes so their module tables
+remain consistent. These differences and restart validation are documented in
+[src/NativeBackgroundThread.ts](src/NativeBackgroundThread.ts).
+
+## License
+
+MIT.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@onekeyfe/react-native-background-thread",
-  "version": "3.0.157-alpha.273",
-  "description": "react-native-background-thread",
+  "version": "3.0.157-alpha.276",
+  "description": "Background JavaScript runtime, shared storage and RPC bridge for OneKey",
   "main": "./lib/module/index.js",
   "types": "./lib/typescript/src/index.d.ts",
   "exports": {
@@ -47,14 +47,15 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/OneKeyHQ/app-modules/react-native-background-thread.git"
+    "url": "git+https://github.com/OneKeyHQ/app-modules.git",
+    "directory": "native-modules/react-native-background-thread"
   },
   "author": "@onekeyhq <huanming@onekey.so> (https://github.com/OneKeyHQ/app-modules)",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/OneKeyHQ/app-modules/react-native-background-thread/issues"
+    "url": "https://github.com/OneKeyHQ/app-modules/issues"
   },
-  "homepage": "https://github.com/OneKeyHQ/app-modules/react-native-background-thread#readme",
+  "homepage": "https://github.com/OneKeyHQ/app-modules/tree/main/native-modules/react-native-background-thread#readme",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },