@onekeyfe/react-native-native-logger 3.0.157-alpha.275 → 3.0.157-alpha.276

package/README.md

@@ -0,0 +1,49 @@
+# @onekeyfe/react-native-native-logger
+
+Native file logging for OneKey React Native applications on iOS and Android.
+The JavaScript interface writes messages, enumerates log files and clears stored
+logs. Native code owns log formatting, rotation and repeat-message handling.
+
+## Installation
+
+```sh
+yarn add @onekeyfe/react-native-native-logger react-native-nitro-modules
+```
+
+Install the application's iOS pods and rebuild the native application after
+adding the package. This module requires the Nitro native runtime; installing
+the JavaScript package alone does not register its native implementation.
+
+## Usage
+
+```ts
+import { NativeLogger } from '@onekeyfe/react-native-native-logger';
+
+NativeLogger.write(1, 'Application started');
+NativeLogger.flushPendingRepeat();
+
+const directory = NativeLogger.getLogDirectory();
+const files = await NativeLogger.getLogFilePaths();
+```
+
+## API
+
+| Method | Purpose |
+| --- | --- |
+| `write(level, msg)` | Write a message: 0 debug, 1 info, 2 warning, 3 error. |
+| `flushPendingRepeat()` | Flush a pending repeated-message summary before export. |
+| `getLogDirectory()` | Return the native log directory. |
+| `getLogFilePaths()` | List native log files asynchronously. |
+| `deleteLogFiles()` | Clear the native log files. |
+
+On iOS, `getLogFilePaths()` returns filenames, rather than absolute paths; combine
+them with the directory when exporting. Clearing logs can truncate the active
+file instead of removing it. Callers own export and upload, and should avoid
+writing credentials or other private values into messages.
+
+The current bridge is defined in [src/NativeLogger.nitro.ts](src/NativeLogger.nitro.ts).
+Native behavior is implemented in the package's `ios` and `android` directories.
+
+## License
+
+MIT.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@onekeyfe/react-native-native-logger",
-  "version": "3.0.157-alpha.275",
-  "description": "react-native-native-logger",
+  "version": "3.0.157-alpha.276",
+  "description": "Native file logging and log export support for OneKey on iOS and Android",
   "main": "./lib/module/index.js",
   "types": "./lib/typescript/src/index.d.ts",
   "exports": {
@@ -50,14 +50,15 @@
   ],
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/OneKeyHQ/app-modules/native-logger.git"
+    "url": "git+https://github.com/OneKeyHQ/app-modules.git",
+    "directory": "native-modules/native-logger"
   },
   "author": "onekeyfe <huanming@onekey.so> (https://github.com/OneKeyHQ/app-modules)",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/OneKeyHQ/app-modules/native-logger/issues"
+    "url": "https://github.com/OneKeyHQ/app-modules/issues"
   },
-  "homepage": "https://github.com/OneKeyHQ/app-modules/native-logger#readme",
+  "homepage": "https://github.com/OneKeyHQ/app-modules/tree/main/native-modules/native-logger#readme",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },