@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/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,86 +851,186 @@ 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:
753
- BlockedComponent:
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
905
+ KillSwitchItem:
906
+ type: object
907
+ required:
908
+ - targetType
909
+ - targetId
910
+ - enabled
911
+ description: Kill-Switch 项（KillSwitchItemVo）
912
+ properties:
913
+ targetType:
914
+ type: string
915
+ description: 目标类型
916
+ enum:
917
+ - action
918
+ - component
919
+ - feature
920
+ - page
921
+ - query
922
+ targetId:
923
+ type: string
924
+ description: 目标 ID
925
+ enabled:
926
+ type: boolean
927
+ description: 是否启用（true = 被关闭）
928
+ reason:
929
+ type: string
930
+ description: 关闭原因
931
+ enabledAt:
932
+ type: string
933
+ description: 关闭时间
934
+ format: date-time
935
+ enabledBy:
936
+ type: string
937
+ description: 关闭操作者
938
+ userMessage:
939
+ type: string
940
+ description: 用户提示消息
941
+ BlockedComponentItem:
754
942
  type: object
755
943
  required:
756
944
  - name
757
945
  - reason
758
946
  - blockedAt
759
947
  - blockedBy
760
- description: 被阻断的组件（BlockedComponentVo）
948
+ - urgent
949
+ description: 被阻断的组件（BlockedComponentItemVo）
761
950
  properties:
762
951
  name:
763
952
  type: string
764
953
  description: 组件名称
765
954
  version:
766
955
  type: string
767
- description: 组件版本（不填则阻断所有版本）
956
+ description: 组件版本（不指定则阻断所有版本）
768
957
  reason:
769
958
  type: string
770
959
  description: 阻断原因
771
960
  blockedAt:
772
961
  type: string
773
962
  description: 阻断时间
963
+ format: date-time
774
964
  blockedBy:
775
965
  type: string
776
- description: 操作者
777
- DegradeConfig:
966
+ description: 阻断操作者
967
+ fallbackVersion:
968
+ type: string
969
+ description: 降级版本
970
+ urgent:
971
+ type: boolean
972
+ description: 是否紧急阻断
973
+ RateLimitConfig:
778
974
  type: object
779
- required:
780
- - enabled
781
- - mode
782
- description: 降级配置（DegradeConfigVo）
975
+ description: 限流配置（RateLimitConfigVo）
783
976
  properties:
784
- enabled:
785
- type: boolean
786
- description: 是否启用降级
787
- mode:
788
- type: string
789
- description: 降级模式
790
- enum:
791
- - fallback
792
- - static
793
- - error
794
- message:
795
- type: string
796
- description: 降级消息
977
+ globalQps:
978
+ type: number
979
+ description: 全局 QPS 限制
980
+ actionQps:
981
+ type: object
982
+ description: 按动作类型的 QPS 限制
983
+ additionalProperties:
984
+ type: number
797
985
  OpsConfig:
798
986
  type: object
799
987
  required:
800
988
  - killSwitch
801
989
  - blockedComponents
802
- - blockedPages
803
- - featureFlags
804
- - degradeConfig
990
+ - flags
805
991
  description: 运维配置（OpsConfigVo）
806
992
  properties:
993
+ configVersionId:
994
+ type: string
995
+ description: 配置版本 ID（用于缓存失效）
807
996
  killSwitch:
808
- type: boolean
809
- description: 全局 kill-switch
810
- blockedComponents:
811
- description: 被阻断的组件列表
997
+ description: Kill-Switch 列表
812
998
  type: array
813
999
  items:
814
- $ref: '#/components/schemas/BlockedComponent'
815
- blockedPages:
816
- description: 被阻断的页面列表
1000
+ $ref: '#/components/schemas/KillSwitchItem'
1001
+ blockedComponents:
1002
+ description: 被阻断的组件列表
817
1003
  type: array
818
1004
  items:
819
- type: string
820
- featureFlags:
1005
+ $ref: '#/components/schemas/BlockedComponentItem'
1006
+ flags:
821
1007
  type: object
822
1008
  description: 功能开关
823
1009
  additionalProperties:
824
1010
  type: boolean
825
- degradeConfig:
826
- description: 降级配置
1011
+ rateLimit:
1012
+ description: 限流配置
827
1013
  allOf:
828
- - $ref: '#/components/schemas/DegradeConfig'
1014
+ - $ref: '#/components/schemas/RateLimitConfig'
1015
+ expiresAt:
1016
+ type: string
1017
+ description: 配置过期时间
1018
+ format: date-time
1019
+ RolloutMatch:
1020
+ type: object
1021
+ required:
1022
+ - isDefault
1023
+ description: 灰度匹配信息（RolloutMatchVo）
1024
+ properties:
1025
+ strategyId:
1026
+ type: string
1027
+ description: 匹配的策略 ID
1028
+ strategyName:
1029
+ type: string
1030
+ description: 匹配的策略名称
1031
+ isDefault:
1032
+ type: boolean
1033
+ description: 是否使用默认版本
829
1034
  ResolvePageResponse:
830
1035
  type: object
831
1036
  required:
@@ -854,11 +1059,9 @@ components:
854
1059
  snapshotUrl:
855
1060
  type: string
856
1061
  description: Snapshot URL
857
- example: https://cdn.example.com/pages/page_123456/snapshot.json
858
1062
  manifestUrl:
859
1063
  type: string
860
1064
  description: Manifest URL
861
- example: https://cdn.example.com/pages/page_123456/manifest.json
862
1065
  ops:
863
1066
  description: 运维配置
864
1067
  allOf:
@@ -878,6 +1081,10 @@ components:
878
1081
  type: string
879
1082
  description: 运行时版本（SemVer）
880
1083
  example: 1.0.0
1084
+ rolloutMatch:
1085
+ description: 灰度匹配信息
1086
+ allOf:
1087
+ - $ref: '#/components/schemas/RolloutMatch'
881
1088
  ErrorResponse:
882
1089
  type: object
883
1090
  required:
@@ -1856,48 +2063,6 @@ components:
1856
2063
  redis:
1857
2064
  status: healthy
1858
2065
  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
2066
  PaginationMeta:
1902
2067
  type: object
1903
2068
  required: