@djvlc/openapi-user-client 1.7.1 → 1.7.3

package/openapi/src/components/responses/_index.yaml

@@ -10,6 +10,26 @@ BadRequest:
         code: BAD_REQUEST
         message: 请求参数无效
 
+Unauthorized:
+  description: 未认证
+  content:
+    application/json:
+      schema:
+        $ref: '../schemas/_index.yaml#/ErrorResponse'
+      example:
+        code: UNAUTHORIZED
+        message: 请先登录
+
+Forbidden:
+  description: 无权限
+  content:
+    application/json:
+      schema:
+        $ref: '../schemas/_index.yaml#/ErrorResponse'
+      example:
+        code: FORBIDDEN
+        message: 无访问权限
+
 NotFound:
   description: 资源不存在
   content:
@@ -30,6 +50,16 @@ UnprocessableEntity:
         code: UNPROCESSABLE_ENTITY
         message: 参数验证失败
 
+TooManyRequests:
+  description: 请求过于频繁
+  content:
+    application/json:
+      schema:
+        $ref: '../schemas/_index.yaml#/ErrorResponse'
+      example:
+        code: TOO_MANY_REQUESTS
+        message: 请求过于频繁，请稍后再试
+
 InternalError:
   description: 服务器内部错误
   content:

package/openapi/src/components/schemas/_index.yaml

@@ -24,6 +24,9 @@ ErrorResponse:
           message:
             type: string
       description: 错误详情
+    traceId:
+      type: string
+      description: 追踪 ID
 
 # ============================================================================
 # 页面相关
@@ -86,10 +89,16 @@ ResolveContext:
     sessionId:
       type: string
       description: 会话 ID
+    deviceId:
+      type: string
+      description: 设备 ID
     deviceType:
       type: string
       enum: [mobile, tablet, desktop]
       description: 设备类型
+    channel:
+      type: string
+      description: 渠道标识
     urlParams:
       type: object
       additionalProperties:
@@ -111,14 +120,17 @@ ResolvePageResponse:
   properties:
     data:
       type: object
-      required: [pageId, version, schema]
+      required: [pageId, pageVersionId, schema]
       properties:
         pageId:
           type: string
           description: 页面 ID
-        version:
+        pageVersionId:
           type: string
-          description: 页面版本
+          description: 页面版本 ID（不可变）
+        schemaVersion:
+          type: string
+          description: Schema 版本
         schema:
           type: object
           description: 解析后的页面 Schema
@@ -128,6 +140,8 @@ ResolvePageResponse:
           type: object
           additionalProperties: true
           description: 预取的数据
+        opsConfig:
+          $ref: '#/OpsConfig'
 
 ResourceManifests:
   type: object
@@ -162,53 +176,95 @@ ComponentManifest:
       type: string
       format: uri
       description: 组件入口 URL
+    styleUrl:
+      type: string
+      format: uri
+      description: 样式文件 URL
     integrity:
       type: string
-      description: 完整性哈希
+      description: SRI 完整性哈希
+    blocked:
+      type: boolean
+      description: 是否被阻断
+    fallback:
+      type: string
+      description: 降级组件类型
 
 ActionManifest:
   type: object
-  required: [actionId, version]
+  required: [actionId, actionDefinitionVersionId]
   properties:
     actionId:
       type: string
       description: 动作 ID
-    version:
+    actionDefinitionVersionId:
       type: string
-      description: 动作版本
-    type:
+      description: 动作定义版本 ID
+    actionType:
       type: string
-      enum: [builtin, custom]
+      enum: [claim, signin, lottery, reserve, bind, task_complete, vote, share, form_submit, navigate, setState, showToast, refreshData, custom]
       description: 动作类型
+    builtin:
+      type: boolean
+      description: 是否内置动作
 
 QueryManifest:
   type: object
-  required: [queryId, version]
+  required: [queryId, queryVersionId]
   properties:
     queryId:
       type: string
       description: 查询 ID
-    version:
+    queryVersionId:
       type: string
-      description: 查询版本
+      description: 查询定义版本 ID
     cacheTtl:
       type: integer
       description: 缓存 TTL（秒）
 
+OpsConfig:
+  type: object
+  description: 运维配置
+  properties:
+    killSwitch:
+      type: boolean
+      description: Kill Switch 是否启用
+    fallbackUrl:
+      type: string
+      format: uri
+      description: 降级跳转 URL
+    blockedComponents:
+      type: array
+      items:
+        type: string
+      description: 被阻断的组件列表
+
 # ============================================================================
-# 动作相关
+# Action Gateway 动作相关
 # ============================================================================
 
 ExecuteActionRequest:
   type: object
-  required: [params]
+  required: [actionType, params]
   properties:
+    actionType:
+      type: string
+      enum: [claim, signin, lottery, reserve, bind, task_complete, vote, share, form_submit, navigate, setState, showToast, refreshData, custom]
+      description: 动作类型
+    actionDefinitionVersionId:
+      type: string
+      description: 动作定义版本 ID（custom 类型必填）
     params:
       type: object
       additionalProperties: true
       description: 动作参数
     context:
       $ref: '#/ActionContext'
+    idempotencyKey:
+      type: string
+      minLength: 16
+      maxLength: 128
+      description: 幂等键（防重复提交）
     options:
       type: object
       properties:
@@ -218,23 +274,47 @@ ExecuteActionRequest:
           maximum: 30000
           default: 10000
           description: 执行超时（毫秒）
-        idempotencyKey:
-          type: string
-          description: 幂等键
+        skipRisk:
+          type: boolean
+          default: false
+          description: 是否跳过风控（需特殊权限）
 
 ActionContext:
   type: object
-  description: 动作执行上下文
+  description: 动作执行上下文（问题追溯必须字段）
+  required: [pageVersionId]
   properties:
-    pageId:
+    pageVersionId:
+      type: string
+      description: 页面版本 ID（不可变）
+    componentVersionId:
+      type: string
+      description: 触发组件版本 ID
+    actionId:
       type: string
-      description: 页面 ID
-    componentId:
+      description: 动作实例 ID
+    traceId:
+      type: string
+      description: 分布式追踪 ID（OTel）
+    uid:
+      type: string
+      description: 用户 ID
+    deviceId:
+      type: string
+      description: 设备 ID
+    channel:
+      type: string
+      description: 渠道标识
+    sessionId:
       type: string
-      description: 触发组件 ID
+      description: 会话 ID
     eventName:
       type: string
       description: 触发事件名
+    timestamp:
+      type: string
+      format: date-time
+      description: 触发时间
     state:
       type: object
       additionalProperties: true
@@ -242,14 +322,17 @@ ActionContext:
 
 ExecuteActionResponse:
   type: object
-  required: [data]
+  required: [success, data]
   properties:
+    success:
+      type: boolean
+      description: 是否成功
     data:
       type: object
       properties:
-        success:
-          type: boolean
-          description: 是否成功
+        actionId:
+          type: string
+          description: 动作执行 ID
         result:
           description: 执行结果
         effects:
@@ -257,6 +340,18 @@ ExecuteActionResponse:
           items:
             $ref: '#/ActionEffect'
           description: 副作用列表
+    meta:
+      type: object
+      properties:
+        executionTime:
+          type: integer
+          description: 执行时间（毫秒）
+        traceId:
+          type: string
+          description: 追踪 ID
+        idempotent:
+          type: boolean
+          description: 是否幂等命中
 
 ActionEffect:
   type: object
@@ -264,17 +359,46 @@ ActionEffect:
   properties:
     type:
       type: string
-      enum: [setState, navigate, showToast, refreshData, custom]
+      enum: [setState, navigate, showToast, refreshData, openDialog, closeDialog, custom]
       description: 副作用类型
     payload:
       type: object
       additionalProperties: true
       description: 副作用参数
 
+IdempotencyConflictResponse:
+  type: object
+  required: [success, data]
+  properties:
+    success:
+      type: boolean
+      example: true
+    data:
+      type: object
+      properties:
+        idempotent:
+          type: boolean
+          example: true
+        originalActionId:
+          type: string
+          description: 原始动作执行 ID
+        originalResult:
+          description: 原始执行结果
+        originalExecutedAt:
+          type: string
+          format: date-time
+          description: 原始执行时间
+
 ValidateActionRequest:
   type: object
-  required: [params]
+  required: [actionType, params]
   properties:
+    actionType:
+      type: string
+      description: 动作类型
+    actionDefinitionVersionId:
+      type: string
+      description: 动作定义版本 ID
     params:
       type: object
       additionalProperties: true
@@ -302,21 +426,48 @@ ValidateActionResponse:
               message:
                 type: string
                 description: 错误消息
+              code:
+                type: string
+                description: 错误码
           description: 验证错误
 
+ActionDefinitionResponse:
+  type: object
+  required: [data]
+  properties:
+    data:
+      type: object
+      properties:
+        actionDefinitionVersionId:
+          type: string
+        actionType:
+          type: string
+        name:
+          type: string
+        paramsSchema:
+          type: object
+          description: 参数 JSON Schema
+        resultSchema:
+          type: object
+          description: 结果 JSON Schema
+
 # ============================================================================
-# 查询相关
+# Data Proxy 查询相关
 # ============================================================================
 
-ExecuteQueryRequest:
+QueryDataRequest:
   type: object
+  required: [queryVersionId]
   properties:
+    queryVersionId:
+      type: string
+      description: 查询定义版本 ID
     params:
       type: object
       additionalProperties: true
       description: 查询参数
     context:
-      $ref: '#/ResolveContext'
+      $ref: '#/QueryContext'
     options:
       type: object
       properties:
@@ -334,10 +485,28 @@ ExecuteQueryRequest:
           type: string
           description: 自定义缓存键
 
-ExecuteQueryResponse:
+QueryContext:
   type: object
-  required: [data]
   properties:
+    pageVersionId:
+      type: string
+      description: 页面版本 ID
+    uid:
+      type: string
+      description: 用户 ID
+    sessionId:
+      type: string
+      description: 会话 ID
+    traceId:
+      type: string
+      description: 分布式追踪 ID
+
+QueryDataResponse:
+  type: object
+  required: [success, data]
+  properties:
+    success:
+      type: boolean
     data:
       description: 查询结果数据
     meta:
@@ -353,6 +522,9 @@ ExecuteQueryResponse:
         executionTime:
           type: integer
           description: 执行时间（毫秒）
+        traceId:
+          type: string
+          description: 追踪 ID
         pagination:
           type: object
           properties:
@@ -365,6 +537,73 @@ ExecuteQueryResponse:
             hasMore:
               type: boolean
 
+QueryDefinitionResponse:
+  type: object
+  required: [data]
+  properties:
+    data:
+      type: object
+      properties:
+        queryVersionId:
+          type: string
+        name:
+          type: string
+        paramsSchema:
+          type: object
+          description: 参数 JSON Schema
+        resultSchema:
+          type: object
+          description: 结果 JSON Schema
+        cacheTtl:
+          type: integer
+          description: 缓存 TTL（秒）
+
+BatchQueryRequest:
+  type: object
+  required: [queries]
+  properties:
+    queries:
+      type: array
+      items:
+        type: object
+        required: [queryVersionId]
+        properties:
+          queryVersionId:
+            type: string
+          params:
+            type: object
+          alias:
+            type: string
+            description: 查询别名（用于结果映射）
+      maxItems: 20
+      description: 查询列表（最多 20 个）
+    context:
+      $ref: '#/QueryContext'
+
+BatchQueryResponse:
+  type: object
+  required: [success, data]
+  properties:
+    success:
+      type: boolean
+    data:
+      type: object
+      additionalProperties:
+        type: object
+        properties:
+          success:
+            type: boolean
+          data:
+            description: 查询结果
+          error:
+            type: object
+            properties:
+              code:
+                type: string
+              message:
+                type: string
+      description: 按 alias 或 queryVersionId 索引的结果
+
 # ============================================================================
 # 通用分页
 # ============================================================================
@@ -391,6 +630,119 @@ PaginationMeta:
       minimum: 0
       description: 总页数
 
+# ============================================================================
+# Tenant 租户相关
+# ============================================================================
+
+TenantInfo:
+  type: object
+  required: [appId, appName, status]
+  properties:
+    appId:
+      type: string
+      description: 应用 ID
+    appName:
+      type: string
+      description: 应用名称
+    status:
+      type: string
+      enum: [active, suspended, disabled]
+      description: 应用状态
+    workspaceId:
+      type: string
+      description: 工作空间 ID
+    cdnDomain:
+      type: string
+      format: uri
+      description: CDN 域名
+    apiDomain:
+      type: string
+      format: uri
+      description: API 域名
+
+TenantConfig:
+  type: object
+  properties:
+    features:
+      type: object
+      additionalProperties:
+        type: boolean
+      description: 功能开关
+    theme:
+      type: object
+      additionalProperties: true
+      description: 主题配置
+    cdnDomain:
+      type: string
+      format: uri
+      description: CDN 域名
+    runtimeVersion:
+      type: string
+      description: 推荐的 Runtime 版本
+    blockedComponents:
+      type: array
+      items:
+        type: object
+        properties:
+          componentType:
+            type: string
+          version:
+            type: string
+          reason:
+            type: string
+      description: 阻断的组件列表
+    killSwitch:
+      type: object
+      properties:
+        enabled:
+          type: boolean
+        pageIds:
+          type: array
+          items:
+            type: string
+          description: 被 Kill 的页面 ID 列表
+        fallbackUrl:
+          type: string
+          format: uri
+      description: Kill Switch 配置
+
+# ============================================================================
+# Health 健康检查相关
+# ============================================================================
+
+HealthResponse:
+  type: object
+  required: [status, version]
+  properties:
+    status:
+      type: string
+      enum: [healthy, degraded, unhealthy]
+      description: 服务状态
+    version:
+      type: string
+      description: 服务版本
+    uptime:
+      type: integer
+      description: 运行时间（秒）
+    timestamp:
+      type: string
+      format: date-time
+      description: 检查时间
+    dependencies:
+      type: object
+      additionalProperties:
+        type: object
+        properties:
+          status:
+            type: string
+            enum: [healthy, degraded, unhealthy]
+          latency:
+            type: integer
+            description: 延迟（毫秒）
+          message:
+            type: string
+      description: 依赖服务状态
+
 # ============================================================================
 # Activity 用户活动相关
 # ============================================================================
@@ -407,7 +759,7 @@ PublicActivityInfo:
       description: 活动名称
     type:
       type: string
-      enum: [signin, lottery, redpack, coupon, custom]
+      enum: [claim, signin, lottery, reserve, task, vote, share, bind, custom]
       description: 活动类型
     status:
       type: string
@@ -609,14 +961,16 @@ TrackRequest:
     context:
       type: object
       properties:
-        pageId:
+        pageVersionId:
           type: string
-        componentId:
+        componentVersionId:
           type: string
         sessionId:
           type: string
         deviceType:
           type: string
+        traceId:
+          type: string
       description: 上下文信息
 
 TrackBatchRequest:
@@ -628,4 +982,4 @@ TrackBatchRequest:
       items:
         $ref: '#/TrackRequest'
       maxItems: 100
-      description: 事件列表（最多 100 个）
+      description: 事件列表（最多 100 个）