@hyext/types-ext-sdk-hy 3.14.3-beta.2 → 3.14.4-beta.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 (2) hide show
  1. package/index.d.ts +971 -97
  2. package/package.json +2 -2
package/index.d.ts CHANGED
@@ -225,6 +225,720 @@ type SysConfig = {
225
225
  */
226
226
  function getConfig(): SysConfig;
227
227
 
228
+ /**
229
+ * 扩展加载完成回调
230
+ * @param callback - 回调函数
231
+ */
232
+ function onLoad(callback: (...params: any[]) => any): void;
233
+
234
+ function onUnload(callback: (...params: any[]) => any): void;
235
+
236
+ /**
237
+ * 注册App进入前台时回调
238
+ */
239
+ function onEnterForeground(callback: (...params: any[]) => any): void;
240
+
241
+ /**
242
+ * 注册App进入后台时回调
243
+ */
244
+ function onLeaveForeground(callback: (...params: any[]) => any): void;
245
+
246
+ /**
247
+ * 小程序显示的生命周期
248
+ */
249
+ function onAppear(callback: (...params: any[]) => any): void;
250
+
251
+ /**
252
+ * 小程序隐藏的生命周期
253
+ */
254
+ function onDisappear(callback: (...params: any[]) => any): void;
255
+
256
+ /**
257
+ * 后台
258
+ */
259
+ namespace backend {
260
+ /**
261
+ * 通用查询后台状态接口
262
+ * @param params.key - 关键字
263
+ * @param params.param - 参数
264
+ */
265
+ function commonQuery(params: {
266
+ key: string;
267
+ param: any;
268
+ }): void;
269
+ /**
270
+ * 通用查询后台状态接口
271
+ * @param params.key - 关键字
272
+ * @param params.param - 参数
273
+ */
274
+ function commonQuery(params: {
275
+ key: string;
276
+ param: any;
277
+ }): void;
278
+ /**
279
+ * 通用上行接口
280
+ * @param params - 操作选项
281
+ * @returns 返回结果
282
+ */
283
+ function commonOperate(params: DiyOptions): Promise<CommonOperateResp>;
284
+ }
285
+
286
+ /**
287
+ * 直播间事件
288
+ */
289
+ namespace context {
290
+ /**
291
+ * 监听直播间消息
292
+ * @param topic - 消息名
293
+ * @param callback - 收到消息时回调 返回消息内容
294
+ */
295
+ function on(topic: string, callback: (...params: any[]) => any): void;
296
+ /**
297
+ * 取消监听直播间消息
298
+ * @param topic - 消息名
299
+ * @param callback - 收到消息时回调 返回消息内容
300
+ */
301
+ function off(topic: string, callback: (...params: any[]) => any): void;
302
+ /**
303
+ * 获取用户信息,目前返回昵称、头像信息
304
+ * @returns 返回用户信息,{ userNick, userAvatar }
305
+ */
306
+ function getUserInfo(): Promise<object>;
307
+ /**
308
+ * 获取安全区域的位置
309
+ * @returns 返回安全区域位置 left, top, right, bottom
310
+ */
311
+ function getSafeAreaPosition(): Promise<object>;
312
+ /**
313
+ * 显示红点
314
+ * @returns 返回是否显示成功
315
+ */
316
+ function showActivityBadge(): Promise<object>;
317
+ /**
318
+ * 显示toast
319
+ * @param message - toast中显示的消息
320
+ * @returns 返回toast是否显示成功
321
+ */
322
+ function showToast(message: string): Promise<object>;
323
+ /**
324
+ * 监听当前直播间小程序容器布局变化消息
325
+ */
326
+ function onLayoutChange(callback: LayoutChange): void;
327
+ /**
328
+ * 监听所有弹幕
329
+ * @param options - 弹幕筛选
330
+ * @param options.sendNick - 用户昵称关键字
331
+ * @param options.content - 弹幕内容关键字
332
+ * @param options.nobleLevel - 贵族等级
333
+ * @param options.fansLevel - 粉丝等级
334
+ */
335
+ function onBarrageChange(options: {
336
+ sendNick: string;
337
+ content: string;
338
+ nobleLevel: number;
339
+ fansLevel: number;
340
+ }, callback: BarrageCallback): void;
341
+ /**
342
+ * 关闭监听所有弹幕
343
+ */
344
+ function offBarrageChange(): void;
345
+ /**
346
+ * 监听直播间消息
347
+ * @param topic - 消息名
348
+ * @param callback - 收到消息时回调 返回消息内容
349
+ */
350
+ function on(topic: string, callback: (...params: any[]) => any): void;
351
+ /**
352
+ * 取消监听直播间消息
353
+ * @param topic - 消息名
354
+ * @param callback - 收到消息时回调 返回消息内容
355
+ */
356
+ function off(topic: string, callback: (...params: any[]) => any): void;
357
+ /**
358
+ * 显示红点
359
+ * @returns 返回是否显示成功
360
+ */
361
+ function showActivityBadge(): Promise<object>;
362
+ /**
363
+ * 显示toast
364
+ * @param message - toast中显示的消息
365
+ * @returns 返回toast是否显示成功
366
+ */
367
+ function showToast(message: string): Promise<object>;
368
+ /**
369
+ * 获取安全区域的位置
370
+ * @returns 返回安全区域位置 left, top, right, bottom
371
+ */
372
+ function getSafeAreaPosition(): Promise<object>;
373
+ /**
374
+ * 监听当前直播间小程序容器布局变化消息
375
+ */
376
+ function onLayoutChange(callback: LayoutChange): void;
377
+ /**
378
+ * 引导订阅
379
+ */
380
+ function leadSubscribe(): Promise<void>;
381
+ /**
382
+ * 获取当前直播间礼物配置
383
+ * @returns 返回直播间礼物配置
384
+ */
385
+ function getGiftConf(): Promise<RoomGiftConfig[]>;
386
+ /**
387
+ * 当前观众送礼
388
+ * @param params - 发送礼物信息
389
+ */
390
+ function sendGift(params: SendGiftInfo): Promise<void>;
391
+ /**
392
+ * 引导当前观众送礼
393
+ * @returns 引导成功返回送礼人信息
394
+ */
395
+ function leadGift(): Promise<void>;
396
+ /**
397
+ * 监听当前直播间礼物变化消息
398
+ * @param options - 过滤条件
399
+ * @param callback - 礼物信息回调
400
+ * @returns 操作结果
401
+ */
402
+ function onGiftChange(options: GiftChangeOptions, callback: GiftChange): Promise<void>;
403
+ /**
404
+ * 取消监听当前直播间礼物变化消息
405
+ * @returns 操作结果
406
+ */
407
+ function offGiftChange(): Promise<void>;
408
+ /**
409
+ * 引导当前用户发送弹幕
410
+ * @returns 调用结果
411
+ */
412
+ function leadBarrage(): Promise<void>;
413
+ /**
414
+ * 监听所有弹幕
415
+ * @param options - 弹幕筛选
416
+ * @param options.sendNick - 用户昵称关键字
417
+ * @param options.content - 弹幕内容关键字
418
+ * @param options.nobleLevel - 贵族等级
419
+ * @param options.fansLevel - 粉丝等级
420
+ */
421
+ function onBarrageChange(options: {
422
+ sendNick: string;
423
+ content: string;
424
+ nobleLevel: number;
425
+ fansLevel: number;
426
+ }, callback: BarrageCallback): void;
427
+ /**
428
+ * 关闭监听所有弹幕
429
+ */
430
+ function offBarrageChange(): void;
431
+ /**
432
+ * 监听开通守护
433
+ * @param params - 监听开通守护参数
434
+ */
435
+ function onOpenGuardianNotice(params: OpenGuardianNoticeParams): Promise<void>;
436
+ /**
437
+ * 关闭监听开通守护
438
+ */
439
+ function offOpenGuardianNotice(): Promise<void>;
440
+ /**
441
+ * 监听开通贵族
442
+ * @param params - 监听开通贵族参数
443
+ */
444
+ function onOpenNobleNotice(params: OnOpenNobleNoticeParams): Promise<void>;
445
+ /**
446
+ * 关闭监听开通贵族
447
+ */
448
+ function offOpenNobleNotice(): Promise<void>;
449
+ /**
450
+ * 监听高级用户进场
451
+ * @param params - 参数
452
+ */
453
+ function onVipEnterBannerNotice(params: VipEnterBannerNoticeParams): Promise<void>;
454
+ /**
455
+ * 取消监听高级用户进场
456
+ */
457
+ function offVipEnterBannerNotice(): Promise<void>;
458
+ /**
459
+ * 监听分享直播间事件
460
+ * @param params - 监听分享直播间参数
461
+ */
462
+ function onShareLiveNotice(params: ShareLiveNoticeParams): Promise<void>;
463
+ /**
464
+ * 取消监听分享直播间事件
465
+ */
466
+ function offShareLiveNotice(): Promise<void>;
467
+ /**
468
+ * 获取当前观众是否订阅当前主播
469
+ * @returns 返回是否订阅
470
+ */
471
+ function getSubscribeInfo(): Promise<boolean>;
472
+ /**
473
+ * 获取主播信息
474
+ * @returns 返回用户信息
475
+ */
476
+ function getStreamerInfo(): Promise<StreamerInfo>;
477
+ /**
478
+ * 获取app信息,目前返回app版本、UA(计划废弃)
479
+ * @returns 返回app信息
480
+ */
481
+ function getContextInfo(): Promise<ContextInfo>;
482
+ /**
483
+ * 获取直播间信息
484
+ * @returns 返回直播间信息
485
+ */
486
+ function getLiveInfo(): Promise<RespLiveInfo>;
487
+ /**
488
+ * 获取用户信息,目前返回昵称、头像信息
489
+ * @returns 返回用户信息,{ userNick, userAvatar }
490
+ */
491
+ function getUserInfo(): Promise<object>;
492
+ /**
493
+ * 获取直播间的粉丝榜信息
494
+ * @returns 返回直播间粉丝榜信息
495
+ */
496
+ function getFansRank(): Promise<RankInfo>;
497
+ /**
498
+ * 获取直播间所有贵宾信息
499
+ * @returns 返回直播间所有贵宾信息
500
+ */
501
+ function getVip(): Promise<VipItem[]>;
502
+ /**
503
+ * 获取直播间的周贡榜信息
504
+ * @returns 返回周贡榜榜单数据
505
+ */
506
+ function getWeekRank(): Promise<WeekRankItem[]>;
507
+ /**
508
+ * 设置发送弹幕分组标签
509
+ * @param param - 发送弹幕分组标签参数
510
+ * @returns 返回设置发送弹幕分组标签是否显示成功
511
+ */
512
+ function setSendBarrageTag(param: SendBarrageTagParams): Promise<void>;
513
+ /**
514
+ * 设置显示弹幕分组标签
515
+ * @param param - 显示弹幕分组标签参数
516
+ * @returns 返回设置显示弹幕分组标签是否显示成功
517
+ */
518
+ function setDisplayBarrageTags(param: DisplayBarrageTagParams): Promise<void>;
519
+ /**
520
+ * 分享直播间
521
+ * @param params - 分享配置
522
+ * @returns 返回分享直播间是否成功
523
+ */
524
+ function share(params: ShareParams): Promise<void>;
525
+ /**
526
+ * 获取当前主播的订阅概况
527
+ * @returns 订阅者概况
528
+ */
529
+ function getSubscriberSummary(): Promise<SubscriberSummary>;
530
+ /**
531
+ * 监听订阅信息改变
532
+ * @param options - 订阅信息过滤条件
533
+ * @param callback - 订阅信息改变回调
534
+ */
535
+ function onSubscriberChange(options: SubscriberOptions, callback: SubscriberChangeCallback): Promise<void>;
536
+ /**
537
+ * 取消监听订阅信息改变
538
+ */
539
+ function offSubscriberChange(): Promise<void>;
540
+ /**
541
+ * 获取直播间功能
542
+ * @param params - 相关功能的键的数组(可以提供一个或者多个)
543
+ * @returns 返回 直播间功能信息(根据参数提供的键会有对应的字段)
544
+ */
545
+ function getLiveRoomFeatures(params: FeatureKey[]): Promise<Features>;
546
+ /**
547
+ * 设置直播间功能
548
+ * @param params - 相关功能的键以及要设置的参数(可以提供一个键或者多个)
549
+ * @returns 功能设置结果(根据参数提供的键会有对应的字段)
550
+ */
551
+ function setLiveRoomFeatures(params: Features): Promise<FeaturesResp>;
552
+ /**
553
+ * 使用外部浏览器打开指定URL
554
+ * @param params - 请求参数
555
+ * @returns 返回结果
556
+ */
557
+ function openExternalUrl(params: UrlParams): Promise<void>;
558
+ /**
559
+ * 设置弹幕输入框占位符
560
+ * @param params - 请求参数
561
+ * @returns 返回结果
562
+ */
563
+ function setBarrageInputPlaceholder(params: SetBarrageInputPlaceholderReq): Promise<void>;
564
+ }
565
+
566
+ /**
567
+ * @property screenWidth - 容器宽度
568
+ * @property screenHeight - 容器高度
569
+ * @property isLandscape - 是否横屏,web端固定为true
570
+ */
571
+ type LayoutInfo = {
572
+ screenWidth: number;
573
+ screenHeight: number;
574
+ isLandscape: boolean;
575
+ };
576
+
577
+ type LayoutChange = (info: LayoutInfo) => void;
578
+
579
+ /**
580
+ * @property sendNick - 发言人的昵称
581
+ * @property senderAvatarUrl - 发言人的头像地址
582
+ * @property senderGender - 发言人的性别
583
+ * @property nobleLevel - 发言人的贵族等级
584
+ * @property fansLevel - 发言人的粉丝等级
585
+ * @property content - 弹幕内容
586
+ */
587
+ type BarrageData = {
588
+ sendNick: string;
589
+ senderAvatarUrl: string;
590
+ senderGender: number;
591
+ nobleLevel: number;
592
+ fansLevel: number;
593
+ content: string;
594
+ };
595
+
596
+ /**
597
+ * 弹幕信息回调
598
+ * @param data - 参数
599
+ */
600
+ type BarrageCallback = (data: BarrageData) => boolean;
601
+
602
+ /**
603
+ * 环境信息
604
+ */
605
+ namespace env {
606
+ /**
607
+ * 获取当前版本类型
608
+ */
609
+ function getVersionType(): Promise<VersionInfo>;
610
+ /**
611
+ * 获取初始化参数
612
+ * @returns 初始化参数
613
+ */
614
+ function getInitialParam(): Promise<object>;
615
+ /**
616
+ * 获取小程序启动参数
617
+ * @returns 小程序启动参数
618
+ */
619
+ function getExtInfo(): Promise<object>;
620
+ /**
621
+ * 获取宿主信息接口,使用querystring解析rn bundle的查询串参数,返回给小程序
622
+ * @returns 宿主信息
623
+ */
624
+ function getHostInfo(): Promise<object>;
625
+ /**
626
+ * 获取当前版本类型
627
+ */
628
+ function getVersionType(): Promise<VersionInfo>;
629
+ /**
630
+ * 获取初始化参数
631
+ * @returns 初始化参数
632
+ */
633
+ function getInitialParam(): Promise<object>;
634
+ /**
635
+ * 获取小程序启动参数
636
+ * @returns 小程序启动参数
637
+ */
638
+ function getExtInfo(): Promise<object>;
639
+ /**
640
+ * 获取宿主信息接口,使用querystring解析rn bundle的查询串参数,返回给小程序
641
+ * @returns 宿主信息
642
+ */
643
+ function getHostInfo(): Promise<object>;
644
+ /**
645
+ * 获取性能数据
646
+ * @returns 调用结果
647
+ */
648
+ function getPerformaceData(): Promise<PerformaceDataRsp>;
649
+ }
650
+
651
+ /**
652
+ * @property versionType - 返回当前版本类型,1-开发版本,2-灰度版本,3-正式版本
653
+ */
654
+ type VersionInfo = {
655
+ versionType: number;
656
+ };
657
+
658
+ /**
659
+ * 文件系统
660
+ */
661
+ namespace fs {
662
+ /**
663
+ * 调取本地相册
664
+ */
665
+ function uploadImg(): void;
666
+ /**
667
+ * 监听离线资源是否下载完成消息
668
+ * @param params.url - 资源地址
669
+ */
670
+ function offlineFileReady(params: {
671
+ url: string;
672
+ }): Promise<string>;
673
+ /**
674
+ * 调取本地相册
675
+ */
676
+ function uploadImg(): void;
677
+ /**
678
+ * 监听离线资源是否下载完成消息
679
+ * @param params.url - 资源地址
680
+ */
681
+ function offlineFileReady(params: {
682
+ url: string;
683
+ }): Promise<string>;
684
+ /**
685
+ * 通用上传文件接口
686
+ * @returns 调用结果
687
+ */
688
+ function uploadFile(): Promise<UrlInfo>;
689
+ /**
690
+ * 批量下载资源
691
+ * @param params - 下载资源信息
692
+ * @returns 调用结果
693
+ */
694
+ function downloadBatchRes(params: BatchRes[]): Promise<void>;
695
+ /**
696
+ * 删除资源
697
+ * @param params - 要删除的资源信息
698
+ * @returns 调用结果
699
+ */
700
+ function removeRes(params: RemoveRes): Promise<void>;
701
+ /**
702
+ * 判断资源是否存在
703
+ * @param params - 要判断的资源信息
704
+ * @returns 查询结果结果
705
+ */
706
+ function isResExists(params: ExistsReq): Promise<ExistsResp>;
707
+ /**
708
+ * 增强型上传文件
709
+ * @param params - 要判断的资源信息
710
+ * @returns 查询结果结果
711
+ */
712
+ function uploadFileExtra(params: FileExtraParams): Promise<FileExtraResp>;
713
+ /**
714
+ * 批量发起下载共享资源
715
+ * @param params - 下载资源信息
716
+ * @returns 调用结果
717
+ */
718
+ function downloadBatchSharedRes(params: BatchSharedRes[]): Promise<void>;
719
+ /**
720
+ * 判断共享资源是否存在
721
+ * @param params - 要判断的资源信息
722
+ * @returns 查询结果结果
723
+ */
724
+ function isSharedResExists(params: BatchSharedRes): Promise<ExistsResp>;
725
+ /**
726
+ * 清除下载资源
727
+ * @param params - 参数
728
+ * @returns 结果
729
+ */
730
+ function cleanRes(params: CleanResParams): Promise<void>;
731
+ /**
732
+ * 批量保存文件到本地
733
+ * @param params - 传入参数
734
+ * @returns 调用结果
735
+ */
736
+ function saveFiles(params: SaveFilesReq): Promise<void>;
737
+ /**
738
+ * 批量上传文件
739
+ * @param params - 参数
740
+ * @returns 结果
741
+ */
742
+ function uploadFiles(params: UploadFilesReq): Promise<void>;
743
+ /**
744
+ * 选择本地目录
745
+ * @param params - 传入参数
746
+ * @returns 调用结果
747
+ */
748
+ function selectDir(params: SelectDirReq): Promise<void>;
749
+ /**
750
+ * 拍摄或从手机相册中选择图片或视频
751
+ * @param params - 传入参数
752
+ * @returns 调用结果
753
+ */
754
+ function chooseMedia(params: ChooseMediaReq): Promise<void>;
755
+ }
756
+
757
+ /**
758
+ * 监听后台消息
759
+ */
760
+ namespace observer {
761
+ /**
762
+ * 监听后台消息
763
+ * @param topic - 消息名
764
+ * @param callback - 收到消息时回调 返回对应消息名的后台消息content
765
+ */
766
+ function on(topic: string, callback: (...params: any[]) => any): void;
767
+ /**
768
+ * 取消监听后台消息
769
+ * @param topic - 消息名
770
+ */
771
+ function off(topic: string, callback: (...params: any[]) => any): void;
772
+ /**
773
+ * 触发小程序消息
774
+ */
775
+ function emit(topic: string, message: string): Promise<any>;
776
+ /**
777
+ * 监听自身小程序消息
778
+ * @param params.eventName - 消息名
779
+ * @param params.callback - 回调
780
+ */
781
+ function onLocalMessage(params: {
782
+ eventName: string;
783
+ callback: (...params: any[]) => any;
784
+ }): void;
785
+ /**
786
+ * 取消监听自身小程序消息
787
+ * @param params.eventName - 消息名
788
+ */
789
+ function offLocalMessage(params: {
790
+ eventName: string;
791
+ }): void;
792
+ /**
793
+ * 发送小程序消息
794
+ * @param params.eventName - 消息名
795
+ * @param params.callback - 回调
796
+ */
797
+ function postLocalMessage(params: {
798
+ eventName: string;
799
+ callback: (...params: any[]) => any;
800
+ }): Promise<any>;
801
+ /**
802
+ * 监听后台消息
803
+ * @param topic - 消息名
804
+ * @param callback - 收到消息时回调 返回对应消息名的后台消息content
805
+ */
806
+ function on(topic: string, callback: (...params: any[]) => any): void;
807
+ /**
808
+ * 取消监听后台消息
809
+ * @param topic - 消息名
810
+ */
811
+ function off(topic: string, callback: (...params: any[]) => any): void;
812
+ /**
813
+ * 触发小程序消息
814
+ */
815
+ function emit(topic: string, message: string): Promise<any>;
816
+ /**
817
+ * 监听自身小程序消息
818
+ * @param params.eventName - 消息名
819
+ * @param params.callback - 回调
820
+ */
821
+ function onLocalMessage(params: {
822
+ eventName: string;
823
+ callback: (...params: any[]) => any;
824
+ }): void;
825
+ /**
826
+ * 取消监听自身小程序消息
827
+ * @param params.eventName - 消息名
828
+ */
829
+ function offLocalMessage(params: {
830
+ eventName: string;
831
+ }): void;
832
+ /**
833
+ * 发送小程序消息
834
+ * @param params.eventName - 消息名
835
+ * @param params.callback - 回调
836
+ */
837
+ function postLocalMessage(params: {
838
+ eventName: string;
839
+ callback: (...params: any[]) => any;
840
+ }): Promise<any>;
841
+ /**
842
+ * 广播开发者维度的本地消息
843
+ * @param params - 本地消息参数
844
+ * @returns 调用结果
845
+ */
846
+ function postDevelperLocalMessage(params: PostLocalMessageParams): Promise<void>;
847
+ /**
848
+ * 监听开发者维度的本地消息
849
+ * @param params - 参数
850
+ * @returns 调用结果
851
+ */
852
+ function onDeveloperLocalMessage(params: LocalMessageParams): Promise<void>;
853
+ /**
854
+ * 取消监听开发者维度的本地消息
855
+ * @param params - 参数
856
+ * @returns 调用结果
857
+ */
858
+ function offDeveloperLocalMessage(params: OffLocalMessageParams): Promise<void>;
859
+ }
860
+
861
+ /**
862
+ * 秩序
863
+ */
864
+ namespace order {
865
+ /**
866
+ * 发起小程序文本的秩序审核
867
+ * @param param - 参数
868
+ * @param param.text - 要检查的字符串
869
+ */
870
+ function reportText(param: {
871
+ text: string;
872
+ }): void;
873
+ /**
874
+ * 发起小程序文本的秩序审核
875
+ * @param param - 参数
876
+ * @param param.text - 要检查的字符串
877
+ */
878
+ function reportText(param: {
879
+ text: string;
880
+ }): void;
881
+ }
882
+
883
+ /**
884
+ * 面板
885
+ */
886
+ namespace panel {
887
+ /**
888
+ * 改变小程序面板的布局,包括显示位置和显示大小
889
+ * @param visible - 是否可见,默认true,
890
+ * @param res - 取值 'PLAYER'
891
+ * @param x - 横坐标
892
+ * @param y - 纵坐标
893
+ * @param width - 宽度
894
+ * @param height - 高度
895
+ */
896
+ function setLayout(visible: boolean, res: string, x: number, y: number, width: number, height: number): void;
897
+ /**
898
+ * 销毁当前小程序
899
+ */
900
+ function disposal(): void;
901
+ /**
902
+ * 改变小程序面板的布局,包括显示位置和显示大小
903
+ * @param visible - 是否可见,默认true,
904
+ * @param res - 取值 'PLAYER'
905
+ * @param x - 横坐标
906
+ * @param y - 纵坐标
907
+ * @param width - 宽度
908
+ * @param height - 高度
909
+ */
910
+ function setLayout(visible: boolean, res: string, x: number, y: number, width: number, height: number): void;
911
+ /**
912
+ * 销毁当前小程序
913
+ */
914
+ function disposal(): void;
915
+ /**
916
+ * 设置浮窗小程序的关闭按钮
917
+ * @param params - 设置关闭按钮参数
918
+ * @returns 设置结果
919
+ */
920
+ function setPopupCloseBtn(params: SetBtnParams): Promise<void>;
921
+ /**
922
+ * 设置面板类型小程序宽高
923
+ * @param params - 设置面板类型小程序宽高参数
924
+ * @returns 调用结果
925
+ */
926
+ function setPanelDimensions(params: SetPanelDimParams): Promise<void>;
927
+ }
928
+
929
+ namespace vip {
930
+ /**
931
+ * 获取小程序授权token
932
+ * @returns 返回小程序授权token
933
+ */
934
+ function getJWT(): Promise<object>;
935
+ /**
936
+ * 获取小程序授权token
937
+ * @returns 返回小程序授权token
938
+ */
939
+ function getJWT(): Promise<object>;
940
+ }
941
+
228
942
  /**
229
943
  * IEG上报
230
944
  */
@@ -1474,27 +2188,20 @@ namespace app {
1474
2188
  }
1475
2189
 
1476
2190
  /**
1477
- * 监听加载完成
2191
+ * 扩展加载完成回调
1478
2192
  * @param callback - 回调函数
1479
- * @returns 调用结果
1480
2193
  */
1481
2194
  function onLoad(callback: (...params: any[]) => any): void;
1482
2195
 
1483
- /**
1484
- * 监听取消加载
1485
- * @returns 调用结果
1486
- */
1487
2196
  function onUnload(callback: (...params: any[]) => any): void;
1488
2197
 
1489
2198
  /**
1490
2199
  * 注册App进入前台时回调
1491
- * @returns 调用结果
1492
2200
  */
1493
2201
  function onEnterForeground(callback: (...params: any[]) => any): void;
1494
2202
 
1495
2203
  /**
1496
2204
  * 注册App进入后台时回调
1497
- * @returns 调用结果
1498
2205
  */
1499
2206
  function onLeaveForeground(callback: (...params: any[]) => any): void;
1500
2207
 
@@ -1505,15 +2212,13 @@ type LifeCallback = () => void;
1505
2212
 
1506
2213
  /**
1507
2214
  * 小程序显示的生命周期
1508
- * @returns 调用结果
1509
2215
  */
1510
- function onAppear(callback: LifeCallback): void;
2216
+ function onAppear(callback: (...params: any[]) => any): void;
1511
2217
 
1512
2218
  /**
1513
2219
  * 小程序隐藏的生命周期
1514
- * @returns 调用结果
1515
2220
  */
1516
- function onDisappear(callback: LifeCallback): void;
2221
+ function onDisappear(callback: (...params: any[]) => any): void;
1517
2222
 
1518
2223
  /**
1519
2224
  * auth模块
@@ -1544,15 +2249,27 @@ type RequestAuthRsp = {
1544
2249
  };
1545
2250
 
1546
2251
  /**
1547
- * 后台模块
2252
+ * 后台
1548
2253
  */
1549
2254
  namespace backend {
1550
2255
  /**
1551
2256
  * 通用查询后台状态接口
1552
- * @param params - 参数
1553
- * @returns // key传入getServerTime参数时,返回GetServerTimeRsp,传入getPKInfo参数时, 返回GetPKInfoRsp
2257
+ * @param params.key - 关键字
2258
+ * @param params.param - 参数
1554
2259
  */
1555
- function commonQuery(params: SearchOptions): Promise<CommonQueryResp>;
2260
+ function commonQuery(params: {
2261
+ key: string;
2262
+ param: any;
2263
+ }): void;
2264
+ /**
2265
+ * 通用查询后台状态接口
2266
+ * @param params.key - 关键字
2267
+ * @param params.param - 参数
2268
+ */
2269
+ function commonQuery(params: {
2270
+ key: string;
2271
+ param: any;
2272
+ }): void;
1556
2273
  /**
1557
2274
  * 通用上行接口
1558
2275
  * @param params - 操作选项
@@ -1778,38 +2495,91 @@ type consts = Consts;
1778
2495
  namespace context {
1779
2496
  /**
1780
2497
  * 监听直播间消息
1781
- * @param topic - 宿主消息名, activated-小程序激活, subscribeSubmit-【观众端】当前观众订阅状态发生变化, giftSubmit-【观众端】当前观众送礼, barrageSubmit-当前用户发送弹幕, unzipProgress-每个任务的解压进度, userInteract-用户交互信息, openCoinPanelClosed-能量豆弹窗关闭, uiVisibilityStateChange-工具栏状态
2498
+ * @param topic - 消息名
1782
2499
  * @param callback - 收到消息时回调 返回消息内容
1783
- * @returns 调用结果
1784
2500
  */
1785
- function on(topic: string, callback: ContextOnCallback): void;
2501
+ function on(topic: string, callback: (...params: any[]) => any): void;
1786
2502
  /**
1787
2503
  * 取消监听直播间消息
1788
- * @param topic - 宿主消息名, activated-小程序激活, subscribeSubmit-【观众端】当前观众订阅状态发生变化, giftSubmit-【观众端】当前观众送礼, barrageSubmit-当前用户发送弹幕, unzipProgress-每个任务的解压进度, userInteract-用户交互信息, openCoinPanelClosed-能量豆弹窗关闭, uiVisibilityStateChange-工具栏状态
1789
- * @param [callback] - 收到消息时回调 返回消息内容
1790
- * @returns 调用结果
2504
+ * @param topic - 消息名
2505
+ * @param callback - 收到消息时回调 返回消息内容
2506
+ */
2507
+ function off(topic: string, callback: (...params: any[]) => any): void;
2508
+ /**
2509
+ * 获取用户信息,目前返回昵称、头像信息
2510
+ * @returns 返回用户信息,{ userNick, userAvatar }
2511
+ */
2512
+ function getUserInfo(): Promise<object>;
2513
+ /**
2514
+ * 获取安全区域的位置
2515
+ * @returns 返回安全区域位置 left, top, right, bottom
2516
+ */
2517
+ function getSafeAreaPosition(): Promise<object>;
2518
+ /**
2519
+ * 显示红点
2520
+ * @returns 返回是否显示成功
2521
+ */
2522
+ function showActivityBadge(): Promise<object>;
2523
+ /**
2524
+ * 显示toast
2525
+ * @param message - toast中显示的消息
2526
+ * @returns 返回toast是否显示成功
2527
+ */
2528
+ function showToast(message: string): Promise<object>;
2529
+ /**
2530
+ * 监听当前直播间小程序容器布局变化消息
2531
+ */
2532
+ function onLayoutChange(callback: LayoutChange): void;
2533
+ /**
2534
+ * 监听所有弹幕
2535
+ * @param options - 弹幕筛选
2536
+ * @param options.sendNick - 用户昵称关键字
2537
+ * @param options.content - 弹幕内容关键字
2538
+ * @param options.nobleLevel - 贵族等级
2539
+ * @param options.fansLevel - 粉丝等级
2540
+ */
2541
+ function onBarrageChange(options: {
2542
+ sendNick: string;
2543
+ content: string;
2544
+ nobleLevel: number;
2545
+ fansLevel: number;
2546
+ }, callback: BarrageCallback): void;
2547
+ /**
2548
+ * 关闭监听所有弹幕
2549
+ */
2550
+ function offBarrageChange(): void;
2551
+ /**
2552
+ * 监听直播间消息
2553
+ * @param topic - 消息名
2554
+ * @param callback - 收到消息时回调 返回消息内容
2555
+ */
2556
+ function on(topic: string, callback: (...params: any[]) => any): void;
2557
+ /**
2558
+ * 取消监听直播间消息
2559
+ * @param topic - 消息名
2560
+ * @param callback - 收到消息时回调 返回消息内容
1791
2561
  */
1792
- function off(topic: string, callback?: ContextOnCallback): void;
2562
+ function off(topic: string, callback: (...params: any[]) => any): void;
1793
2563
  /**
1794
- * 显示互动通道入口红点
2564
+ * 显示红点
1795
2565
  * @returns 返回是否显示成功
1796
2566
  */
1797
- function showActivityBadge(): Promise<void>;
2567
+ function showActivityBadge(): Promise<object>;
1798
2568
  /**
1799
2569
  * 显示toast
1800
2570
  * @param message - toast中显示的消息
2571
+ * @returns 返回toast是否显示成功
1801
2572
  */
1802
- function showToast(message: string): Promise<void>;
2573
+ function showToast(message: string): Promise<object>;
1803
2574
  /**
1804
2575
  * 获取安全区域的位置
1805
- * @returns 返回安全区域位置信息
2576
+ * @returns 返回安全区域位置 left, top, right, bottom
1806
2577
  */
1807
- function getSafeAreaPosition(): Promise<PositionInfo>;
2578
+ function getSafeAreaPosition(): Promise<object>;
1808
2579
  /**
1809
2580
  * 监听当前直播间小程序容器布局变化消息
1810
- * @param callback - 小程序容器布局变化回调
1811
2581
  */
1812
- function onLayoutChange(callback: LayoutChange): Promise<void>;
2582
+ function onLayoutChange(callback: LayoutChange): void;
1813
2583
  /**
1814
2584
  * 引导订阅
1815
2585
  */
@@ -1848,14 +2618,22 @@ namespace context {
1848
2618
  function leadBarrage(): Promise<void>;
1849
2619
  /**
1850
2620
  * 监听所有弹幕
1851
- * @param options - 弹幕筛选条件
1852
- * @param callback - 弹幕信息回调
1853
- */
1854
- function onBarrageChange(options: OnBarrageChangeOptions, callback: BarrageCallback): Promise<void>;
2621
+ * @param options - 弹幕筛选
2622
+ * @param options.sendNick - 用户昵称关键字
2623
+ * @param options.content - 弹幕内容关键字
2624
+ * @param options.nobleLevel - 贵族等级
2625
+ * @param options.fansLevel - 粉丝等级
2626
+ */
2627
+ function onBarrageChange(options: {
2628
+ sendNick: string;
2629
+ content: string;
2630
+ nobleLevel: number;
2631
+ fansLevel: number;
2632
+ }, callback: BarrageCallback): void;
1855
2633
  /**
1856
2634
  * 关闭监听所有弹幕
1857
2635
  */
1858
- function offBarrageChange(): Promise<void>;
2636
+ function offBarrageChange(): void;
1859
2637
  /**
1860
2638
  * 监听开通守护
1861
2639
  * @param params - 监听开通守护参数
@@ -1913,10 +2691,10 @@ namespace context {
1913
2691
  */
1914
2692
  function getLiveInfo(): Promise<RespLiveInfo>;
1915
2693
  /**
1916
- * 获取用户信息
1917
- * @returns 返回用户信息
2694
+ * 获取用户信息,目前返回昵称、头像信息
2695
+ * @returns 返回用户信息,{ userNick, userAvatar }
1918
2696
  */
1919
- function getUserInfo(): Promise<UserInfo>;
2697
+ function getUserInfo(): Promise<object>;
1920
2698
  /**
1921
2699
  * 获取直播间的粉丝榜信息
1922
2700
  * @returns 返回直播间粉丝榜信息
@@ -2011,7 +2789,6 @@ type PositionInfo = {
2011
2789
  };
2012
2790
 
2013
2791
  /**
2014
- * 容器变化消息
2015
2792
  * @property screenWidth - 容器宽度
2016
2793
  * @property screenHeight - 容器高度
2017
2794
  * @property isLandscape - 是否横屏,web端固定为true
@@ -2022,10 +2799,6 @@ type LayoutInfo = {
2022
2799
  isLandscape: boolean;
2023
2800
  };
2024
2801
 
2025
- /**
2026
- * 小程序容器布局变化回调
2027
- * @param info - 容器变化消息
2028
- */
2029
2802
  type LayoutChange = (info: LayoutInfo) => void;
2030
2803
 
2031
2804
  /**
@@ -2132,9 +2905,9 @@ type BarragerInfo = {
2132
2905
 
2133
2906
  /**
2134
2907
  * 弹幕信息回调
2135
- * @param barrageInfo - 弹幕消息
2908
+ * @param data - 参数
2136
2909
  */
2137
- type BarrageCallback = (barrageInfo: BarragerInfo) => void;
2910
+ type BarrageCallback = (data: BarrageData) => boolean;
2138
2911
 
2139
2912
  /**
2140
2913
  * 弹幕筛选条件
@@ -3252,29 +4025,47 @@ type FoldInfoRsp = {
3252
4025
  function requestEbs(options: any): void;
3253
4026
 
3254
4027
  /**
3255
- * 环境相关
4028
+ * 环境信息
3256
4029
  */
3257
4030
  namespace env {
3258
4031
  /**
3259
4032
  * 获取当前版本类型
3260
- * @returns 返回当前版本类型
3261
4033
  */
3262
- function getVersionType(): Promise<GetVersionTypeRsp>;
4034
+ function getVersionType(): Promise<VersionInfo>;
4035
+ /**
4036
+ * 获取初始化参数
4037
+ * @returns 初始化参数
4038
+ */
4039
+ function getInitialParam(): Promise<object>;
4040
+ /**
4041
+ * 获取小程序启动参数
4042
+ * @returns 小程序启动参数
4043
+ */
4044
+ function getExtInfo(): Promise<object>;
4045
+ /**
4046
+ * 获取宿主信息接口,使用querystring解析rn bundle的查询串参数,返回给小程序
4047
+ * @returns 宿主信息
4048
+ */
4049
+ function getHostInfo(): Promise<object>;
4050
+ /**
4051
+ * 获取当前版本类型
4052
+ */
4053
+ function getVersionType(): Promise<VersionInfo>;
3263
4054
  /**
3264
4055
  * 获取初始化参数
3265
4056
  * @returns 初始化参数
3266
4057
  */
3267
4058
  function getInitialParam(): Promise<object>;
3268
4059
  /**
3269
- * 获取小程序参数
3270
- * @returns 小程序参数
4060
+ * 获取小程序启动参数
4061
+ * @returns 小程序启动参数
3271
4062
  */
3272
- function getExtInfo(): Promise<GetExtInfoRsp>;
4063
+ function getExtInfo(): Promise<object>;
3273
4064
  /**
3274
- * 获取宿主信息接口
3275
- * @returns 返回宿主信息
4065
+ * 获取宿主信息接口,使用querystring解析rn bundle的查询串参数,返回给小程序
4066
+ * @returns 宿主信息
3276
4067
  */
3277
- function getHostInfo(): Promise<GetHostInfoRsp>;
4068
+ function getHostInfo(): Promise<object>;
3278
4069
  /**
3279
4070
  * 获取性能数据
3280
4071
  * @returns 调用结果
@@ -3620,16 +4411,27 @@ type FeedbackParams = {
3620
4411
  */
3621
4412
  namespace fs {
3622
4413
  /**
3623
- * 上传图片
3624
- * @returns 调用结果
4414
+ * 调取本地相册
3625
4415
  */
3626
- function uploadImg(): Promise<UrlInfo>;
4416
+ function uploadImg(): void;
3627
4417
  /**
3628
- * 离线资源是否下载完成
3629
- * @param params - 监听参数
3630
- * @returns 调用结果
4418
+ * 监听离线资源是否下载完成消息
4419
+ * @param params.url - 资源地址
4420
+ */
4421
+ function offlineFileReady(params: {
4422
+ url: string;
4423
+ }): Promise<string>;
4424
+ /**
4425
+ * 调取本地相册
4426
+ */
4427
+ function uploadImg(): void;
4428
+ /**
4429
+ * 监听离线资源是否下载完成消息
4430
+ * @param params.url - 资源地址
3631
4431
  */
3632
- function offlineFileReady(params: UrlInfo): Promise<void>;
4432
+ function offlineFileReady(params: {
4433
+ url: string;
4434
+ }): Promise<string>;
3633
4435
  /**
3634
4436
  * 通用上传文件接口
3635
4437
  * @returns 调用结果
@@ -4803,41 +5605,85 @@ type OBCallback = (content: any) => void;
4803
5605
  */
4804
5606
  namespace observer {
4805
5607
  /**
4806
- * 监听小程序消息
5608
+ * 监听后台消息
4807
5609
  * @param topic - 消息名
4808
5610
  * @param callback - 收到消息时回调 返回对应消息名的后台消息content
4809
- * @returns 调用结果
4810
5611
  */
4811
- function on(topic: string, callback: ObserverCallback): void;
5612
+ function on(topic: string, callback: (...params: any[]) => any): void;
4812
5613
  /**
4813
5614
  * 取消监听后台消息
4814
5615
  * @param topic - 消息名
4815
- * @param [callback] - 消息回调
4816
- * @returns 调用结果
4817
5616
  */
4818
- function off(topic: string, callback?: ObserverCallback): void;
5617
+ function off(topic: string, callback: (...params: any[]) => any): void;
4819
5618
  /**
4820
5619
  * 触发小程序消息
4821
- * @param topic - 小程序消息名
4822
- * @param message - 小程序消息内容
4823
5620
  */
4824
- function emit(topic: string, message: string): Promise<void>;
5621
+ function emit(topic: string, message: string): Promise<any>;
4825
5622
  /**
4826
- * 监听本地小程序消息
4827
- * @param params - 监听本地小程序参数
5623
+ * 监听自身小程序消息
5624
+ * @param params.eventName - 消息名
5625
+ * @param params.callback - 回调
4828
5626
  */
4829
- function onLocalMessage(params: LocalMessageParams): Promise<void>;
5627
+ function onLocalMessage(params: {
5628
+ eventName: string;
5629
+ callback: (...params: any[]) => any;
5630
+ }): void;
4830
5631
  /**
4831
5632
  * 取消监听自身小程序消息
4832
- * @param params - 取消监听参数
5633
+ * @param params.eventName - 消息名
4833
5634
  */
4834
- function offLocalMessage(params: OffLocalMessageParams): Promise<void>;
5635
+ function offLocalMessage(params: {
5636
+ eventName: string;
5637
+ }): void;
4835
5638
  /**
4836
- * 触发小程序本地消息
4837
- * @param params - 本地消息参数
4838
- * @returns 调用结果
5639
+ * 发送小程序消息
5640
+ * @param params.eventName - 消息名
5641
+ * @param params.callback - 回调
5642
+ */
5643
+ function postLocalMessage(params: {
5644
+ eventName: string;
5645
+ callback: (...params: any[]) => any;
5646
+ }): Promise<any>;
5647
+ /**
5648
+ * 监听后台消息
5649
+ * @param topic - 消息名
5650
+ * @param callback - 收到消息时回调 返回对应消息名的后台消息content
5651
+ */
5652
+ function on(topic: string, callback: (...params: any[]) => any): void;
5653
+ /**
5654
+ * 取消监听后台消息
5655
+ * @param topic - 消息名
5656
+ */
5657
+ function off(topic: string, callback: (...params: any[]) => any): void;
5658
+ /**
5659
+ * 触发小程序消息
5660
+ */
5661
+ function emit(topic: string, message: string): Promise<any>;
5662
+ /**
5663
+ * 监听自身小程序消息
5664
+ * @param params.eventName - 消息名
5665
+ * @param params.callback - 回调
5666
+ */
5667
+ function onLocalMessage(params: {
5668
+ eventName: string;
5669
+ callback: (...params: any[]) => any;
5670
+ }): void;
5671
+ /**
5672
+ * 取消监听自身小程序消息
5673
+ * @param params.eventName - 消息名
5674
+ */
5675
+ function offLocalMessage(params: {
5676
+ eventName: string;
5677
+ }): void;
5678
+ /**
5679
+ * 发送小程序消息
5680
+ * @param params.eventName - 消息名
5681
+ * @param params.callback - 回调
4839
5682
  */
4840
- function postLocalMessage(params: PostLocalMessageParams): Promise<void>;
5683
+ function postLocalMessage(params: {
5684
+ eventName: string;
5685
+ callback: (...params: any[]) => any;
5686
+ }): Promise<any>;
4841
5687
  /**
4842
5688
  * 广播开发者维度的本地消息
4843
5689
  * @param params - 本地消息参数
@@ -4899,15 +5745,25 @@ type PostLocalMessageParams = {
4899
5745
  };
4900
5746
 
4901
5747
  /**
4902
- * 秩序相关
5748
+ * 秩序
4903
5749
  */
4904
5750
  namespace order {
4905
5751
  /**
4906
5752
  * 发起小程序文本的秩序审核
4907
- * @param param - 文本秩序审核参数
4908
- * @returns 调用结果,reject为审核失败
5753
+ * @param param - 参数
5754
+ * @param param.text - 要检查的字符串
5755
+ */
5756
+ function reportText(param: {
5757
+ text: string;
5758
+ }): void;
5759
+ /**
5760
+ * 发起小程序文本的秩序审核
5761
+ * @param param - 参数
5762
+ * @param param.text - 要检查的字符串
4909
5763
  */
4910
- function reportText(param: ReportTextParams): Promise<void>;
5764
+ function reportText(param: {
5765
+ text: string;
5766
+ }): void;
4911
5767
  }
4912
5768
 
4913
5769
  /**
@@ -5276,16 +6132,33 @@ type OnInviteMessageParams = {
5276
6132
  */
5277
6133
  namespace panel {
5278
6134
  /**
5279
- * 设置小程序布局
5280
- * @param params - 布局信息
5281
- * @returns 调用结果
6135
+ * 改变小程序面板的布局,包括显示位置和显示大小
6136
+ * @param visible - 是否可见,默认true,
6137
+ * @param res - 取值 'PLAYER'
6138
+ * @param x - 横坐标
6139
+ * @param y - 纵坐标
6140
+ * @param width - 宽度
6141
+ * @param height - 高度
5282
6142
  */
5283
- function setLayout(params: LayoutData): Promise<void>;
6143
+ function setLayout(visible: boolean, res: string, x: number, y: number, width: number, height: number): void;
5284
6144
  /**
5285
- * 主动销毁当前小程序
5286
- * @returns 调用结果
6145
+ * 销毁当前小程序
6146
+ */
6147
+ function disposal(): void;
6148
+ /**
6149
+ * 改变小程序面板的布局,包括显示位置和显示大小
6150
+ * @param visible - 是否可见,默认true,
6151
+ * @param res - 取值 'PLAYER'
6152
+ * @param x - 横坐标
6153
+ * @param y - 纵坐标
6154
+ * @param width - 宽度
6155
+ * @param height - 高度
6156
+ */
6157
+ function setLayout(visible: boolean, res: string, x: number, y: number, width: number, height: number): void;
6158
+ /**
6159
+ * 销毁当前小程序
5287
6160
  */
5288
- function disposal(): Promise<void>;
6161
+ function disposal(): void;
5289
6162
  /**
5290
6163
  * 设置浮窗小程序的关闭按钮
5291
6164
  * @param params - 设置关闭按钮参数
@@ -8367,16 +9240,17 @@ type PopupParams = {
8367
9240
  param?: any;
8368
9241
  };
8369
9242
 
8370
- /**
8371
- * vip
8372
- */
8373
9243
  namespace vip {
8374
9244
  /**
8375
- * 获取当前用户Token
8376
- * @param [params] - 参数
8377
- * @returns 返回凭证信息
9245
+ * 获取小程序授权token
9246
+ * @returns 返回小程序授权token
9247
+ */
9248
+ function getJWT(): Promise<object>;
9249
+ /**
9250
+ * 获取小程序授权token
9251
+ * @returns 返回小程序授权token
8378
9252
  */
8379
- function getJWT(params?: GetJWTReq): Promise<JWTInfo>;
9253
+ function getJWT(): Promise<object>;
8380
9254
  }
8381
9255
 
8382
9256
  /**
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@hyext/types-ext-sdk-hy",
3
- "version": "3.14.3-beta.2",
4
- "description": "TypeScript definitions for @hyext/ext-sdk-hy",
3
+ "version": "3.14.4-beta.2",
4
+ "description": "TypeScript definitions for sdk",
5
5
  "types": "./index.d.ts",
6
6
  "main": "",
7
7
  "files": [