@faapi/faapi 1.0.2 → 1.1.0-canary.e781003

package/dist/index.d.ts

@@ -119,6 +119,13 @@ interface FaapiContext {
      * 无法获取时为空字符串。
      */
     ip: string;
+    /**
+     * 客户端 User-Agent（请求头 `user-agent` 原值）
+     *
+     * 在 createContext 内部从 request.headers 读取（与 ip 不同，无需调用方传入）。
+     * 不做解析/规整，仅原样透传；无该请求头时为空字符串。
+     */
+    ua: string;
     /** 解析后的所有 cookie 键值对 */
     cookies: Record<string, string>;
     /** 配置文件中的自定义业务配置（类型可通过 declare module '@faapi/faapi' 增强 FaapiContextConfig） */
@@ -1105,6 +1112,9 @@ type ValidationErrorCode = 'TYPE_MISMATCH' | 'MISSING_FIELD' | 'INVALID_FORMAT'
  * @param params 动态路由参数
  * @param config 自定义业务配置（来自 faapi.config.ts）
  * @param ip 客户端 IP（由调用方从 IncomingMessage 提取，HTTP/WS 握手均通过 utils/getClientIp）
+ *
+ * ua 不作为参数传入：User-Agent 是标准 HTTP 请求头，createContext 内部直接从
+ * request.headers 读取（与 ip 不同，ip 需要从 IncomingMessage 提取故由调用方传入）。
  */
 declare function createContext(request: Request, params: Record<string, string>, config?: Record<string, unknown>, ip?: string): FaapiContext;
 

package/dist/index.js

@@ -683,6 +683,7 @@ var PARAM_TYPE_MAP = {
   // 别名
   cookies: "cookies",
   ip: "ip",
+  ua: "ua",
   files: "files",
   fields: "fields"
 };
@@ -1330,6 +1331,7 @@ function createContext(request, params, config = {}, ip = "") {
     method: request.method,
     path: url.pathname,
     ip,
+    ua: request.headers.get("user-agent") ?? "",
     cookies: cookiesObj,
     config,
     meta,
@@ -1519,6 +1521,8 @@ function getBuiltinInjectionValue(type, ctx, body) {
       return ctx.cookies;
     case "ip":
       return ctx.ip;
+    case "ua":
+      return ctx.ua;
     case "body":
       return body;
     // form 与 body 共享解析结果（resolveInput 已按 Content-Type 解析 form-urlencoded）