@djvlc/openapi-user-client 1.8.1 → 1.8.2

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 (12) hide show
  1. package/dist/index.d.mts +2317 -817
  2. package/dist/index.d.ts +2317 -817
  3. package/dist/index.js +1628 -508
  4. package/dist/index.mjs +1548 -508
  5. package/openapi/dist/user-api.yaml +185 -75
  6. package/openapi/src/paths/actions.yaml +18 -3
  7. package/openapi/src/paths/activities.yaml +56 -16
  8. package/openapi/src/paths/health.yaml +18 -3
  9. package/openapi/src/paths/pages.yaml +18 -3
  10. package/openapi/src/paths/queries.yaml +21 -6
  11. package/openapi/src/paths/tenant.yaml +12 -2
  12. package/package.json +1 -1
package/openapi/dist/user-api.yaml CHANGED
@@ -130,7 +130,12 @@ paths:
130
130
  content:
131
131
  application/json:
132
132
  schema:
133
- $ref: '#/components/schemas/ResolvePageResponse'
133
+ allOf:
134
+ - $ref: '#/components/schemas/SuccessResponse'
135
+ - type: object
136
+ properties:
137
+ data:
138
+ $ref: '#/components/schemas/ResolvePageResponse'
134
139
  '400':
135
140
  $ref: '#/components/responses/BadRequest'
136
141
  '404':
@@ -170,7 +175,12 @@ paths:
170
175
  content:
171
176
  application/json:
172
177
  schema:
173
- $ref: '#/components/schemas/ManifestResponse'
178
+ allOf:
179
+ - $ref: '#/components/schemas/SuccessResponse'
180
+ - type: object
181
+ properties:
182
+ data:
183
+ $ref: '#/components/schemas/ManifestResponse'
174
184
  '400':
175
185
  $ref: '#/components/responses/BadRequest'
176
186
  '404':
@@ -201,7 +211,12 @@ paths:
201
211
  content:
202
212
  application/json:
203
213
  schema:
204
- $ref: '#/components/schemas/OpsConfig'
214
+ allOf:
215
+ - $ref: '#/components/schemas/SuccessResponse'
216
+ - type: object
217
+ properties:
218
+ data:
219
+ $ref: '#/components/schemas/OpsConfig'
205
220
  '503':
206
221
  $ref: '#/components/responses/ServiceUnavailable'
207
222
  /actions/execute:
@@ -232,7 +247,12 @@ paths:
232
247
  content:
233
248
  application/json:
234
249
  schema:
235
- $ref: '#/components/schemas/ExecuteActionResponse'
250
+ allOf:
251
+ - $ref: '#/components/schemas/SuccessResponse'
252
+ - type: object
253
+ properties:
254
+ data:
255
+ $ref: '#/components/schemas/ExecuteActionResponse'
236
256
  '400':
237
257
  $ref: '#/components/responses/BadRequest'
238
258
  '401':
@@ -262,7 +282,12 @@ paths:
262
282
  content:
263
283
  application/json:
264
284
  schema:
265
- $ref: '#/components/schemas/ValidateActionResponse'
285
+ allOf:
286
+ - $ref: '#/components/schemas/SuccessResponse'
287
+ - type: object
288
+ properties:
289
+ data:
290
+ $ref: '#/components/schemas/ValidateActionResponse'
266
291
  '400':
267
292
  $ref: '#/components/responses/BadRequest'
268
293
  security:
@@ -288,7 +313,12 @@ paths:
288
313
  content:
289
314
  application/json:
290
315
  schema:
291
- $ref: '#/components/schemas/ActionDefinitionVersionResponse'
316
+ allOf:
317
+ - $ref: '#/components/schemas/SuccessResponse'
318
+ - type: object
319
+ properties:
320
+ data:
321
+ $ref: '#/components/schemas/ActionDefinitionVersionResponse'
292
322
  '404':
293
323
  $ref: '#/components/responses/NotFound'
294
324
  security:
@@ -308,11 +338,16 @@ paths:
308
338
  $ref: '#/components/schemas/QueryDataRequest'
309
339
  responses:
310
340
  '200':
311
- description: 成功
341
+ description: 查询成功
312
342
  content:
313
343
  application/json:
314
344
  schema:
315
- $ref: '#/components/schemas/QueryDataResponse'
345
+ allOf:
346
+ - $ref: '#/components/schemas/SuccessResponse'
347
+ - type: object
348
+ properties:
349
+ data:
350
+ $ref: '#/components/schemas/QueryDataResponse'
316
351
  '400':
317
352
  $ref: '#/components/responses/BadRequest'
318
353
  '401':
@@ -336,11 +371,16 @@ paths:
336
371
  $ref: '#/components/schemas/BatchQueryRequest'
337
372
  responses:
338
373
  '200':
339
- description: 批量查询结果
374
+ description: 批量查询成功
340
375
  content:
341
376
  application/json:
342
377
  schema:
343
- $ref: '#/components/schemas/BatchQueryResponse'
378
+ allOf:
379
+ - $ref: '#/components/schemas/SuccessResponse'
380
+ - type: object
381
+ properties:
382
+ data:
383
+ $ref: '#/components/schemas/BatchQueryResponse'
344
384
  '400':
345
385
  $ref: '#/components/responses/BadRequest'
346
386
  security:
@@ -360,11 +400,16 @@ paths:
360
400
  type: string
361
401
  responses:
362
402
  '200':
363
- description: 查询定义
403
+ description: 获取查询定义成功
364
404
  content:
365
405
  application/json:
366
406
  schema:
367
- $ref: '#/components/schemas/QueryDefinitionResponse'
407
+ allOf:
408
+ - $ref: '#/components/schemas/SuccessResponse'
409
+ - type: object
410
+ properties:
411
+ data:
412
+ $ref: '#/components/schemas/QueryDefinitionResponse'
368
413
  '404':
369
414
  $ref: '#/components/responses/NotFound'
370
415
  security:
@@ -384,11 +429,16 @@ paths:
384
429
  type: string
385
430
  responses:
386
431
  '200':
387
- description: 成功
432
+ description: 获取活动信息成功
388
433
  content:
389
434
  application/json:
390
435
  schema:
391
- $ref: '#/components/schemas/ActivityInfoResponse'
436
+ allOf:
437
+ - $ref: '#/components/schemas/SuccessResponse'
438
+ - type: object
439
+ properties:
440
+ data:
441
+ $ref: '#/components/schemas/ActivityInfoResponse'
392
442
  '404':
393
443
  $ref: '#/components/responses/NotFound'
394
444
  security: []
@@ -413,11 +463,16 @@ paths:
413
463
  type: string
414
464
  responses:
415
465
  '200':
416
- description: 成功
466
+ description: 获取活动状态成功
417
467
  content:
418
468
  application/json:
419
469
  schema:
420
- $ref: '#/components/schemas/ActivityStatusResponse'
470
+ allOf:
471
+ - $ref: '#/components/schemas/SuccessResponse'
472
+ - type: object
473
+ properties:
474
+ data:
475
+ $ref: '#/components/schemas/ActivityStatusResponse'
421
476
  '404':
422
477
  $ref: '#/components/responses/NotFound'
423
478
  /activities/{activityId}/signin/calendar:
@@ -448,11 +503,16 @@ paths:
448
503
  example: 2024-01
449
504
  responses:
450
505
  '200':
451
- description: 成功
506
+ description: 获取签到日历成功
452
507
  content:
453
508
  application/json:
454
509
  schema:
455
- $ref: '#/components/schemas/SigninCalendarResponse'
510
+ allOf:
511
+ - $ref: '#/components/schemas/SuccessResponse'
512
+ - type: object
513
+ properties:
514
+ data:
515
+ $ref: '#/components/schemas/SigninCalendarResponse'
456
516
  /activities/{activityId}/claims:
457
517
  get:
458
518
  tags:
@@ -487,11 +547,16 @@ paths:
487
547
  type: string
488
548
  responses:
489
549
  '200':
490
- description: 成功
550
+ description: 获取领取记录成功
491
551
  content:
492
552
  application/json:
493
553
  schema:
494
- $ref: '#/components/schemas/PaginatedRecordsResponse'
554
+ allOf:
555
+ - $ref: '#/components/schemas/SuccessResponse'
556
+ - type: object
557
+ properties:
558
+ data:
559
+ $ref: '#/components/schemas/PaginatedRecordsResponse'
495
560
  /activities/{activityId}/lottery:
496
561
  get:
497
562
  tags:
@@ -521,11 +586,16 @@ paths:
521
586
  type: string
522
587
  responses:
523
588
  '200':
524
- description: 成功
589
+ description: 获取抽奖记录成功
525
590
  content:
526
591
  application/json:
527
592
  schema:
528
- $ref: '#/components/schemas/PaginatedRecordsResponse'
593
+ allOf:
594
+ - $ref: '#/components/schemas/SuccessResponse'
595
+ - type: object
596
+ properties:
597
+ data:
598
+ $ref: '#/components/schemas/PaginatedRecordsResponse'
529
599
  /activities/{activityId}/status:
530
600
  get:
531
601
  tags:
@@ -541,11 +611,16 @@ paths:
541
611
  type: string
542
612
  responses:
543
613
  '200':
544
- description: 成功
614
+ description: 获取活动状态成功
545
615
  content:
546
616
  application/json:
547
617
  schema:
548
- $ref: '#/components/schemas/ActivityStatusResponse'
618
+ allOf:
619
+ - $ref: '#/components/schemas/SuccessResponse'
620
+ - type: object
621
+ properties:
622
+ data:
623
+ $ref: '#/components/schemas/ActivityStatusResponse'
549
624
  '404':
550
625
  $ref: '#/components/responses/NotFound'
551
626
  security: []
@@ -570,11 +645,16 @@ paths:
570
645
  type: string
571
646
  responses:
572
647
  '200':
573
- description: 成功
648
+ description: 获取领取状态成功
574
649
  content:
575
650
  application/json:
576
651
  schema:
577
- $ref: '#/components/schemas/ClaimStatusResponse'
652
+ allOf:
653
+ - $ref: '#/components/schemas/SuccessResponse'
654
+ - type: object
655
+ properties:
656
+ data:
657
+ $ref: '#/components/schemas/ClaimStatusResponse'
578
658
  /activities/{activityId}/signin/status:
579
659
  get:
580
660
  tags:
@@ -596,11 +676,16 @@ paths:
596
676
  type: string
597
677
  responses:
598
678
  '200':
599
- description: 成功
679
+ description: 获取签到状态成功
600
680
  content:
601
681
  application/json:
602
682
  schema:
603
- $ref: '#/components/schemas/SigninStatusResponse'
683
+ allOf:
684
+ - $ref: '#/components/schemas/SuccessResponse'
685
+ - type: object
686
+ properties:
687
+ data:
688
+ $ref: '#/components/schemas/SigninStatusResponse'
604
689
  /track:
605
690
  post:
606
691
  tags:
@@ -664,7 +749,12 @@ paths:
664
749
  content:
665
750
  application/json:
666
751
  schema:
667
- $ref: '#/components/schemas/ResolveTenantResponse'
752
+ allOf:
753
+ - $ref: '#/components/schemas/SuccessResponse'
754
+ - type: object
755
+ properties:
756
+ data:
757
+ $ref: '#/components/schemas/ResolveTenantResponse'
668
758
  '400':
669
759
  $ref: '#/components/responses/BadRequest'
670
760
  '404':
@@ -698,7 +788,12 @@ paths:
698
788
  content:
699
789
  application/json:
700
790
  schema:
701
- $ref: '#/components/schemas/TenantConfigResponse'
791
+ allOf:
792
+ - $ref: '#/components/schemas/SuccessResponse'
793
+ - type: object
794
+ properties:
795
+ data:
796
+ $ref: '#/components/schemas/TenantConfigResponse'
702
797
  '401':
703
798
  $ref: '#/components/responses/Unauthorized'
704
799
  '404':
@@ -716,7 +811,12 @@ paths:
716
811
  content:
717
812
  application/json:
718
813
  schema:
719
- $ref: '#/components/schemas/HealthCheckResponse'
814
+ allOf:
815
+ - $ref: '#/components/schemas/SuccessResponse'
816
+ - type: object
817
+ properties:
818
+ data:
819
+ $ref: '#/components/schemas/HealthCheckResponse'
720
820
  security: []
721
821
  /health/live:
722
822
  get:
@@ -731,7 +831,12 @@ paths:
731
831
  content:
732
832
  application/json:
733
833
  schema:
734
- $ref: '#/components/schemas/LivenessResponse'
834
+ allOf:
835
+ - $ref: '#/components/schemas/SuccessResponse'
836
+ - type: object
837
+ properties:
838
+ data:
839
+ $ref: '#/components/schemas/LivenessResponse'
735
840
  security: []
736
841
  /health/ready:
737
842
  get:
@@ -746,10 +851,57 @@ paths:
746
851
  content:
747
852
  application/json:
748
853
  schema:
749
- $ref: '#/components/schemas/ReadinessResponse'
854
+ allOf:
855
+ - $ref: '#/components/schemas/SuccessResponse'
856
+ - type: object
857
+ properties:
858
+ data:
859
+ $ref: '#/components/schemas/ReadinessResponse'
750
860
  security: []
751
861
  components:
752
862
  schemas:
863
+ SuccessResponse:
864
+ type: object
865
+ required:
866
+ - success
867
+ - code
868
+ - message
869
+ - data
870
+ - timestamp
871
+ - path
872
+ description: 成功响应（BaseResponseVo）
873
+ properties:
874
+ success:
875
+ type: boolean
876
+ description: 请求是否成功
877
+ example: true
878
+ code:
879
+ type: string
880
+ description: 业务状态码
881
+ example: OK
882
+ message:
883
+ type: string
884
+ description: 响应消息
885
+ example: 操作成功
886
+ data:
887
+ type: object
888
+ description: 响应数据
889
+ timestamp:
890
+ type: number
891
+ description: 响应时间戳
892
+ example: 1702300000000
893
+ path:
894
+ type: string
895
+ description: 请求路径
896
+ example: /api/users
897
+ requestId:
898
+ type: string
899
+ description: 请求ID
900
+ example: uuid-string
901
+ traceId:
902
+ type: string
903
+ description: 链路追踪ID（用于全链路定位问题）
904
+ example: trace-uuid-string
753
905
  BlockedComponent:
754
906
  type: object
755
907
  required:
@@ -1856,48 +2008,6 @@ components:
1856
2008
  redis:
1857
2009
  status: healthy
1858
2010
  message: Connection OK
1859
- SuccessResponse:
1860
- type: object
1861
- required:
1862
- - success
1863
- - code
1864
- - message
1865
- - data
1866
- - timestamp
1867
- - path
1868
- description: 成功响应（BaseResponseVo）
1869
- properties:
1870
- success:
1871
- type: boolean
1872
- description: 请求是否成功
1873
- example: true
1874
- code:
1875
- type: string
1876
- description: 业务状态码
1877
- example: OK
1878
- message:
1879
- type: string
1880
- description: 响应消息
1881
- example: 操作成功
1882
- data:
1883
- type: object
1884
- description: 响应数据
1885
- timestamp:
1886
- type: number
1887
- description: 响应时间戳
1888
- example: 1702300000000
1889
- path:
1890
- type: string
1891
- description: 请求路径
1892
- example: /api/users
1893
- requestId:
1894
- type: string
1895
- description: 请求ID
1896
- example: uuid-string
1897
- traceId:
1898
- type: string
1899
- description: 链路追踪ID（用于全链路定位问题）
1900
- example: trace-uuid-string
1901
2011
  PaginationMeta:
1902
2012
  type: object
1903
2013
  required:
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: []