@djvlc/openapi-user-client 1.7.15 → 1.8.0

package/openapi/dist/user-api.yaml

@@ -130,6 +130,102 @@ paths:
           $ref: '#/components/responses/NotFound'
         '503':
           $ref: '#/components/responses/ServiceUnavailable'
+  /page/manifest:
+    get:
+      tags:
+        - Pages
+      operationId: getPageManifest
+      summary: 获取组件清单
+      description: |
+        返回页面的组件锁定清单（manifest），包含所有引用的组件版本和资源信息。
+
+        用途：
+        - Runtime 根据 manifest 预加载组件资源
+        - Editor 根据 manifest 展示组件依赖
+      parameters:
+        - name: X-Trace-Id
+          in: header
+          required: false
+          schema:
+            type: string
+          description: 链路追踪 ID（OTel，全链路透传）
+        - name: pageId
+          in: query
+          required: true
+          schema:
+            type: string
+          description: 页面 ID
+        - name: env
+          in: query
+          required: false
+          schema:
+            type: string
+            enum:
+              - prod
+              - preview
+              - staging
+            default: prod
+          description: 环境（prod/preview/staging）
+      responses:
+        '200':
+          description: 获取成功
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                  data:
+                    $ref: '#/components/schemas/ResourceManifests'
+        '400':
+          $ref: '#/components/responses/BadRequest'
+        '404':
+          $ref: '#/components/responses/NotFound'
+  /page/config:
+    get:
+      tags:
+        - Pages
+      operationId: getPageConfig
+      summary: 获取运维配置
+      description: |
+        返回当前运维配置（killSwitch、blockedComponents、featureFlags 等）。
+
+        用途：
+        - Runtime 启动时获取全局运维配置
+        - 判断是否有组件被阻断或功能被关闭
+      parameters:
+        - name: X-Trace-Id
+          in: header
+          required: false
+          schema:
+            type: string
+          description: 链路追踪 ID（OTel，全链路透传）
+        - name: env
+          in: query
+          required: false
+          schema:
+            type: string
+            enum:
+              - prod
+              - preview
+              - staging
+            default: prod
+          description: 环境（prod/preview/staging）
+      responses:
+        '200':
+          description: 获取成功
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                  data:
+                    $ref: '#/components/schemas/OpsConfig'
+        '503':
+          $ref: '#/components/responses/ServiceUnavailable'
   /actions/execute:
     post:
       tags:
@@ -539,6 +635,104 @@ paths:
                     $ref: '#/components/schemas/PaginationMeta'
       security:
         - BearerAuth: []
+  /activities/{activityId}/status:
+    get:
+      tags:
+        - Activities
+      summary: 获取活动状态（兼容）
+      operationId: getActivityStatus
+      description: |
+        获取活动的当前状态信息，包括是否进行中、时间范围等。
+        不需要登录，可用于前端判断活动是否在有效期内。
+      parameters:
+        - name: activityId
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: 成功
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                  data:
+                    $ref: '#/components/schemas/ActivityStatus'
+        '404':
+          $ref: '#/components/responses/NotFound'
+      security: []
+  /activities/{activityId}/claim/status:
+    get:
+      tags:
+        - Activities
+      summary: 获取领取状态
+      operationId: getClaimStatus
+      description: 获取用户在指定活动中的领取状态
+      parameters:
+        - name: activityId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: uid
+          in: query
+          required: true
+          schema:
+            type: string
+          description: 用户 UID
+      responses:
+        '200':
+          description: 成功
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                  data:
+                    type: object
+                    description: 领取状态数据
+      security:
+        - BearerAuth: []
+  /activities/{activityId}/signin/status:
+    get:
+      tags:
+        - Activities
+      summary: 获取签到状态
+      operationId: getSigninStatus
+      description: 获取用户在指定活动中的签到状态
+      parameters:
+        - name: activityId
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: uid
+          in: query
+          required: true
+          schema:
+            type: string
+          description: 用户 UID
+      responses:
+        '200':
+          description: 成功
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  success:
+                    type: boolean
+                  data:
+                    type: object
+                    description: 签到状态数据
+      security:
+        - BearerAuth: []
   /track:
     post:
       tags:
@@ -1049,14 +1243,22 @@ components:
                               version:
                                 type: string
                                 pattern: ^\d+\.\d+\.\d+$
+                              source:
+                                type: string
+                                enum:
+                                  - bundled
+                                  - remote
+                                description: 组件来源：bundled = 内置组件，remote = 远程组件
                               integrity:
                                 type: string
                                 pattern: ^sha(256|384|512)-
                               assetsUrl:
                                 type: string
                                 format: uri
+                                description: CDN 资源基础 URL（source 为 remote 时必填）
                               entrypoints:
                                 type: object
+                                description: 入口点（source 为 remote 时必填）
                                 properties:
                                   js:
                                     type: string
@@ -1189,6 +1391,108 @@ components:
           type: string
           example: 00-4bf92f3577b34da6a3ce929d0e0e4736-00f067aa0ba902b7-01
           description: 链路追踪 ID（可选，用于分布式追踪）
+    ComponentManifest:
+      type: object
+      required:
+        - componentType
+        - version
+        - source
+      properties:
+        componentType:
+          type: string
+          description: 组件类型
+        version:
+          type: string
+          description: 组件版本
+        source:
+          type: string
+          enum:
+            - bundled
+            - remote
+          description: 组件来源：bundled = 内置组件（随 Runtime 打包），remote = 远程组件（从 CDN 加载）
+        entryUrl:
+          type: string
+          format: uri
+          description: 组件入口 URL（source 为 remote 时必填）
+        styleUrl:
+          type: string
+          format: uri
+          description: 样式文件 URL
+        integrity:
+          type: string
+          description: SRI 完整性哈希
+        blocked:
+          type: boolean
+          description: 是否被阻断
+        fallback:
+          type: string
+          description: 降级组件类型
+    ActionManifest:
+      type: object
+      required:
+        - actionId
+        - actionDefinitionVersionId
+      properties:
+        actionId:
+          type: string
+          description: 动作 ID
+        actionDefinitionVersionId:
+          type: string
+          description: 动作定义版本 ID
+        actionType:
+          type: string
+          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
+        - queryVersionId
+      properties:
+        queryId:
+          type: string
+          description: 查询 ID
+        queryVersionId:
+          type: string
+          description: 查询定义版本 ID
+        cacheTtl:
+          type: integer
+          description: 缓存 TTL（秒）
+    ResourceManifests:
+      type: object
+      properties:
+        components:
+          type: array
+          items:
+            $ref: '#/components/schemas/ComponentManifest'
+          description: 组件资源清单
+        actions:
+          type: array
+          items:
+            $ref: '#/components/schemas/ActionManifest'
+          description: 动作资源清单
+        queries:
+          type: array
+          items:
+            $ref: '#/components/schemas/QueryManifest'
+          description: 查询资源清单
     ActionClientContext:
       type: object
       description: 动作执行上下文（ActionClientContext，问题追溯必须字段）
@@ -1940,6 +2244,40 @@ components:
           type: string
           format: date-time
           description: 领取时间
+    ActivityStatus:
+      type: object
+      required:
+        - activityUid
+        - name
+        - type
+        - isInProgress
+        - startAt
+        - endAt
+      description: 活动状态信息（与 docs ActivityStatusVo 对齐）
+      properties:
+        activityUid:
+          type: string
+          description: 活动 UID
+        name:
+          type: string
+          description: 活动名称
+        type:
+          type: string
+          description: 活动类型
+          enum:
+            - claim
+            - signin
+        isInProgress:
+          type: boolean
+          description: 是否进行中
+        startAt:
+          type: string
+          format: date-time
+          description: 开始时间（ISODateTime）
+        endAt:
+          type: string
+          format: date-time
+          description: 结束时间（ISODateTime）
     TrackRequest:
       type: object
       required:
@@ -2108,84 +2446,6 @@ components:
               message:
                 type: string
           description: 依赖服务状态
-    ComponentManifest:
-      type: object
-      required:
-        - componentType
-        - version
-        - entryUrl
-      properties:
-        componentType:
-          type: string
-          description: 组件类型
-        version:
-          type: string
-          description: 组件版本
-        entryUrl:
-          type: string
-          format: uri
-          description: 组件入口 URL
-        styleUrl:
-          type: string
-          format: uri
-          description: 样式文件 URL
-        integrity:
-          type: string
-          description: SRI 完整性哈希
-        blocked:
-          type: boolean
-          description: 是否被阻断
-        fallback:
-          type: string
-          description: 降级组件类型
-    ActionManifest:
-      type: object
-      required:
-        - actionId
-        - actionDefinitionVersionId
-      properties:
-        actionId:
-          type: string
-          description: 动作 ID
-        actionDefinitionVersionId:
-          type: string
-          description: 动作定义版本 ID
-        actionType:
-          type: string
-          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
-        - queryVersionId
-      properties:
-        queryId:
-          type: string
-          description: 查询 ID
-        queryVersionId:
-          type: string
-          description: 查询定义版本 ID
-        cacheTtl:
-          type: integer
-          description: 缓存 TTL（秒）
     PageResponse:
       allOf:
         - $ref: '#/components/schemas/SuccessResponse'
@@ -2216,24 +2476,6 @@ components:
                 integrity:
                   type: string
                   description: 完整性哈希
-    ResourceManifests:
-      type: object
-      properties:
-        components:
-          type: array
-          items:
-            $ref: '#/components/schemas/ComponentManifest'
-          description: 组件资源清单
-        actions:
-          type: array
-          items:
-            $ref: '#/components/schemas/ActionManifest'
-          description: 动作资源清单
-        queries:
-          type: array
-          items:
-            $ref: '#/components/schemas/QueryManifest'
-          description: 查询资源清单
   responses:
     BadRequest:
       description: 请求参数错误

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

@@ -215,14 +215,20 @@ ResolvePageResponse:
                           version:
                             type: string
                             pattern: '^\d+\.\d+\.\d+$'
+                          source:
+                            type: string
+                            enum: [bundled, remote]
+                            description: '组件来源：bundled = 内置组件，remote = 远程组件'
                           integrity:
                             type: string
                             pattern: '^sha(256|384|512)-'
                           assetsUrl:
                             type: string
                             format: uri
+                            description: 'CDN 资源基础 URL（source 为 remote 时必填）'
                           entrypoints:
                             type: object
+                            description: '入口点（source 为 remote 时必填）'
                             properties:
                               js:
                                 type: string
@@ -329,7 +335,7 @@ ResourceManifests:
 
 ComponentManifest:
   type: object
-  required: [componentType, version, entryUrl]
+  required: [componentType, version, source]
   properties:
     componentType:
       type: string
@@ -337,10 +343,14 @@ ComponentManifest:
     version:
       type: string
       description: 组件版本
+    source:
+      type: string
+      enum: [bundled, remote]
+      description: '组件来源：bundled = 内置组件（随 Runtime 打包），remote = 远程组件（从 CDN 加载）'
     entryUrl:
       type: string
       format: uri
-      description: 组件入口 URL
+      description: '组件入口 URL（source 为 remote 时必填）'
     styleUrl:
       type: string
       format: uri
@@ -994,6 +1004,33 @@ HealthResponse:
 # Activity 用户活动相关
 # ============================================================================
 
+ActivityStatus:
+  type: object
+  required: [activityUid, name, type, isInProgress, startAt, endAt]
+  description: 活动状态信息（与 docs ActivityStatusVo 对齐）
+  properties:
+    activityUid:
+      type: string
+      description: 活动 UID
+    name:
+      type: string
+      description: 活动名称
+    type:
+      type: string
+      description: 活动类型
+      enum: [claim, signin]
+    isInProgress:
+      type: boolean
+      description: 是否进行中
+    startAt:
+      type: string
+      format: date-time
+      description: 开始时间（ISODateTime）
+    endAt:
+      type: string
+      format: date-time
+      description: 结束时间（ISODateTime）
+
 PublicActivityInfo:
   type: object
   required: [id, name, type, status]

package/openapi/src/openapi.yaml

@@ -49,6 +49,10 @@ paths:
   # 页面解析（根据设计总纲 V2）
   /page/resolve:
     $ref: './paths/pages.yaml#/resolve'
+  /page/manifest:
+    $ref: './paths/pages.yaml#/manifest'
+  /page/config:
+    $ref: './paths/pages.yaml#/config'
   
   # Action Gateway（统一入口）
   /actions/execute:
@@ -77,6 +81,12 @@ paths:
     $ref: './paths/activities.yaml#/claimRecords'
   /activities/{activityId}/lottery:
     $ref: './paths/activities.yaml#/lotteryRecords'
+  /activities/{activityId}/status:
+    $ref: './paths/activities.yaml#/activityStatus'
+  /activities/{activityId}/claim/status:
+    $ref: './paths/activities.yaml#/claimStatus'
+  /activities/{activityId}/signin/status:
+    $ref: './paths/activities.yaml#/signinStatus'
   
   # 埋点上报
   /track:

package/openapi/src/paths/activities.yaml

@@ -153,6 +153,107 @@ claimRecords:
     security:
       - BearerAuth: []
 
+activityStatus:
+  get:
+    tags:
+      - Activities
+    summary: 获取活动状态（兼容）
+    operationId: getActivityStatus
+    description: |
+      获取活动的当前状态信息，包括是否进行中、时间范围等。
+      不需要登录，可用于前端判断活动是否在有效期内。
+    parameters:
+      - name: activityId
+        in: path
+        required: true
+        schema:
+          type: string
+    responses:
+      '200':
+        description: 成功
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                success:
+                  type: boolean
+                data:
+                  $ref: '../components/schemas/_index.yaml#/ActivityStatus'
+      '404':
+        $ref: '../components/responses/_index.yaml#/NotFound'
+    security: []
+
+claimStatus:
+  get:
+    tags:
+      - Activities
+    summary: 获取领取状态
+    operationId: getClaimStatus
+    description: 获取用户在指定活动中的领取状态
+    parameters:
+      - name: activityId
+        in: path
+        required: true
+        schema:
+          type: string
+      - name: uid
+        in: query
+        required: true
+        schema:
+          type: string
+        description: 用户 UID
+    responses:
+      '200':
+        description: 成功
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                success:
+                  type: boolean
+                data:
+                  type: object
+                  description: 领取状态数据
+    security:
+      - BearerAuth: []
+
+signinStatus:
+  get:
+    tags:
+      - Activities
+    summary: 获取签到状态
+    operationId: getSigninStatus
+    description: 获取用户在指定活动中的签到状态
+    parameters:
+      - name: activityId
+        in: path
+        required: true
+        schema:
+          type: string
+      - name: uid
+        in: query
+        required: true
+        schema:
+          type: string
+        description: 用户 UID
+    responses:
+      '200':
+        description: 成功
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                success:
+                  type: boolean
+                data:
+                  type: object
+                  description: 签到状态数据
+    security:
+      - BearerAuth: []
+
 lotteryRecords:
   get:
     tags: