@wutiange/log-listener-plugin 2.0.1 → 2.0.2-alpha.2

package/README.md

@@ -1,163 +1,166 @@
-# log-listener-plugin
-[![Dependencies](https://img.shields.io/badge/dependencies-none-green)](https://www.npmjs.com/package/@wutiange/log-listener-plugin?activeTab=dependencies)
-[![npm](https://img.shields.io/npm/v/@wutiange/log-listener-plugin)](https://www.npmjs.com/package/@wutiange/log-listener-plugin)
-[![npm downloads](https://img.shields.io/npm/dm/@wutiange/log-listener-plugin)](https://www.npmjs.com/package/@wutiange/log-listener-plugin)
-[![License](https://img.shields.io/npm/l/@wutiange/log-listener-plugin)](./LICENSE)
-
-中文 | [English](./docs/README_EN.md)
-
-要想正常使用 [log-record](https://github.com/wutiange/log-record) 客户端来收集日志，方便排查问题，那么就需要把这个插件安装到项目中。
-
-## 1. 安装
-
-使用 npm 安装
-
-```bash
-npm install @wutiange/log-listener-plugin
-```
-
-使用 yarn 安装
-
-```bash
-yarn add @wutiange/log-listener-plugin
-```
-
-## 2. 使用
-
-在你需要开始记录日志的地方，调用下面的代码即可。
-
-### 2.1 基于自我发现的使用
-
-先安装 react-native-zeroconf ，这个的目的是发现局域网内可用的日志系统。
-
-```bash
-yarn add react-native-zeroconf
-# 或
-npm install react-native-zeroconf
-```
-
-具体安装步骤请移步：[react-native-zeroconf](https://www.npmjs.com/package/react-native-zeroconf) ，请不要忽略这行，因为要想使用这个还需要做一些必要的步骤，我也把这些复制到下面，以免被人忽略。
-
-For Android please ensure your manifest is requesting all necessary permissions.
-
-```xml
-<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
-<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
-<uses-permission android:name="android.permission.CHANGE_WIFI_MULTICAST_STATE" />
-```
-
-IOS 14 requires you to specify the services you want to scan for and a description for what you're using them.
-
-In your `info.plist` add the following strings:
-
-```plist
-<key>NSBonjourServices</key>
-	<array>
-		<string>_http._tcp</string>
-	</array>
-<key>NSLocalNetworkUsageDescription</key>
-<string>Access nearby Log Records to view logs</string>
-```
-
-接下来只需要在项目中找个合适的位置，一般是在 App.js 中调用。
-
-```ts
-import logger from '@wutiange/log-listener-plugin';
-// 启动日志记录
-logger.config({isAuto: true});
-```
-
-### 2.2 基于手动设置的方式使用
-
-```ts
-import logger from '@wutiange/log-listener-plugin';
-// 填写日志服务器的地址，如果你使用自我发现功能，那么这一步可以省略
-logger.config({isAuto: true, testUrl: 'http://127.0.0.1'});
-```
-
-### 2.3 设置基本数据
-
-设置基础数据，一般数据从 react-native-device-info 中获取，如果你没有特殊的可以不要调用，内部会根据你安装的 react-native-device-info 自动获取基础数据。这些基础数据的目的是为了过滤数据，不是必须的。
-
-```ts
-logger.config({
-  baseData: {
-    Brand: DeviceInfo.getBrand(),
-    Model: DeviceInfo.getModel(),
-    AppVersion: DeviceInfo.getVersion(),
-    Carrier: DeviceInfo.getCarrierSync(),
-    Manufacturer: DeviceInfo.getManufacturerSync(),
-    SystemName: DeviceInfo.getSystemName(),
-  }
-});
-```
-
-### 2.4 单独记录和停止所有记录
-
-尽量不要使用以下 API ，这些 API 也没必要，这些数据都只会保存到你打开的日志系统中，所以都是能收集啥就都收集啥，目的是方便排查问题。
-
-```ts
-// 只抓取日志
-logger.startRecordLog();
-// 只抓取网络日志
-logger.startRecordNetwork();
-
-// 停止日志记录，会同时停止日志和网络
-logger.unAuto();
-```
-
-### 2.5 其他使用说明
-
-如果你希望杀死手机后下次进来仍然能记住之前保存的 IP 地址，那么你可以考虑安装：
-
-```bash
-yarn add @react-native-async-storage/async-storage
-```
-
-如果你本地有安装其他的 storage ，那么你可以手动设置：
-
-```ts
-logger.config({
-  storage: // 你的 storage ；或者你自己写的，只要遵循 getItem 和 setItem 接口规范即可  
-})
-```
-
-现在把若干配置相关的都放到了 config 中，以此来简化配置，配置的每一项都是可选的：
-
-```ts
-type Options = {
-  /**
-   * storage 用于存储已设置的日志系统的 url
-   * @default @react-native-async-storage/async-storage
-   */
-  storage?: Storage
-  /**
-   * 设置上传日志的超时时间，单位为毫秒
-   * @default 3000
-   */
-  timeout?: number
-  /**
-   * 日志系统的url
-   */
-  testUrl?: string
-  /**
-   * 是否自动开启日志记录
-   * @default false
-   */
-  isAuto?: boolean
-  /**
-   * 设置日志系统的基础数据，这些数据会自动添加到每条日志中
-   */
-  baseData?: Record<string, any>
-}
-```
-
-这是 config 每一项的说明。
-
-## 3. 其他重要说明
-
-1.  如果你使用的自我发现模式，那么要保证你的手机和 log-record 客户端在同一个局域网下。
-1.  在配置 baseUrl 的时候，必须填写的是 [log-record](https://github.com/wutiange/log-record) 的地址，也就是你在什么电脑打开的 log-record 客户端，那么这里添加的就是对应电脑的 ip 地址。集成这个插件的 app 端要保证跟 log-record 客户端在同一个局域网下。
-1.  如果你不知道日志系统的 IP ，可以在日志系统的 `设置 > 链接说明（需要版本大于1.0.9）` 中找到，如下图所示：
-
-![0cf34d6cd25ee1f725b57dd2d076c336.png](https://github.com/wutiange/log-listener-plugin/raw/dev/docs/images/0cf34d6cd25ee1f725b57dd2d076c336.png)
+Here's the English translation while maintaining the same format and keeping "Log Record" unchanged:
+
+# log-listener-plugin
+[![Dependencies](https://img.shields.io/badge/dependencies-none-green)](https://www.npmjs.com/package/@wutiange/log-listener-plugin?activeTab=dependencies)
+[![npm](https://img.shields.io/npm/v/@wutiange/log-listener-plugin)](https://www.npmjs.com/package/@wutiange/log-listener-plugin)
+[![npm downloads](https://img.shields.io/npm/dm/@wutiange/log-listener-plugin)](https://www.npmjs.com/package/@wutiange/log-listener-plugin)
+[![License](https://img.shields.io/npm/l/@wutiange/log-listener-plugin)](./LICENSE)
+
+[中文](../../README.md) | English
+
+To properly use the [Log Record](https://github.com/wutiange/log-record) client for log collection and troubleshooting, you need to install this plugin in your project.
+
+## 1. Installation
+
+Install using npm
+
+```bash
+npm install @wutiange/log-listener-plugin
+```
+
+Install using yarn
+
+```bash
+yarn add @wutiange/log-listener-plugin
+```
+**Since the logging system uses HTTP, the project needs to be configured to support HTTP for proper operation.**
+
+## 2. Usage
+
+Call the following code where you need to start recording logs.
+
+### 2.1 Usage Based on Auto-Discovery
+
+First install react-native-zeroconf, which is used to discover available logging systems in the local network.
+
+```bash
+yarn add react-native-zeroconf
+# or
+npm install react-native-zeroconf
+```
+
+For detailed installation steps, please visit: [react-native-zeroconf](https://www.npmjs.com/package/react-native-zeroconf). Don't ignore this line as there are necessary steps to follow. I've also copied these steps below to prevent oversight.
+
+For Android please ensure your manifest is requesting all necessary permissions.
+
+```xml
+<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
+<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
+<uses-permission android:name="android.permission.CHANGE_WIFI_MULTICAST_STATE" />
+```
+
+IOS 14 requires you to specify the services you want to scan for and a description for what you're using them.
+
+In your `info.plist` add the following strings:
+
+```plist
+<key>NSBonjourServices</key>
+	<array>
+		<string>_http._tcp</string>
+	</array>
+<key>NSLocalNetworkUsageDescription</key>
+<string>Access nearby Log Records to view logs</string>
+```
+
+Then find a suitable place in your project, typically in App.js, to make the call.
+
+```ts
+import logger from '@wutiange/log-listener-plugin';
+// Start log recording
+logger.config({isAuto: true});
+```
+
+### 2.2 Usage Based on Manual Configuration
+
+```ts
+import logger from '@wutiange/log-listener-plugin';
+// Fill in the log server address. If you use auto-discovery, this step can be skipped
+logger.config({isAuto: true, testUrl: 'http://127.0.0.1'});
+```
+
+### 2.3 Setting Basic Data
+
+Set basic data, typically obtained from react-native-device-info. If you don't have specific requirements, you can skip this call as the basic data will be automatically retrieved from react-native-device-info if installed. This basic data is used for filtering and is not mandatory.
+
+```ts
+logger.config({
+  baseData: {
+    Brand: DeviceInfo.getBrand(),
+    Model: DeviceInfo.getModel(),
+    AppVersion: DeviceInfo.getVersion(),
+    Carrier: DeviceInfo.getCarrierSync(),
+    Manufacturer: DeviceInfo.getManufacturerSync(),
+    SystemName: DeviceInfo.getSystemName(),
+  }
+});
+```
+
+### 2.4 Individual Recording and Stopping All Records
+
+Try to avoid using the following APIs as they are unnecessary. This data will only be saved to the logging system you have open, so collect whatever is available to facilitate troubleshooting.
+
+```ts
+// Only capture logs
+logger.startRecordLog();
+// Only capture network logs
+logger.startRecordNetwork();
+
+// Stop log recording, will stop both logs and network
+logger.unAuto();
+```
+
+### 2.5 Other Usage Instructions
+
+If you want to remember the previously saved IP address even after killing the app, consider installing:
+
+```bash
+yarn add @react-native-async-storage/async-storage
+```
+
+If you have other storage installed locally, you can set it manually:
+
+```ts
+logger.config({
+  storage: // Your storage or custom implementation, as long as it follows the getItem and setItem interface specifications
+})
+```
+
+Now all configuration-related items are placed in config to simplify configuration. Each configuration item is optional:
+
+```ts
+type Options = {
+  /**
+   * storage is used to store the url of the configured logging system
+   * @default @react-native-async-storage/async-storage
+   */
+  storage?: Storage
+  /**
+   * Set the upload log timeout in milliseconds
+   * @default 3000
+   */
+  timeout?: number
+  /**
+   * Logging system url
+   */
+  testUrl?: string
+  /**
+   * Whether to automatically start log recording
+   * @default false
+   */
+  isAuto?: boolean
+  /**
+   * Set basic data for the logging system, this data will be automatically added to each log
+   */
+  baseData?: Record<string, any>
+}
+```
+
+This is the description of each config item.
+
+## 3. Other Important Notes
+
+1. If you're using auto-discovery mode, ensure your phone and Log Record client are on the same local network.
+2. When configuring baseUrl, you must enter the address of [Log Record](https://github.com/wutiange/log-record). In other words, use the IP address of the computer where you opened the Log Record client. The app integrated with this plugin must be on the same local network as the Log Record client.
+3. If you don't know the logging system's IP, you can find it in the Log Record client under `Settings > Connection Instructions (requires version > 1.0.9)`, as shown in the image below:
+
+![ip 地址](https://raw.githubusercontent.com/wutiange/assets/refs/heads/master/images/0cf34d6cd25ee1f725b57dd2d076c336.png)

package/dist/index.cjs.js

@@ -0,0 +1,7 @@
+'use strict';
+
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const logPlugin_1 = tslib_1.__importDefault(require("./src/logPlugin"));
+exports.default = logPlugin_1.default;
+//# sourceMappingURL=index.cjs.js.map

package/dist/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../../index.ts"],"sourcesContent":[null],"names":[],"mappings":";;;;AAAA,MAAwC,WAAA,GAAA,OAAA,CAAA,eAAA,CAAA,OAAA,CAAA,iBAAA,CAAA,CAAA;AAExC,OAAA,CAAA,OAAA,GAAe,mBAAS;;"}

package/dist/index.d.ts

@@ -1,2 +1,34 @@
-import logPlugin from './src/logPlugin';
-export default logPlugin;
+type Options = {
+    storage?: Storage;
+    timeout?: number;
+    testUrl?: string;
+    isAuto?: boolean;
+    baseData?: Record<string, any>;
+};
+declare class LogPlugin {
+    private server;
+    private timeout;
+    private isAuto;
+    private storage;
+    constructor();
+    private init;
+    config: ({ storage, timeout, testUrl, isAuto, baseData }: Options) => void;
+    auto: () => void;
+    unAuto: () => void;
+    startRecordLog: () => void;
+    stopRecordLog: () => void;
+    private handleIgnoredUrls;
+    startRecordNetwork: () => void;
+    setBaseUrl: (url?: string) => void;
+    setTimeout: (timeout: number) => void;
+    getTimeout: () => number | null;
+    setBaseData: (data?: Record<string, any>) => void;
+    private _log;
+    tag: (tag: string, ...data: any[]) => void;
+    log: (...data: any[]) => void;
+    warn: (...data: any[]) => void;
+    error: (...data: any[]) => void;
+}
+declare const logPlugin: LogPlugin;
+
+export { logPlugin as default };

package/dist/index.esm.js

@@ -0,0 +1,5 @@
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const logPlugin_1 = tslib_1.__importDefault(require("./src/logPlugin"));
+exports.default = logPlugin_1.default;
+//# sourceMappingURL=index.esm.js.map

package/dist/index.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.esm.js","sources":["../../index.ts"],"sourcesContent":[null],"names":[],"mappings":";;AAAA,MAAwC,WAAA,GAAA,OAAA,CAAA,eAAA,CAAA,OAAA,CAAA,iBAAA,CAAA,CAAA;AAExC,OAAA,CAAA,OAAA,GAAe,mBAAS"}

package/index.ts

@@ -1,3 +1,3 @@
-import logPlugin from './src/logPlugin';
-
-export default logPlugin;
+import logPlugin from './src/logPlugin';
+
+export default logPlugin;

package/package.json

@@ -1,59 +1,52 @@
-{
-  "name": "@wutiange/log-listener-plugin",
-  "version": "2.0.1",
-  "description": "log-record 客户端对应的的插件\r\nLog-record client corresponding plugin",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "source": "index.ts",
-  "react-native": "index.ts",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/wutiange/log-listener-plugin.git"
-  },
-  "author": "wutiange <wutiange20@qq,com>",
-  "license": "MIT",
-  "keywords": [
-    "react-native",
-    "log",
-    "debugger",
-    "charles"
-  ],
-  "private": false,
-  "scripts": {
-    "build": "npm run test && tsc",
-    "dev": "ts-node ./index.ts",
-    "publish-alpha": "npm publish --access public --tag alpha",
-    "prepublishOnly": "npm run build",
-    "test": "jest"
-  },
-  "devDependencies": {
-    "@jest/globals": "^29.7.0",
-    "@types/crypto-js": "^4.2.2",
-    "@types/jest": "^29.5.12",
-    "@types/react-native-zeroconf": "^0.13.1",
-    "@types/url-parse": "^1.4.11",
-    "jest": "^29.7.0",
-    "ts-jest": "^29.1.2",
-    "ts-node": "^10.9.2",
-    "typescript": "^5.3.3"
-  },
-  "peerDependencies": {
-    "react-native": "*",
-    "react-native-device-info": "^14.0.0",
-    "react-native-zeroconf": "^0.13.8",
-    "@react-native-async-storage/async-storage": "*"
-  },
-  "files": [
-    "package.json",
-    "README.md",
-    "LICENSE",
-    "dist",
-    "src",
-    "index.ts",
-    "tsconfig.json"
-  ],
-  "dependencies": {
-    "crypto-js": "^4.2.0",
-    "url-parse": "^1.5.10"
-  }
-}
+{
+  "name": "@wutiange/log-listener-plugin",
+  "version": "2.0.2-alpha.2",
+  "description": "log-record 客户端对应的的插件\r\nLog-record client corresponding plugin",
+  "source": "index.ts",
+  "react-native": "index.ts",
+  "main": "dist/index.cjs.js",
+  "module": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/wutiange/log-listener-plugin.git"
+  },
+  "author": "wutiange <wutiange20@qq,com>",
+  "license": "MIT",
+  "keywords": [
+    "react-native",
+    "log",
+    "debugger",
+    "charles"
+  ],
+  "scripts": {
+    "publish-alpha": "npm publish --access public --tag alpha",
+    "prepublishOnly": "npm run build",
+    "test": "jest",
+    "build": "yarn clean && yarn test && rollup -c",
+    "dev": "rollup -c -w",
+    "clean": "rimraf dist"
+  },
+  "devDependencies": {
+    "@types/react-native-zeroconf": "^0.13.1",
+    "@types/url-parse": "^1.4.11"
+  },
+  "peerDependencies": {
+    "@react-native-async-storage/async-storage": "*",
+    "react-native": "*",
+    "react-native-device-info": "^14.0.0",
+    "react-native-zeroconf": "^0.13.8"
+  },
+  "files": [
+    "package.json",
+    "README.md",
+    "LICENSE",
+    "dist",
+    "src",
+    "index.ts"
+  ],
+  "dependencies": {
+    "url-parse": "^1.5.10"
+  },
+  "packageManager": "yarn@4.5.3"
+}