@djvlc/openapi-user-client 1.5.0 → 1.7.0

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

@@ -0,0 +1,61 @@
+# 响应组件索引
+
+BadRequest:
+  description: 请求参数错误
+  content:
+    application/json:
+      schema:
+        $ref: '../schemas/_index.yaml#/ErrorResponse'
+      example:
+        code: BAD_REQUEST
+        message: 请求参数无效
+
+NotFound:
+  description: 资源不存在
+  content:
+    application/json:
+      schema:
+        $ref: '../schemas/_index.yaml#/ErrorResponse'
+      example:
+        code: NOT_FOUND
+        message: 资源不存在
+
+UnprocessableEntity:
+  description: 请求无法处理
+  content:
+    application/json:
+      schema:
+        $ref: '../schemas/_index.yaml#/ErrorResponse'
+      example:
+        code: UNPROCESSABLE_ENTITY
+        message: 参数验证失败
+
+InternalError:
+  description: 服务器内部错误
+  content:
+    application/json:
+      schema:
+        $ref: '../schemas/_index.yaml#/ErrorResponse'
+      example:
+        code: INTERNAL_ERROR
+        message: 服务器内部错误
+
+ServiceUnavailable:
+  description: 服务不可用
+  content:
+    application/json:
+      schema:
+        $ref: '../schemas/_index.yaml#/ErrorResponse'
+      example:
+        code: SERVICE_UNAVAILABLE
+        message: 页面暂时不可用
+
+GatewayTimeout:
+  description: 网关超时
+  content:
+    application/json:
+      schema:
+        $ref: '../schemas/_index.yaml#/ErrorResponse'
+      example:
+        code: GATEWAY_TIMEOUT
+        message: 查询超时

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

@@ -0,0 +1,631 @@
+# Schema 组件索引
+
+# ============================================================================
+# 通用
+# ============================================================================
+
+ErrorResponse:
+  type: object
+  required: [code, message]
+  properties:
+    code:
+      type: string
+      description: 错误码
+    message:
+      type: string
+      description: 错误消息
+    details:
+      type: array
+      items:
+        type: object
+        properties:
+          field:
+            type: string
+          message:
+            type: string
+      description: 错误详情
+
+# ============================================================================
+# 页面相关
+# ============================================================================
+
+PageResponse:
+  type: object
+  required: [data]
+  properties:
+    data:
+      type: object
+      required: [pageId, version, meta]
+      properties:
+        pageId:
+          type: string
+          description: 页面 ID
+        version:
+          type: string
+          description: 页面版本
+        meta:
+          type: object
+          properties:
+            title:
+              type: string
+              description: 页面标题
+            description:
+              type: string
+              description: 页面描述
+        integrity:
+          type: string
+          description: 完整性哈希
+
+ResolvePageRequest:
+  type: object
+  properties:
+    context:
+      $ref: '#/ResolveContext'
+    options:
+      type: object
+      properties:
+        prefetchData:
+          type: boolean
+          default: true
+          description: 是否预取数据
+        includeManifests:
+          type: boolean
+          default: true
+          description: 是否包含资源清单
+        locale:
+          type: string
+          description: 语言环境
+
+ResolveContext:
+  type: object
+  description: 页面解析上下文
+  properties:
+    userId:
+      type: string
+      description: 用户 ID
+    sessionId:
+      type: string
+      description: 会话 ID
+    deviceType:
+      type: string
+      enum: [mobile, tablet, desktop]
+      description: 设备类型
+    urlParams:
+      type: object
+      additionalProperties:
+        type: string
+      description: URL 参数
+    routeParams:
+      type: object
+      additionalProperties:
+        type: string
+      description: 路由参数
+    customData:
+      type: object
+      additionalProperties: true
+      description: 自定义上下文数据
+
+ResolvePageResponse:
+  type: object
+  required: [data]
+  properties:
+    data:
+      type: object
+      required: [pageId, version, schema]
+      properties:
+        pageId:
+          type: string
+          description: 页面 ID
+        version:
+          type: string
+          description: 页面版本
+        schema:
+          type: object
+          description: 解析后的页面 Schema
+        manifests:
+          $ref: '#/ResourceManifests'
+        prefetchedData:
+          type: object
+          additionalProperties: true
+          description: 预取的数据
+
+ResourceManifests:
+  type: object
+  properties:
+    components:
+      type: array
+      items:
+        $ref: '#/ComponentManifest'
+      description: 组件资源清单
+    actions:
+      type: array
+      items:
+        $ref: '#/ActionManifest'
+      description: 动作资源清单
+    queries:
+      type: array
+      items:
+        $ref: '#/QueryManifest'
+      description: 查询资源清单
+
+ComponentManifest:
+  type: object
+  required: [componentType, version, entryUrl]
+  properties:
+    componentType:
+      type: string
+      description: 组件类型
+    version:
+      type: string
+      description: 组件版本
+    entryUrl:
+      type: string
+      format: uri
+      description: 组件入口 URL
+    integrity:
+      type: string
+      description: 完整性哈希
+
+ActionManifest:
+  type: object
+  required: [actionId, version]
+  properties:
+    actionId:
+      type: string
+      description: 动作 ID
+    version:
+      type: string
+      description: 动作版本
+    type:
+      type: string
+      enum: [builtin, custom]
+      description: 动作类型
+
+QueryManifest:
+  type: object
+  required: [queryId, version]
+  properties:
+    queryId:
+      type: string
+      description: 查询 ID
+    version:
+      type: string
+      description: 查询版本
+    cacheTtl:
+      type: integer
+      description: 缓存 TTL（秒）
+
+# ============================================================================
+# 动作相关
+# ============================================================================
+
+ExecuteActionRequest:
+  type: object
+  required: [params]
+  properties:
+    params:
+      type: object
+      additionalProperties: true
+      description: 动作参数
+    context:
+      $ref: '#/ActionContext'
+    options:
+      type: object
+      properties:
+        timeout:
+          type: integer
+          minimum: 1000
+          maximum: 30000
+          default: 10000
+          description: 执行超时（毫秒）
+        idempotencyKey:
+          type: string
+          description: 幂等键
+
+ActionContext:
+  type: object
+  description: 动作执行上下文
+  properties:
+    pageId:
+      type: string
+      description: 页面 ID
+    componentId:
+      type: string
+      description: 触发组件 ID
+    eventName:
+      type: string
+      description: 触发事件名
+    state:
+      type: object
+      additionalProperties: true
+      description: 当前页面状态
+
+ExecuteActionResponse:
+  type: object
+  required: [data]
+  properties:
+    data:
+      type: object
+      properties:
+        success:
+          type: boolean
+          description: 是否成功
+        result:
+          description: 执行结果
+        effects:
+          type: array
+          items:
+            $ref: '#/ActionEffect'
+          description: 副作用列表
+
+ActionEffect:
+  type: object
+  required: [type]
+  properties:
+    type:
+      type: string
+      enum: [setState, navigate, showToast, refreshData, custom]
+      description: 副作用类型
+    payload:
+      type: object
+      additionalProperties: true
+      description: 副作用参数
+
+ValidateActionRequest:
+  type: object
+  required: [params]
+  properties:
+    params:
+      type: object
+      additionalProperties: true
+      description: 待验证的参数
+
+ValidateActionResponse:
+  type: object
+  required: [data]
+  properties:
+    data:
+      type: object
+      required: [valid]
+      properties:
+        valid:
+          type: boolean
+          description: 是否有效
+        errors:
+          type: array
+          items:
+            type: object
+            properties:
+              path:
+                type: string
+                description: 参数路径
+              message:
+                type: string
+                description: 错误消息
+          description: 验证错误
+
+# ============================================================================
+# 查询相关
+# ============================================================================
+
+ExecuteQueryRequest:
+  type: object
+  properties:
+    params:
+      type: object
+      additionalProperties: true
+      description: 查询参数
+    context:
+      $ref: '#/ResolveContext'
+    options:
+      type: object
+      properties:
+        timeout:
+          type: integer
+          minimum: 1000
+          maximum: 60000
+          default: 30000
+          description: 查询超时（毫秒）
+        cache:
+          type: boolean
+          default: true
+          description: 是否使用缓存
+        cacheKey:
+          type: string
+          description: 自定义缓存键
+
+ExecuteQueryResponse:
+  type: object
+  required: [data]
+  properties:
+    data:
+      description: 查询结果数据
+    meta:
+      type: object
+      properties:
+        cached:
+          type: boolean
+          description: 是否来自缓存
+        cachedAt:
+          type: string
+          format: date-time
+          description: 缓存时间
+        executionTime:
+          type: integer
+          description: 执行时间（毫秒）
+        pagination:
+          type: object
+          properties:
+            page:
+              type: integer
+            limit:
+              type: integer
+            total:
+              type: integer
+            hasMore:
+              type: boolean
+
+# ============================================================================
+# 通用分页
+# ============================================================================
+
+PaginationMeta:
+  type: object
+  required: [page, limit, total, totalPages]
+  properties:
+    page:
+      type: integer
+      minimum: 1
+      description: 当前页码
+    limit:
+      type: integer
+      minimum: 1
+      maximum: 100
+      description: 每页数量
+    total:
+      type: integer
+      minimum: 0
+      description: 总记录数
+    totalPages:
+      type: integer
+      minimum: 0
+      description: 总页数
+
+# ============================================================================
+# Activity 用户活动相关
+# ============================================================================
+
+PublicActivityInfo:
+  type: object
+  required: [id, name, type, status]
+  properties:
+    id:
+      type: string
+      description: 活动 ID
+    name:
+      type: string
+      description: 活动名称
+    type:
+      type: string
+      enum: [signin, lottery, redpack, coupon, custom]
+      description: 活动类型
+    status:
+      type: string
+      enum: [active, ended]
+      description: 活动状态
+    description:
+      type: string
+      description: 活动描述
+    startTime:
+      type: string
+      format: date-time
+      description: 开始时间
+    endTime:
+      type: string
+      format: date-time
+      description: 结束时间
+    rules:
+      type: object
+      additionalProperties: true
+      description: 活动规则（公开部分）
+    rewards:
+      type: array
+      items:
+        type: object
+        properties:
+          name:
+            type: string
+          description:
+            type: string
+          icon:
+            type: string
+      description: 奖励列表
+
+UserActivityState:
+  type: object
+  required: [activityId, userId]
+  properties:
+    activityId:
+      type: string
+      description: 活动 ID
+    userId:
+      type: string
+      description: 用户 ID
+    participated:
+      type: boolean
+      description: 是否已参与
+    participatedAt:
+      type: string
+      format: date-time
+      description: 参与时间
+    remainingChances:
+      type: integer
+      description: 剩余抽奖次数
+    totalRewards:
+      type: integer
+      description: 已获得奖励数
+    progress:
+      type: object
+      additionalProperties: true
+      description: 活动进度
+    customData:
+      type: object
+      additionalProperties: true
+      description: 自定义数据
+
+SigninCalendar:
+  type: object
+  required: [year, month, records]
+  properties:
+    year:
+      type: integer
+      description: 年份
+    month:
+      type: integer
+      minimum: 1
+      maximum: 12
+      description: 月份
+    records:
+      type: array
+      items:
+        type: object
+        properties:
+          day:
+            type: integer
+            minimum: 1
+            maximum: 31
+          signedIn:
+            type: boolean
+          reward:
+            type: object
+            properties:
+              name:
+                type: string
+              amount:
+                type: number
+      description: 签到记录
+    consecutiveDays:
+      type: integer
+      description: 连续签到天数
+    totalDays:
+      type: integer
+      description: 本月签到总天数
+
+ClaimRecordInfo:
+  type: object
+  required: [id, rewardType, status, createdAt]
+  properties:
+    id:
+      type: string
+      description: 记录 ID
+    activityId:
+      type: string
+      description: 活动 ID
+    rewardType:
+      type: string
+      description: 奖励类型
+    rewardName:
+      type: string
+      description: 奖励名称
+    rewardValue:
+      type: number
+      description: 奖励值
+    status:
+      type: string
+      enum: [pending, claimed, expired]
+      description: 领取状态
+    createdAt:
+      type: string
+      format: date-time
+      description: 创建时间
+    claimedAt:
+      type: string
+      format: date-time
+      description: 领取时间
+    expiresAt:
+      type: string
+      format: date-time
+      description: 过期时间
+
+LotteryRecordInfo:
+  type: object
+  required: [id, prizeId, status, createdAt]
+  properties:
+    id:
+      type: string
+      description: 记录 ID
+    activityId:
+      type: string
+      description: 活动 ID
+    prizeId:
+      type: string
+      description: 奖品 ID
+    prizeName:
+      type: string
+      description: 奖品名称
+    prizeType:
+      type: string
+      enum: [physical, virtual, coupon, points, none]
+      description: 奖品类型
+    status:
+      type: string
+      enum: [won, notWon, claimed, shipped]
+      description: 状态
+    createdAt:
+      type: string
+      format: date-time
+      description: 抽奖时间
+    claimedAt:
+      type: string
+      format: date-time
+      description: 领取时间
+
+# ============================================================================
+# Track 埋点相关
+# ============================================================================
+
+TrackRequest:
+  type: object
+  required: [eventName]
+  properties:
+    eventName:
+      type: string
+      minLength: 1
+      maxLength: 255
+      description: 事件名称
+    eventType:
+      type: string
+      enum: [page_view, click, exposure, custom]
+      default: custom
+      description: 事件类型
+    properties:
+      type: object
+      additionalProperties: true
+      description: 事件属性
+    timestamp:
+      type: string
+      format: date-time
+      description: 事件时间（默认为服务器接收时间）
+    context:
+      type: object
+      properties:
+        pageId:
+          type: string
+        componentId:
+          type: string
+        sessionId:
+          type: string
+        deviceType:
+          type: string
+      description: 上下文信息
+
+TrackBatchRequest:
+  type: object
+  required: [events]
+  properties:
+    events:
+      type: array
+      items:
+        $ref: '#/TrackRequest'
+      maxItems: 100
+      description: 事件列表（最多 100 个）