@iflyrpa/playwright 1.0.15 → 1.1.1

package/README.md

@@ -2,4 +2,80 @@
 
 iflyrpa 封装的一组特定场景的自动化脚本，支持的场景如下：
 
-1. 小红书自动发布
+| 平台                         | 脚本                   | 说明                                               | 支持的方式     |
+| ---------------------------- | ---------------------- | -------------------------------------------------- | -------------- |
+| 头条                         | toutiaoPublish         | 发布/保存草稿                                      | Mock Api       |
+| 头条                         | getToutiaoConfig       | 获取头条发布配置的话题信息、位置信息和原创首发信息 | Mock Api       |
+| 头条                         | searchToutiaoTopicList | 搜索头条话题                                       | Mock Api       |
+| 微头条                       | weitoutiaoPublish      | 发布                                               | Mock Api / RPA |
+| 百家号                       | getBaijiahaoActivity   | 查询百家号活动投稿                                 | Mock Api       |
+| 百家号                       | baijiahaoPublish       | 发布/保存草稿                                      | Mock Api       |
+| 小绿书（微信公众号图文模式） | weixinmpPublish        | 发布                                               | Mock Api / RPA |
+| 小红书                       | xiaohongshuPublish     | 发布                                               | Mock Api / RPA |
+
+## 安装
+
+```bash
+# npm
+npm i @iflyrpa/playwright
+
+# yarn
+yarn add @iflyrpa/playwright
+
+# pnpm
+pnpm install @iflyrpa/playwright
+```
+
+## 使用方法
+
+```typescript
+import { RpaTask } from "@iflyrpa/playwright";
+
+//  1. 创建缓存目录
+const cachePath = join(__dirname, "../main/cache");
+
+// 2. 初始化
+const automateTask = new RpaTask({
+  cachePath, // 缓存目录
+  debug: true, // debug 模式下可视化展示所有操作
+  forceUpdate: false, // 是否使用远程最新版本
+});
+
+// 3. 执行脚本，支持的脚本如上
+automateTask.actions.xiaohongshuPublish(xiaohonshuPublishParams)
+
+// 4. 应用关闭前，清除副作用
+app.on("before-quit", (event) => {
+ if (!automateTask.isClosed) {
+  // 阻止应用立即退出
+  event.preventDefault();
+
+  automateTask.close().finally(() => {
+   console.log("close app");
+   app.quit();
+  });
+ }
+});
+```
+
+## 注意事项
+
+**1. 缓存目录包含以下文件：**
+
+- packages：运行时依赖和脚本缓存目录
+- tmp：运行时缓存目录
+- rpa.log：运行日志文件
+
+**2. 如何获取脚本入参类型：**
+
+```typescript
+import type { ActionMethodParams } from "@iflyrpa/playwright";
+
+export const xiaohonshuPublishParams: ActionMethodParams['xiaohongshuPublish'] = {}
+
+automateTask.actions.xiaohongshuPublish(xiaohonshuPublishParams)
+```
+
+**3. 云端日志**
+
+<https://sentry-new.iflyrpa.com/rpa/turbodesk-rpa>