@djvlc/openapi-user-client 1.8.1 → 1.8.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (13) hide show
  1. package/dist/index.d.mts +2502 -868
  2. package/dist/index.d.ts +2502 -868
  3. package/dist/index.js +1808 -591
  4. package/dist/index.mjs +1711 -582
  5. package/openapi/dist/user-api.yaml +279 -114
  6. package/openapi/src/components/schemas/_index.yaml +87 -33
  7. package/openapi/src/paths/actions.yaml +18 -3
  8. package/openapi/src/paths/activities.yaml +56 -16
  9. package/openapi/src/paths/health.yaml +18 -3
  10. package/openapi/src/paths/pages.yaml +18 -3
  11. package/openapi/src/paths/queries.yaml +21 -6
  12. package/openapi/src/paths/tenant.yaml +12 -2
  13. package/package.json +1 -1
package/openapi/src/components/schemas/_index.yaml CHANGED
@@ -125,6 +125,21 @@ CursorPaginationMeta:
125
125
  # 页面相关
126
126
  # ============================================================================
127
127
 
128
+ RolloutMatch:
129
+ type: object
130
+ required: [isDefault]
131
+ description: 灰度匹配信息（RolloutMatchVo）
132
+ properties:
133
+ strategyId:
134
+ type: string
135
+ description: 匹配的策略 ID
136
+ strategyName:
137
+ type: string
138
+ description: 匹配的策略名称
139
+ isDefault:
140
+ type: boolean
141
+ description: 是否使用默认版本
142
+
128
143
  ResolvePageResponse:
129
144
  type: object
130
145
  required: [pageId, resolvedVersionId, cdnBase, snapshotUrl, manifestUrl, ops, etag, cacheTtlSeconds]
@@ -145,11 +160,9 @@ ResolvePageResponse:
145
160
  snapshotUrl:
146
161
  type: string
147
162
  description: Snapshot URL
148
- example: https://cdn.example.com/pages/page_123456/snapshot.json
149
163
  manifestUrl:
150
164
  type: string
151
165
  description: Manifest URL
152
- example: https://cdn.example.com/pages/page_123456/manifest.json
153
166
  ops:
154
167
  description: 运维配置
155
168
  allOf:
@@ -169,6 +182,10 @@ ResolvePageResponse:
169
182
  type: string
170
183
  description: 运行时版本（SemVer）
171
184
  example: 1.0.0
185
+ rolloutMatch:
186
+ description: 灰度匹配信息
187
+ allOf:
188
+ - $ref: '#/RolloutMatch'
172
189
 
173
190
  ManifestComponent:
174
191
  type: object
@@ -235,70 +252,107 @@ ManifestResponse:
235
252
  allOf:
236
253
  - $ref: '#/ManifestRuntime'
237
254
 
238
- BlockedComponent:
255
+ KillSwitchItem:
239
256
  type: object
240
- required: [name, reason, blockedAt, blockedBy]
241
- description: 被阻断的组件（BlockedComponentVo）
257
+ required: [targetType, targetId, enabled]
258
+ description: Kill-Switch 项（KillSwitchItemVo）
259
+ properties:
260
+ targetType:
261
+ type: string
262
+ description: 目标类型
263
+ enum: [action, component, feature, page, query]
264
+ targetId:
265
+ type: string
266
+ description: 目标 ID
267
+ enabled:
268
+ type: boolean
269
+ description: 是否启用（true = 被关闭）
270
+ reason:
271
+ type: string
272
+ description: 关闭原因
273
+ enabledAt:
274
+ type: string
275
+ description: 关闭时间
276
+ format: date-time
277
+ enabledBy:
278
+ type: string
279
+ description: 关闭操作者
280
+ userMessage:
281
+ type: string
282
+ description: 用户提示消息
283
+
284
+ BlockedComponentItem:
285
+ type: object
286
+ required: [name, reason, blockedAt, blockedBy, urgent]
287
+ description: 被阻断的组件（BlockedComponentItemVo）
242
288
  properties:
243
289
  name:
244
290
  type: string
245
291
  description: 组件名称
246
292
  version:
247
293
  type: string
248
- description: 组件版本（不填则阻断所有版本）
294
+ description: 组件版本（不指定则阻断所有版本）
249
295
  reason:
250
296
  type: string
251
297
  description: 阻断原因
252
298
  blockedAt:
253
299
  type: string
254
300
  description: 阻断时间
301
+ format: date-time
255
302
  blockedBy:
256
303
  type: string
257
- description: 操作者
304
+ description: 阻断操作者
305
+ fallbackVersion:
306
+ type: string
307
+ description: 降级版本
308
+ urgent:
309
+ type: boolean
310
+ description: 是否紧急阻断
258
311
 
259
- DegradeConfig:
312
+ RateLimitConfig:
260
313
  type: object
261
- required: [enabled, mode]
262
- description: 降级配置（DegradeConfigVo）
314
+ description: 限流配置（RateLimitConfigVo）
263
315
  properties:
264
- enabled:
265
- type: boolean
266
- description: 是否启用降级
267
- mode:
268
- type: string
269
- description: 降级模式
270
- enum: [fallback, static, error]
271
- message:
272
- type: string
273
- description: 降级消息
316
+ globalQps:
317
+ type: number
318
+ description: 全局 QPS 限制
319
+ actionQps:
320
+ type: object
321
+ description: 按动作类型的 QPS 限制
322
+ additionalProperties:
323
+ type: number
274
324
 
275
325
  OpsConfig:
276
326
  type: object
277
- required: [killSwitch, blockedComponents, blockedPages, featureFlags, degradeConfig]
327
+ required: [killSwitch, blockedComponents, flags]
278
328
  description: 运维配置（OpsConfigVo）
279
329
  properties:
330
+ configVersionId:
331
+ type: string
332
+ description: 配置版本 ID（用于缓存失效）
280
333
  killSwitch:
281
- type: boolean
282
- description: 全局 kill-switch
283
- blockedComponents:
284
- description: 被阻断的组件列表
334
+ description: Kill-Switch 列表
285
335
  type: array
286
336
  items:
287
- $ref: '#/BlockedComponent'
288
- blockedPages:
289
- description: 被阻断的页面列表
337
+ $ref: '#/KillSwitchItem'
338
+ blockedComponents:
339
+ description: 被阻断的组件列表
290
340
  type: array
291
341
  items:
292
- type: string
293
- featureFlags:
342
+ $ref: '#/BlockedComponentItem'
343
+ flags:
294
344
  type: object
295
345
  description: 功能开关
296
346
  additionalProperties:
297
347
  type: boolean
298
- degradeConfig:
299
- description: 降级配置
348
+ rateLimit:
349
+ description: 限流配置
300
350
  allOf:
301
- - $ref: '#/DegradeConfig'
351
+ - $ref: '#/RateLimitConfig'
352
+ expiresAt:
353
+ type: string
354
+ description: 配置过期时间
355
+ format: date-time
302
356
 
303
357
  # ============================================================================
304
358
  # Action Gateway 动作相关
package/openapi/src/paths/actions.yaml CHANGED
@@ -27,7 +27,12 @@ execute:
27
27
  content:
28
28
  application/json:
29
29
  schema:
30
- $ref: '../components/schemas/_index.yaml#/ExecuteActionResponse'
30
+ allOf:
31
+ - $ref: '../components/schemas/_index.yaml#/SuccessResponse'
32
+ - type: object
33
+ properties:
34
+ data:
35
+ $ref: '../components/schemas/_index.yaml#/ExecuteActionResponse'
31
36
  '400':
32
37
  $ref: '../components/responses/_index.yaml#/BadRequest'
33
38
  '401':
@@ -57,7 +62,12 @@ validate:
57
62
  content:
58
63
  application/json:
59
64
  schema:
60
- $ref: '../components/schemas/_index.yaml#/ValidateActionResponse'
65
+ allOf:
66
+ - $ref: '../components/schemas/_index.yaml#/SuccessResponse'
67
+ - type: object
68
+ properties:
69
+ data:
70
+ $ref: '../components/schemas/_index.yaml#/ValidateActionResponse'
61
71
  '400':
62
72
  $ref: '../components/responses/_index.yaml#/BadRequest'
63
73
  security:
@@ -83,7 +93,12 @@ definitions:
83
93
  content:
84
94
  application/json:
85
95
  schema:
86
- $ref: '../components/schemas/_index.yaml#/ActionDefinitionVersionResponse'
96
+ allOf:
97
+ - $ref: '../components/schemas/_index.yaml#/SuccessResponse'
98
+ - type: object
99
+ properties:
100
+ data:
101
+ $ref: '../components/schemas/_index.yaml#/ActionDefinitionVersionResponse'
87
102
  '404':
88
103
  $ref: '../components/responses/_index.yaml#/NotFound'
89
104
  security:
package/openapi/src/paths/activities.yaml CHANGED
@@ -14,11 +14,16 @@ activityInfo:
14
14
  type: string
15
15
  responses:
16
16
  '200':
17
- description: 成功
17
+ description: 获取活动信息成功
18
18
  content:
19
19
  application/json:
20
20
  schema:
21
- $ref: '../components/schemas/_index.yaml#/ActivityInfoResponse'
21
+ allOf:
22
+ - $ref: '../components/schemas/_index.yaml#/SuccessResponse'
23
+ - type: object
24
+ properties:
25
+ data:
26
+ $ref: '../components/schemas/_index.yaml#/ActivityInfoResponse'
22
27
  '404':
23
28
  $ref: '../components/responses/_index.yaml#/NotFound'
24
29
  security: []
@@ -43,11 +48,16 @@ activityState:
43
48
  type: string
44
49
  responses:
45
50
  '200':
46
- description: 成功
51
+ description: 获取活动状态成功
47
52
  content:
48
53
  application/json:
49
54
  schema:
50
- $ref: '../components/schemas/_index.yaml#/ActivityStatusResponse'
55
+ allOf:
56
+ - $ref: '../components/schemas/_index.yaml#/SuccessResponse'
57
+ - type: object
58
+ properties:
59
+ data:
60
+ $ref: '../components/schemas/_index.yaml#/ActivityStatusResponse'
51
61
  '404':
52
62
  $ref: '../components/responses/_index.yaml#/NotFound'
53
63
 
@@ -78,11 +88,16 @@ signinCalendar:
78
88
  example: '2024-01'
79
89
  responses:
80
90
  '200':
81
- description: 成功
91
+ description: 获取签到日历成功
82
92
  content:
83
93
  application/json:
84
94
  schema:
85
- $ref: '../components/schemas/_index.yaml#/SigninCalendarResponse'
95
+ allOf:
96
+ - $ref: '../components/schemas/_index.yaml#/SuccessResponse'
97
+ - type: object
98
+ properties:
99
+ data:
100
+ $ref: '../components/schemas/_index.yaml#/SigninCalendarResponse'
86
101
 
87
102
  claimRecords:
88
103
  get:
@@ -117,11 +132,16 @@ claimRecords:
117
132
  type: string
118
133
  responses:
119
134
  '200':
120
- description: 成功
135
+ description: 获取领取记录成功
121
136
  content:
122
137
  application/json:
123
138
  schema:
124
- $ref: '../components/schemas/_index.yaml#/PaginatedRecordsResponse'
139
+ allOf:
140
+ - $ref: '../components/schemas/_index.yaml#/SuccessResponse'
141
+ - type: object
142
+ properties:
143
+ data:
144
+ $ref: '../components/schemas/_index.yaml#/PaginatedRecordsResponse'
125
145
 
126
146
  lotteryRecords:
127
147
  get:
@@ -151,11 +171,16 @@ lotteryRecords:
151
171
  type: string
152
172
  responses:
153
173
  '200':
154
- description: 成功
174
+ description: 获取抽奖记录成功
155
175
  content:
156
176
  application/json:
157
177
  schema:
158
- $ref: '../components/schemas/_index.yaml#/PaginatedRecordsResponse'
178
+ allOf:
179
+ - $ref: '../components/schemas/_index.yaml#/SuccessResponse'
180
+ - type: object
181
+ properties:
182
+ data:
183
+ $ref: '../components/schemas/_index.yaml#/PaginatedRecordsResponse'
159
184
 
160
185
  activityStatus:
161
186
  get:
@@ -171,11 +196,16 @@ activityStatus:
171
196
  type: string
172
197
  responses:
173
198
  '200':
174
- description: 成功
199
+ description: 获取活动状态成功
175
200
  content:
176
201
  application/json:
177
202
  schema:
178
- $ref: '../components/schemas/_index.yaml#/ActivityStatusResponse'
203
+ allOf:
204
+ - $ref: '../components/schemas/_index.yaml#/SuccessResponse'
205
+ - type: object
206
+ properties:
207
+ data:
208
+ $ref: '../components/schemas/_index.yaml#/ActivityStatusResponse'
179
209
  '404':
180
210
  $ref: '../components/responses/_index.yaml#/NotFound'
181
211
  security: []
@@ -200,11 +230,16 @@ claimStatus:
200
230
  type: string
201
231
  responses:
202
232
  '200':
203
- description: 成功
233
+ description: 获取领取状态成功
204
234
  content:
205
235
  application/json:
206
236
  schema:
207
- $ref: '../components/schemas/_index.yaml#/ClaimStatusResponse'
237
+ allOf:
238
+ - $ref: '../components/schemas/_index.yaml#/SuccessResponse'
239
+ - type: object
240
+ properties:
241
+ data:
242
+ $ref: '../components/schemas/_index.yaml#/ClaimStatusResponse'
208
243
 
209
244
  signinStatus:
210
245
  get:
@@ -226,8 +261,13 @@ signinStatus:
226
261
  type: string
227
262
  responses:
228
263
  '200':
229
- description: 成功
264
+ description: 获取签到状态成功
230
265
  content:
231
266
  application/json:
232
267
  schema:
233
- $ref: '../components/schemas/_index.yaml#/SigninStatusResponse'
268
+ allOf:
269
+ - $ref: '../components/schemas/_index.yaml#/SuccessResponse'
270
+ - type: object
271
+ properties:
272
+ data:
273
+ $ref: '../components/schemas/_index.yaml#/SigninStatusResponse'
package/openapi/src/paths/health.yaml CHANGED
@@ -12,7 +12,12 @@ health:
12
12
  content:
13
13
  application/json:
14
14
  schema:
15
- $ref: '../components/schemas/_index.yaml#/HealthCheckResponse'
15
+ allOf:
16
+ - $ref: '../components/schemas/_index.yaml#/SuccessResponse'
17
+ - type: object
18
+ properties:
19
+ data:
20
+ $ref: '../components/schemas/_index.yaml#/HealthCheckResponse'
16
21
  security: []
17
22
 
18
23
  live:
@@ -27,7 +32,12 @@ live:
27
32
  content:
28
33
  application/json:
29
34
  schema:
30
- $ref: '../components/schemas/_index.yaml#/LivenessResponse'
35
+ allOf:
36
+ - $ref: '../components/schemas/_index.yaml#/SuccessResponse'
37
+ - type: object
38
+ properties:
39
+ data:
40
+ $ref: '../components/schemas/_index.yaml#/LivenessResponse'
31
41
  security: []
32
42
 
33
43
  ready:
@@ -42,5 +52,10 @@ ready:
42
52
  content:
43
53
  application/json:
44
54
  schema:
45
- $ref: '../components/schemas/_index.yaml#/ReadinessResponse'
55
+ allOf:
56
+ - $ref: '../components/schemas/_index.yaml#/SuccessResponse'
57
+ - type: object
58
+ properties:
59
+ data:
60
+ $ref: '../components/schemas/_index.yaml#/ReadinessResponse'
46
61
  security: []
package/openapi/src/paths/pages.yaml CHANGED
@@ -80,7 +80,12 @@ resolve:
80
80
  content:
81
81
  application/json:
82
82
  schema:
83
- $ref: '../components/schemas/_index.yaml#/ResolvePageResponse'
83
+ allOf:
84
+ - $ref: '../components/schemas/_index.yaml#/SuccessResponse'
85
+ - type: object
86
+ properties:
87
+ data:
88
+ $ref: '../components/schemas/_index.yaml#/ResolvePageResponse'
84
89
  '400':
85
90
  $ref: '../components/responses/_index.yaml#/BadRequest'
86
91
  '404':
@@ -117,7 +122,12 @@ manifest:
117
122
  content:
118
123
  application/json:
119
124
  schema:
120
- $ref: '../components/schemas/_index.yaml#/ManifestResponse'
125
+ allOf:
126
+ - $ref: '../components/schemas/_index.yaml#/SuccessResponse'
127
+ - type: object
128
+ properties:
129
+ data:
130
+ $ref: '../components/schemas/_index.yaml#/ManifestResponse'
121
131
  '400':
122
132
  $ref: '../components/responses/_index.yaml#/BadRequest'
123
133
  '404':
@@ -145,6 +155,11 @@ config:
145
155
  content:
146
156
  application/json:
147
157
  schema:
148
- $ref: '../components/schemas/_index.yaml#/OpsConfig'
158
+ allOf:
159
+ - $ref: '../components/schemas/_index.yaml#/SuccessResponse'
160
+ - type: object
161
+ properties:
162
+ data:
163
+ $ref: '../components/schemas/_index.yaml#/OpsConfig'
149
164
  '503':
150
165
  $ref: '../components/responses/_index.yaml#/ServiceUnavailable'
package/openapi/src/paths/queries.yaml CHANGED
@@ -14,11 +14,16 @@ query:
14
14
  $ref: '../components/schemas/_index.yaml#/QueryDataRequest'
15
15
  responses:
16
16
  '200':
17
- description: 成功
17
+ description: 查询成功
18
18
  content:
19
19
  application/json:
20
20
  schema:
21
- $ref: '../components/schemas/_index.yaml#/QueryDataResponse'
21
+ allOf:
22
+ - $ref: '../components/schemas/_index.yaml#/SuccessResponse'
23
+ - type: object
24
+ properties:
25
+ data:
26
+ $ref: '../components/schemas/_index.yaml#/QueryDataResponse'
22
27
  '400':
23
28
  $ref: '../components/responses/_index.yaml#/BadRequest'
24
29
  '401':
@@ -42,11 +47,16 @@ batch:
42
47
  $ref: '../components/schemas/_index.yaml#/BatchQueryRequest'
43
48
  responses:
44
49
  '200':
45
- description: 批量查询结果
50
+ description: 批量查询成功
46
51
  content:
47
52
  application/json:
48
53
  schema:
49
- $ref: '../components/schemas/_index.yaml#/BatchQueryResponse'
54
+ allOf:
55
+ - $ref: '../components/schemas/_index.yaml#/SuccessResponse'
56
+ - type: object
57
+ properties:
58
+ data:
59
+ $ref: '../components/schemas/_index.yaml#/BatchQueryResponse'
50
60
  '400':
51
61
  $ref: '../components/responses/_index.yaml#/BadRequest'
52
62
  security:
@@ -66,11 +76,16 @@ definitions:
66
76
  type: string
67
77
  responses:
68
78
  '200':
69
- description: 查询定义
79
+ description: 获取查询定义成功
70
80
  content:
71
81
  application/json:
72
82
  schema:
73
- $ref: '../components/schemas/_index.yaml#/QueryDefinitionResponse'
83
+ allOf:
84
+ - $ref: '../components/schemas/_index.yaml#/SuccessResponse'
85
+ - type: object
86
+ properties:
87
+ data:
88
+ $ref: '../components/schemas/_index.yaml#/QueryDefinitionResponse'
74
89
  '404':
75
90
  $ref: '../components/responses/_index.yaml#/NotFound'
76
91
  security:
package/openapi/src/paths/tenant.yaml CHANGED
@@ -18,7 +18,12 @@ resolve:
18
18
  content:
19
19
  application/json:
20
20
  schema:
21
- $ref: '../components/schemas/_index.yaml#/ResolveTenantResponse'
21
+ allOf:
22
+ - $ref: '../components/schemas/_index.yaml#/SuccessResponse'
23
+ - type: object
24
+ properties:
25
+ data:
26
+ $ref: '../components/schemas/_index.yaml#/ResolveTenantResponse'
22
27
  '400':
23
28
  $ref: '../components/responses/_index.yaml#/BadRequest'
24
29
  '404':
@@ -52,7 +57,12 @@ config:
52
57
  content:
53
58
  application/json:
54
59
  schema:
55
- $ref: '../components/schemas/_index.yaml#/TenantConfigResponse'
60
+ allOf:
61
+ - $ref: '../components/schemas/_index.yaml#/SuccessResponse'
62
+ - type: object
63
+ properties:
64
+ data:
65
+ $ref: '../components/schemas/_index.yaml#/TenantConfigResponse'
56
66
  '401':
57
67
  $ref: '../components/responses/_index.yaml#/Unauthorized'
58
68
  '404':
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@djvlc/openapi-user-client",
3
- "version": "1.8.1",
3
+ "version": "1.8.3",
4
4
  "description": "DJV Low-code Platform - User API 客户端（自动生成）",
5
5
  "main": "./dist/index.js",
6
6
  "module": "./dist/index.mjs",