@bettergi/utils 0.0.6 → 0.0.8

package/README.md

@@ -10,6 +10,8 @@ npm install @bettergi/utils
 
 ### 游戏内操作
 
+> 常见游戏内操作封装，省去手动实现的繁琐。
+
 ```ts
 import { openMenu, openMenuPage, openPaimonMenu, setTime } from "@bettergi/utils";
 
@@ -134,3 +136,18 @@ try {
   state.lastUsedTime = Date.now(); // 自动同步保存到文件
 }
 ```
+
+### 网络请求
+
+> 对网络请求的简易封装。
+
+```ts
+import { getForBody, postForBody } from "@bettergi/utils";
+
+// 发送 GET 请求获取响应体内容
+// 提示：需要在 `manifest.json` 文件中配置 `http_allowed_urls`，并在 调度器 -> 修改通用配置 中启用
+const body1 = await getForBody("https://example.com/", null, { "User-Agent": "BetterGI" });
+const body2 = await postForBody("https://example.com/", null, { "User-Agent": "BetterGI" });
+log.info(`GET 请求响应体内容${body1}`);
+log.info(`POST 请求响应体内容${body2}`);
+```

package/dist/game.d.ts

@@ -1,3 +1,4 @@
+import "@bettergi/types/csharp/BetterGenshinImpact/GameTask/Model/Area/Region";
 /**
  * 打开派蒙菜单
  */

package/dist/game.js

@@ -1,3 +1,4 @@
+import "@bettergi/types/csharp/BetterGenshinImpact/GameTask/Model/Area/Region";
 import { waitUntil } from "./flow";
 import { mouseSlide } from "./mouse";
 import { findTextInDirection, findTextWithinBounds, findTextWithinListView } from "./ocr";

package/dist/http.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 发送 HTTP 请求，获取响应体内容
+ * @param method 请求方法
+ * @param url 请求 URL
+ * @param body 请求体
+ * @param headers 请求头
+ * @returns 响应体内容
+ */
+export declare const requestForBody: (method: Parameters<typeof http.request>[0], url: string, body?: string, headers?: Record<string, any>) => Promise<string>;
+/**
+ * 发送 HTTP GET 请求，获取响应体内容
+ * @param url 请求 URL
+ * @param body 请求体
+ * @param headers 请求头
+ * @returns 响应体内容
+ */
+export declare const getForBody: (url: string, body?: string, headers?: Record<string, any>) => Promise<string>;
+/**
+ * 发送 HTTP POST 请求，获取响应体内容
+ * @param url 请求 URL
+ * @param body 请求体
+ * @param headers 请求头
+ * @returns 响应体内容
+ */
+export declare const postForBody: (url: string, body?: string, headers?: Record<string, any>) => Promise<string>;

package/dist/http.js

@@ -0,0 +1,37 @@
+/**
+ * 发送 HTTP 请求，获取响应体内容
+ * @param method 请求方法
+ * @param url 请求 URL
+ * @param body 请求体
+ * @param headers 请求头
+ * @returns 响应体内容
+ */
+export const requestForBody = async (method, url, body, headers) => {
+    const resp = await http.request(method, url, body ?? "null", headers ? JSON.stringify(headers) : "null");
+    if (resp.status_code >= 200 && resp.status_code < 400) {
+        return resp.body;
+    }
+    else {
+        throw new Error(`HTTP request failed with status ${resp.status_code}`);
+    }
+};
+/**
+ * 发送 HTTP GET 请求，获取响应体内容
+ * @param url 请求 URL
+ * @param body 请求体
+ * @param headers 请求头
+ * @returns 响应体内容
+ */
+export const getForBody = async (url, body, headers) => {
+    return requestForBody("GET", url, body, headers);
+};
+/**
+ * 发送 HTTP POST 请求，获取响应体内容
+ * @param url 请求 URL
+ * @param body 请求体
+ * @param headers 请求头
+ * @returns 响应体内容
+ */
+export const postForBody = (url, body, headers) => {
+    return requestForBody("POST", url, body, headers);
+};

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./flow";
 export * from "./game";
+export * from "./http";
 export * from "./mouse";
 export * from "./ocr";
 export * from "./store";

package/dist/index.js

@@ -1,5 +1,6 @@
 export * from "./flow";
 export * from "./game";
+export * from "./http";
 export * from "./mouse";
 export * from "./ocr";
 export * from "./store";

package/dist/ocr.d.ts

@@ -1,11 +1,12 @@
-import { type Region } from "@bettergi/types/csharp/BetterGenshinImpact/GameTask/Model/Area/Region";
+import "@bettergi/types/csharp/BetterGenshinImpact/GameTask/Model/Area/ImageRegion";
+import "@bettergi/types/csharp/BetterGenshinImpact/GameTask/Model/Area/Region";
 type Direction = "north" | "north-east" | "east" | "south-east" | "south" | "south-west" | "west" | "north-west";
 /**
  * 在整个画面内搜索图片
  * @param path 图片路径
  * @returns 如果找到匹配的图片区域，则返回该区域，否则返回 undefined
  */
-export declare const findImage: (path: string) => Region | undefined;
+export declare const findImage: (path: string) => globalThis.Region | undefined;
 /**
  * 在指定区域内搜索图片
  * @param path 图片路径
@@ -15,14 +16,14 @@ export declare const findImage: (path: string) => Region | undefined;
  * @param h 高度
  * @returns 如果找到匹配的图片区域，则返回该区域，否则返回 undefined
  */
-export declare const findImageWithinBounds: (path: string, x: number, y: number, w: number, h: number) => Region | undefined;
+export declare const findImageWithinBounds: (path: string, x: number, y: number, w: number, h: number) => globalThis.Region | undefined;
 /**
  * 在指定方向上搜索图片
  * @param path 图片路径
  * @param direction 搜索方向
  * @returns 如果找到匹配的图片区域，则返回该区域，否则返回 undefined
  */
-export declare const findImageInDirection: (path: string, direction: Direction) => Region | undefined;
+export declare const findImageInDirection: (path: string, direction: Direction) => globalThis.Region | undefined;
 /**
  * 在整个画面内搜索文本
  * @param text 待搜索文本
@@ -30,7 +31,7 @@ export declare const findImageInDirection: (path: string, direction: Direction)
  * @param ignoreCase 是否忽略大小写
  * @returns 如果找到匹配的文本区域，则返回该区域，否则返回 undefined
  */
-export declare const findText: (text: string, contains: boolean, ignoreCase: boolean) => Region | undefined;
+export declare const findText: (text: string, contains: boolean, ignoreCase: boolean) => globalThis.Region | undefined;
 /**
  * 在指定区域内搜索文本
  * @param text 待搜索文本
@@ -43,7 +44,7 @@ export declare const findText: (text: string, contains: boolean, ignoreCase: boo
  * @param h 高度
  * @returns 如果找到匹配的文本区域，则返回该区域，否则返回 undefined
  */
-export declare const findTextWithinBounds: (text: string, contains: boolean, ignoreCase: boolean, x: number, y: number, w: number, h: number) => Region | undefined;
+export declare const findTextWithinBounds: (text: string, contains: boolean, ignoreCase: boolean, x: number, y: number, w: number, h: number) => globalThis.Region | undefined;
 /**
  * 在指定方向上搜索文本
  * @param text 待搜索文本
@@ -52,7 +53,7 @@ export declare const findTextWithinBounds: (text: string, contains: boolean, ign
  * @param direction 搜索方向
  * @returns 如果找到匹配的文本区域，则返回该区域，否则返回 undefined
  */
-export declare const findTextInDirection: (text: string, contains: boolean, ignoreCase: boolean, direction: Direction) => Region | undefined;
+export declare const findTextInDirection: (text: string, contains: boolean, ignoreCase: boolean, direction: Direction) => globalThis.Region | undefined;
 /**
  * 在列表视图中滚动搜索文本
  * @param text 待搜索文本
@@ -70,5 +71,5 @@ export declare const findTextWithinListView: (text: string, contains: boolean, i
     maxListItems: number;
     lineHeight: number;
     padding?: number;
-}, timeout?: number) => Promise<Region | undefined>;
+}, timeout?: number) => Promise<globalThis.Region | undefined>;
 export {};

package/dist/ocr.js

@@ -1,3 +1,5 @@
+import "@bettergi/types/csharp/BetterGenshinImpact/GameTask/Model/Area/ImageRegion";
+import "@bettergi/types/csharp/BetterGenshinImpact/GameTask/Model/Area/Region";
 import { waitUntil } from "./flow";
 import { mouseScrollDownLines } from "./mouse";
 const findFirst = (ir, ro, predicate) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bettergi/utils",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "Utils for BetterGI JavaScript Development",
   "type": "module",
   "author": "Bread Grocery<https://github.com/breadgrocery>",
@@ -33,7 +33,7 @@
     "build": "tsc"
   },
   "devDependencies": {
-    "@bettergi/types": "^0.0.10",
+    "@bettergi/types": "^0.0.12",
     "typescript": "5.6.3"
   }
 }