@xunlei-open/miniapp-types 0.1.1-beta.4 → 0.1.1-beta.6

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.
package/dist/index.d.cts CHANGED
@@ -438,7 +438,42 @@ export interface WebviewCookie {
438
438
  }
439
439
  /** 可直接执行的 JavaScript 字符串,或会被序列化到 WebView 中执行的函数。 */
440
440
  export type WebviewExecutable<T = unknown> = string | ((...args: unknown[]) => T | Promise<T>);
441
+ /** WebView 事件及其回调参数。导航和加载事件仅针对主页面,不包含 iframe。 */
442
+ export interface WebviewEventMap {
443
+ /** 实际地址发生变化,包含同一文档内的导航;不表示页面已加载完成。 */
444
+ "url-changed": {
445
+ url: string;
446
+ /** 是否为 hash、History API 等同一文档内的地址变化。 */
447
+ sameDocument: boolean;
448
+ };
449
+ /**
450
+ * 主页面触发 window.load,表示文档及阻塞 load 的资源已结束加载,不代表业务异步任务完成。
451
+ * 刷新页面会触发;仅 hash 或 History API 引起的同一文档内导航不触发。
452
+ */
453
+ "load": {
454
+ url: string;
455
+ };
456
+ /** 页面加载失败。 */
457
+ "load-error": {
458
+ url: string;
459
+ message: string;
460
+ };
461
+ /** 页面已关闭。 */
462
+ "closed": {
463
+ /** 用户关闭窗口,或通过 close() 关闭页面。 */
464
+ reason: "user" | "api";
465
+ };
466
+ }
467
+ /** 取消本次监听,可重复调用,页面关闭后调用也安全。 */
468
+ export type WebviewUnsubscribe = () => Promise<void>;
441
469
  export interface WebviewPage {
470
+ /**
471
+ * 注册事件监听;Promise 完成表示监听已就绪,并返回取消监听函数。
472
+ * 不回放当前状态;需要监听导航时,应在 goto() 前完成注册。
473
+ * 页面关闭时先通知 closed 监听器,再自动释放全部监听。
474
+ * 回调仅用于通知,不能阻止导航;宿主不等待异步回调,异步错误由调用方处理。
475
+ */
476
+ on<K extends keyof WebviewEventMap>(event: K, handler: (data: WebviewEventMap[K]) => void): Promise<WebviewUnsubscribe>;
442
477
  /** 在后续导航的页面上下文创建前注入脚本。 */
443
478
  addInitScript(script: string): Promise<void>;
444
479
  /** 导航到指定网址。 */
@@ -608,6 +643,51 @@ export interface XunleiRuntime {
608
643
  blob: XunleiRuntimeBlob;
609
644
  webview: XunleiRuntimeWebview;
610
645
  }
646
+ /** 宿主主题模式。 */
647
+ export type HostThemeMode = "light" | "dark";
648
+ /** 宿主环境信息查询接口,页面和事件脚本均可用。 */
649
+ export interface XunleiHostEnv {
650
+ /**
651
+ * 宿主默认下载目录,绝对路径。
652
+ * 用户在宿主中修改后,后续调用返回新值。
653
+ */
654
+ defaultDownloadDir(): Promise<string>;
655
+ /**
656
+ * 宿主当前主题模式;宿主设置为跟随系统时返回解析后的结果,不返回 auto。
657
+ * 主题变化后,后续调用返回新值。
658
+ */
659
+ themeMode(): Promise<HostThemeMode>;
660
+ }
661
+ export interface UiPickDirectoryOptions {
662
+ /** 对话框初始定位的目录,绝对路径;未指定时定位到宿主默认下载目录。 */
663
+ defaultPath?: string;
664
+ }
665
+ /** 目录选择结果。 */
666
+ export interface UiPickDirectoryResult {
667
+ /** 用户选择的目录绝对路径。 */
668
+ path: string;
669
+ }
670
+ export interface UiOpenTaskListOptions {
671
+ /** 跳转后高亮选中的任务标识;任务不存在或不可见时仅跳转,不高亮。 */
672
+ taskId?: string;
673
+ }
674
+ /** 宿主 UI 操作接口,仅微应用页面可用,事件脚本不注入。 */
675
+ export interface XunleiHostUi {
676
+ /** 打开宿主目录选择器;用户取消时返回 null,不视为错误。 */
677
+ pickDirectory(opts?: UiPickDirectoryOptions): Promise<UiPickDirectoryResult | null>;
678
+ /** 跳转到宿主任务列表页,可选高亮指定任务。 */
679
+ openTaskList(opts?: UiOpenTaskListOptions): Promise<void>;
680
+ }
681
+ /**
682
+ * 宿主环境与 UI 接口,与 info(微应用自身信息)相对。
683
+ * env 读宿主状态,页面和事件脚本均可用;ui 操作宿主界面,仅页面可用。
684
+ */
685
+ export interface XunleiHost {
686
+ /** 宿主环境信息。 */
687
+ env: XunleiHostEnv;
688
+ /** 宿主 UI 操作,仅页面可用。 */
689
+ ui: XunleiHostUi;
690
+ }
611
691
  export interface Xunlei {
612
692
  /** 微应用信息(只读)。 */
613
693
  info: XunleiInfo;
@@ -623,6 +703,8 @@ export interface Xunlei {
623
703
  events: XunleiEvents;
624
704
  /** 运行时能力接口。 */
625
705
  runtime: XunleiRuntime;
706
+ /** 宿主环境与 UI 接口。 */
707
+ host: XunleiHost;
626
708
  }
627
709
  export interface MiniappInfo {
628
710
  id: string;
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.cts","names":[],"sources":["../src/index.ts"],"mappings":";;iBAGiB;;EAEhB;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA,aAAa;;EAEb;;EAEA,QAAQ;;EAER,SAAS;;EAET,cAAc;;EAEd,UAAU;;EAEV,UAAU;;EAEV,WAAW;;YAGA;iBAWK;GACf;;EAED;;YAGW;iBAEK;;EAEhB,OAAO;;EAEP;;iBAGgB;EAChB;EACA;;iBAGgB;EAChB;EACA;;iBAGgB;EAChB,OAAO;EACP,QAAQ;EACR;;YAGW;YAMA;EACX;EACA;;YAGW;iBAEK;EAChB;EACA;EACA;EACA;EACA,QAAQ;EACR,UAAU;;iBAGM;EAChB;EACA,OAAO;;;YAMI;YAEA;;YASA;EACX;EACA;EACA;EACA;;iBAGgB;EAChB,SAAS;;YAGE,WAAW;iBAEN;;EAEhB;;EAEA,QAAQ;;EAER;KAAY;;;iBAGI,yBAAyB;;EAEzC,UAAU,QAAQ,yBAAyB;;EAE3C,SAAS,aAAa,gBAAgB;;EAEtC,SAAS,cAAc;;iBAGP;EAChB;;EAEA;;EAEA;;iBAGgB;;EAEhB;;EAEA;;EAEA,OAAO;;iBAGS;;EAEhB;;YAGW,YAAY;iBAEP;;EAEhB;;EAEA;;EAEA,QAAQ;;iBAGQ;;EAEhB;;EAEA;;EAEA;;iBAKgB;EAChB;;EAEA;;EAEA,UAAU;;EAEV;;EAEA;;IAEC,KAAK,KAAK;IACV,KAAK;;IAEL,MAAM,KAAK;;;EAGZ,QAAQ;;EAER,UAAU;;EAEV;;EAEA;;EAEA;;;YAIW,mBAAmB,OAAO;iBAErB,kBAAkB,KAAK;EACvC;;EAEA;IAAQ;IAAc;;;EAEtB,UAAU;;iBAGM;EAChB;EACA;;iBAGgB;;EAEhB;;;;;;iBAOgB,sBAAsB;EACtC,MAAM,KAAK;IACV,KAAK;;;EAGN,OAAO,cAAc;;iBAGL,6BAA6B;;EAE7C,YAAY;;iBAGI;EAChB,KAAK;EACL,OAAO;;;iBAIS;;EAEhB;;EAEA,OAAO;;EAEP,OAAO;;iBAGS;;EAEhB;;EAEA;;EAEA,SAAS,iBAAiB;;EAE1B;;iBAGgB;;EAEhB;;EAEA;;iBAGgB;EAChB;;iBAGgB;;EAEhB;;EAEA;;IAEC;OAAY;;;;iBAIG;EAChB;EACA;;iBAGgB;EAChB;EACA;;;YAMW;EACX,OAAO;EACP,OAAO;EACP,OAAO;EACP,KAAK;;;YAIM;EACX,OAAO;EACP,OAAO;EACP,OAAO;;;iBAIS;;EAEhB,KAAK;;EAEL,MAAM;;;iBAIU;;EAEhB,MAAM;;;iBAIU;;EAEhB,MAAM;;EAEN,OAAO;;;iBAIS;;EAEhB,MAAM;;YAKK,0BACX,KAAK,qBACD;YAEO,wBACX,KAAK,mBACD;YAEO,wBACX,KAAK,mBACD;YAEO,uBAAuB,KAAK,kBAAkB;;iBAKzC;;EAEhB;;EAEA;;EAEA;;EAEA;;EAEA;;;iBAIgB;EAChB,MAAM,sBAAsB;EAC5B,KAAK,sBAAsB;EAC3B,KAAK,sBAAsB;EAC3B,MAAM,sBAAsB;;;iBAIZ;;GAEf,cAAc;;;iBAIC;;;;EAIhB,IAAI,cAAc;;;;EAIlB,IAAI,aAAa,gBAAgB;;;;EAIjC,OAAO,cAAc;;;;EAIrB,SAAS;;;;EAIT,QAAQ;;;iBAIQ;;EAEhB,OAAO,OAAO,kBAAkB,QAAQ;;EAExC,YAAY,OAAO,uBAAuB,QAAQ;;EAElD,KAAK,QAAQ,gBAAgB,QAAQ;;EAErC,OAAO,OAAO,kBAAkB,QAAQ;;EAExC,OAAO,OAAO,kBAAkB,QAAQ;;EAExC,OAAO,OAAO,kBAAkB,QAAQ;;iBAGxB,2BAA2B;;EAE3C;;IAEC,OAAO,OAAO,sBAAsB,QAAQ;;;iBAI7B;;EAEhB,UAAU,SAAS;;EAEnB,QAAQ,SAAS;;EAEjB,QAAQ,SAAS;;EAEjB,OAAO,SAAS;;;iBAMA;;;;;EAKhB;;EAEA;;EAEA;;EAEA;;EAEA;;iBAGgB;;EAEhB;;EAEA;;iBAGgB;;EAEhB;;iBAGgB;;EAEhB;;iBAGgB;;EAEhB;;EAEA;;iBAGgB,sCAAsC;;EAEtD;;EAEA;;iBAGgB;;EAEhB;;EAEA;;EAEA;;EAEA;;EAEA,4BAA4B;;EAE5B;;EAEA;;;YAIW,kBAAkB,6BAEtB,oBAAoB,IAAI,QAAQ;iBAEvB;;EAEhB,cAAc,iBAAiB;;EAE/B,KAAK,aAAa,OAAO,qBAAqB;;EAE9C,QAAQ,aACP,YAAY,kBAAkB,OAC3B,kBACD,QAAQ;;EAEX,MAAM,mBAAmB;;EAEzB,MAAM,kBAAkB,OAAO,sBAAsB;;EAErD,KACC,kBACA,cACA,OAAO,qBACL;;EAEH,gBACC,kBACA,OAAO,gCACL;;EAEH,gBAAgB,aACf,YAAY,kBAAkB,OAC3B,kBACD,QAAQ;;EAEX,cAAc,QAAQ;;EAEtB,UAAU,QAAQ,gBAAgB;;EAElC,aAAa,QAAQ,gBAAgB;;EAErC,gBAAgB;;EAEhB,OAAO;;EAEP,WAAW;;EAEX,SAAS;;iBAGO;;EAEhB,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAkDf,KAAK,OAAO,qBAAqB,QAAQ;;iBAKzB;;EAEhB;;EAEA;;YAGW,cACX,SAAS,oBACL,eAAe,cAAc,QAAQ,eAAe;iBAExC;;EAEhB;;EAEA;;EAEA;;iBAGgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAsDhB,gBACC,QAAQ,OAAO,YACf,UAAU,uBACR;;;;;;;;;EASH,gBAAgB,cAAc;;iBAGd;EAChB,MAAM;EACN,SAAS;;iBAGO;;EAEhB,MAAM;;EAEN,QAAQ;;EAER,UAAU;;EAEV,SAAS;;EAET,OAAO;;EAEP,QAAQ;;EAER,SAAS;;iBAKO;EAChB;EACA;EACA;EACA;EACA,QAAQ;EACR;;YAGW,eAAe;;iBAGV;OACX,mBAAmB;GACvB,mBAAmB;;QAGb;QACD,QAAQ;QACR,cAAc"}
1
+ {"version":3,"file":"index.d.cts","names":[],"sources":["../src/index.ts"],"mappings":";;iBAGiB;;EAEhB;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA,aAAa;;EAEb;;EAEA,QAAQ;;EAER,SAAS;;EAET,cAAc;;EAEd,UAAU;;EAEV,UAAU;;EAEV,WAAW;;YAGA;iBAWK;GACf;;EAED;;YAGW;iBAEK;;EAEhB,OAAO;;EAEP;;iBAGgB;EAChB;EACA;;iBAGgB;EAChB;EACA;;iBAGgB;EAChB,OAAO;EACP,QAAQ;EACR;;YAGW;YAMA;EACX;EACA;;YAGW;iBAEK;EAChB;EACA;EACA;EACA;EACA,QAAQ;EACR,UAAU;;iBAGM;EAChB;EACA,OAAO;;;YAMI;YAEA;;YASA;EACX;EACA;EACA;EACA;;iBAGgB;EAChB,SAAS;;YAGE,WAAW;iBAEN;;EAEhB;;EAEA,QAAQ;;EAER;KAAY;;;iBAGI,yBAAyB;;EAEzC,UAAU,QAAQ,yBAAyB;;EAE3C,SAAS,aAAa,gBAAgB;;EAEtC,SAAS,cAAc;;iBAGP;EAChB;;EAEA;;EAEA;;iBAGgB;;EAEhB;;EAEA;;EAEA,OAAO;;iBAGS;;EAEhB;;YAGW,YAAY;iBAEP;;EAEhB;;EAEA;;EAEA,QAAQ;;iBAGQ;;EAEhB;;EAEA;;EAEA;;iBAKgB;EAChB;;EAEA;;EAEA,UAAU;;EAEV;;EAEA;;IAEC,KAAK,KAAK;IACV,KAAK;;IAEL,MAAM,KAAK;;;EAGZ,QAAQ;;EAER,UAAU;;EAEV;;EAEA;;EAEA;;;YAIW,mBAAmB,OAAO;iBAErB,kBAAkB,KAAK;EACvC;;EAEA;IAAQ;IAAc;;;EAEtB,UAAU;;iBAGM;EAChB;EACA;;iBAGgB;;EAEhB;;;;;;iBAOgB,sBAAsB;EACtC,MAAM,KAAK;IACV,KAAK;;;EAGN,OAAO,cAAc;;iBAGL,6BAA6B;;EAE7C,YAAY;;iBAGI;EAChB,KAAK;EACL,OAAO;;;iBAIS;;EAEhB;;EAEA,OAAO;;EAEP,OAAO;;iBAGS;;EAEhB;;EAEA;;EAEA,SAAS,iBAAiB;;EAE1B;;iBAGgB;;EAEhB;;EAEA;;iBAGgB;EAChB;;iBAGgB;;EAEhB;;EAEA;;IAEC;OAAY;;;;iBAIG;EAChB;EACA;;iBAGgB;EAChB;EACA;;;YAMW;EACX,OAAO;EACP,OAAO;EACP,OAAO;EACP,KAAK;;;YAIM;EACX,OAAO;EACP,OAAO;EACP,OAAO;;;iBAIS;;EAEhB,KAAK;;EAEL,MAAM;;;iBAIU;;EAEhB,MAAM;;;iBAIU;;EAEhB,MAAM;;EAEN,OAAO;;;iBAIS;;EAEhB,MAAM;;YAKK,0BACX,KAAK,qBACD;YAEO,wBACX,KAAK,mBACD;YAEO,wBACX,KAAK,mBACD;YAEO,uBAAuB,KAAK,kBAAkB;;iBAKzC;;EAEhB;;EAEA;;EAEA;;EAEA;;EAEA;;;iBAIgB;EAChB,MAAM,sBAAsB;EAC5B,KAAK,sBAAsB;EAC3B,KAAK,sBAAsB;EAC3B,MAAM,sBAAsB;;;iBAIZ;;GAEf,cAAc;;;iBAIC;;;;EAIhB,IAAI,cAAc;;;;EAIlB,IAAI,aAAa,gBAAgB;;;;EAIjC,OAAO,cAAc;;;;EAIrB,SAAS;;;;EAIT,QAAQ;;;iBAIQ;;EAEhB,OAAO,OAAO,kBAAkB,QAAQ;;EAExC,YAAY,OAAO,uBAAuB,QAAQ;;EAElD,KAAK,QAAQ,gBAAgB,QAAQ;;EAErC,OAAO,OAAO,kBAAkB,QAAQ;;EAExC,OAAO,OAAO,kBAAkB,QAAQ;;EAExC,OAAO,OAAO,kBAAkB,QAAQ;;iBAGxB,2BAA2B;;EAE3C;;IAEC,OAAO,OAAO,sBAAsB,QAAQ;;;iBAI7B;;EAEhB,UAAU,SAAS;;EAEnB,QAAQ,SAAS;;EAEjB,QAAQ,SAAS;;EAEjB,OAAO,SAAS;;;iBAMA;;;;;EAKhB;;EAEA;;EAEA;;EAEA;;EAEA;;iBAGgB;;EAEhB;;EAEA;;iBAGgB;;EAEhB;;iBAGgB;;EAEhB;;iBAGgB;;EAEhB;;EAEA;;iBAGgB,sCAAsC;;EAEtD;;EAEA;;iBAGgB;;EAEhB;;EAEA;;EAEA;;EAEA;;EAEA,4BAA4B;;EAE5B;;EAEA;;;YAIW,kBAAkB,6BAEtB,oBAAoB,IAAI,QAAQ;;iBAGvB;;EAEhB;IACC;;IAEA;;;;;;EAMD;IACC;;;EAGD;IACC;IACA;;;EAGD;;IAEC;;;;YAKU,2BAA2B;iBAEtB;;;;;;;EAOhB,GAAG,gBAAgB,iBAClB,OAAO,GACP,UAAU,MAAM,gBAAgB,cAC9B,QAAQ;;EAEX,cAAc,iBAAiB;;EAE/B,KAAK,aAAa,OAAO,qBAAqB;;EAE9C,QAAQ,aACP,YAAY,kBAAkB,OAC3B,kBACD,QAAQ;;EAEX,MAAM,mBAAmB;;EAEzB,MAAM,kBAAkB,OAAO,sBAAsB;;EAErD,KACC,kBACA,cACA,OAAO,qBACL;;EAEH,gBACC,kBACA,OAAO,gCACL;;EAEH,gBAAgB,aACf,YAAY,kBAAkB,OAC3B,kBACD,QAAQ;;EAEX,cAAc,QAAQ;;EAEtB,UAAU,QAAQ,gBAAgB;;EAElC,aAAa,QAAQ,gBAAgB;;EAErC,gBAAgB;;EAEhB,OAAO;;EAEP,WAAW;;EAEX,SAAS;;iBAGO;;EAEhB,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAkDf,KAAK,OAAO,qBAAqB,QAAQ;;iBAKzB;;EAEhB;;EAEA;;YAGW,cACX,SAAS,oBACL,eAAe,cAAc,QAAQ,eAAe;iBAExC;;EAEhB;;EAEA;;EAEA;;iBAGgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAsDhB,gBACC,QAAQ,OAAO,YACf,UAAU,uBACR;;;;;;;;;EASH,gBAAgB,cAAc;;iBAGd;EAChB,MAAM;EACN,SAAS;;;YAME;;iBAGK;;;;;EAKhB,sBAAsB;;;;;EAKtB,aAAa,QAAQ;;iBAGL;;EAEhB;;;iBAIgB;;EAEhB;;iBAGgB;;EAEhB;;;iBAIgB;;EAEhB,cACC,OAAO,yBACL,QAAQ;;EAEX,aAAa,OAAO,wBAAwB;;;;;;iBAO5B;;EAEhB,KAAK;;EAEL,IAAI;;iBAGY;;EAEhB,MAAM;;EAEN,QAAQ;;EAER,UAAU;;EAEV,SAAS;;EAET,OAAO;;EAEP,QAAQ;;EAER,SAAS;;EAET,MAAM;;iBAKU;EAChB;EACA;EACA;EACA;EACA,QAAQ;EACR;;YAGW,eAAe;;iBAGV;OACX,mBAAmB;GACvB,mBAAmB;;QAGb;QACD,QAAQ;QACR,cAAc"}
package/dist/index.d.mts CHANGED
@@ -438,7 +438,42 @@ export interface WebviewCookie {
438
438
  }
439
439
  /** 可直接执行的 JavaScript 字符串,或会被序列化到 WebView 中执行的函数。 */
440
440
  export type WebviewExecutable<T = unknown> = string | ((...args: unknown[]) => T | Promise<T>);
441
+ /** WebView 事件及其回调参数。导航和加载事件仅针对主页面,不包含 iframe。 */
442
+ export interface WebviewEventMap {
443
+ /** 实际地址发生变化,包含同一文档内的导航;不表示页面已加载完成。 */
444
+ "url-changed": {
445
+ url: string;
446
+ /** 是否为 hash、History API 等同一文档内的地址变化。 */
447
+ sameDocument: boolean;
448
+ };
449
+ /**
450
+ * 主页面触发 window.load,表示文档及阻塞 load 的资源已结束加载,不代表业务异步任务完成。
451
+ * 刷新页面会触发;仅 hash 或 History API 引起的同一文档内导航不触发。
452
+ */
453
+ "load": {
454
+ url: string;
455
+ };
456
+ /** 页面加载失败。 */
457
+ "load-error": {
458
+ url: string;
459
+ message: string;
460
+ };
461
+ /** 页面已关闭。 */
462
+ "closed": {
463
+ /** 用户关闭窗口,或通过 close() 关闭页面。 */
464
+ reason: "user" | "api";
465
+ };
466
+ }
467
+ /** 取消本次监听,可重复调用,页面关闭后调用也安全。 */
468
+ export type WebviewUnsubscribe = () => Promise<void>;
441
469
  export interface WebviewPage {
470
+ /**
471
+ * 注册事件监听;Promise 完成表示监听已就绪,并返回取消监听函数。
472
+ * 不回放当前状态;需要监听导航时,应在 goto() 前完成注册。
473
+ * 页面关闭时先通知 closed 监听器,再自动释放全部监听。
474
+ * 回调仅用于通知,不能阻止导航;宿主不等待异步回调,异步错误由调用方处理。
475
+ */
476
+ on<K extends keyof WebviewEventMap>(event: K, handler: (data: WebviewEventMap[K]) => void): Promise<WebviewUnsubscribe>;
442
477
  /** 在后续导航的页面上下文创建前注入脚本。 */
443
478
  addInitScript(script: string): Promise<void>;
444
479
  /** 导航到指定网址。 */
@@ -608,6 +643,51 @@ export interface XunleiRuntime {
608
643
  blob: XunleiRuntimeBlob;
609
644
  webview: XunleiRuntimeWebview;
610
645
  }
646
+ /** 宿主主题模式。 */
647
+ export type HostThemeMode = "light" | "dark";
648
+ /** 宿主环境信息查询接口,页面和事件脚本均可用。 */
649
+ export interface XunleiHostEnv {
650
+ /**
651
+ * 宿主默认下载目录,绝对路径。
652
+ * 用户在宿主中修改后,后续调用返回新值。
653
+ */
654
+ defaultDownloadDir(): Promise<string>;
655
+ /**
656
+ * 宿主当前主题模式;宿主设置为跟随系统时返回解析后的结果,不返回 auto。
657
+ * 主题变化后,后续调用返回新值。
658
+ */
659
+ themeMode(): Promise<HostThemeMode>;
660
+ }
661
+ export interface UiPickDirectoryOptions {
662
+ /** 对话框初始定位的目录,绝对路径;未指定时定位到宿主默认下载目录。 */
663
+ defaultPath?: string;
664
+ }
665
+ /** 目录选择结果。 */
666
+ export interface UiPickDirectoryResult {
667
+ /** 用户选择的目录绝对路径。 */
668
+ path: string;
669
+ }
670
+ export interface UiOpenTaskListOptions {
671
+ /** 跳转后高亮选中的任务标识;任务不存在或不可见时仅跳转,不高亮。 */
672
+ taskId?: string;
673
+ }
674
+ /** 宿主 UI 操作接口,仅微应用页面可用,事件脚本不注入。 */
675
+ export interface XunleiHostUi {
676
+ /** 打开宿主目录选择器;用户取消时返回 null,不视为错误。 */
677
+ pickDirectory(opts?: UiPickDirectoryOptions): Promise<UiPickDirectoryResult | null>;
678
+ /** 跳转到宿主任务列表页,可选高亮指定任务。 */
679
+ openTaskList(opts?: UiOpenTaskListOptions): Promise<void>;
680
+ }
681
+ /**
682
+ * 宿主环境与 UI 接口,与 info(微应用自身信息)相对。
683
+ * env 读宿主状态,页面和事件脚本均可用;ui 操作宿主界面,仅页面可用。
684
+ */
685
+ export interface XunleiHost {
686
+ /** 宿主环境信息。 */
687
+ env: XunleiHostEnv;
688
+ /** 宿主 UI 操作,仅页面可用。 */
689
+ ui: XunleiHostUi;
690
+ }
611
691
  export interface Xunlei {
612
692
  /** 微应用信息(只读)。 */
613
693
  info: XunleiInfo;
@@ -623,6 +703,8 @@ export interface Xunlei {
623
703
  events: XunleiEvents;
624
704
  /** 运行时能力接口。 */
625
705
  runtime: XunleiRuntime;
706
+ /** 宿主环境与 UI 接口。 */
707
+ host: XunleiHost;
626
708
  }
627
709
  export interface MiniappInfo {
628
710
  id: string;
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"mappings":";;iBAGiB;;EAEhB;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA,aAAa;;EAEb;;EAEA,QAAQ;;EAER,SAAS;;EAET,cAAc;;EAEd,UAAU;;EAEV,UAAU;;EAEV,WAAW;;YAGA;iBAWK;GACf;;EAED;;YAGW;iBAEK;;EAEhB,OAAO;;EAEP;;iBAGgB;EAChB;EACA;;iBAGgB;EAChB;EACA;;iBAGgB;EAChB,OAAO;EACP,QAAQ;EACR;;YAGW;YAMA;EACX;EACA;;YAGW;iBAEK;EAChB;EACA;EACA;EACA;EACA,QAAQ;EACR,UAAU;;iBAGM;EAChB;EACA,OAAO;;;YAMI;YAEA;;YASA;EACX;EACA;EACA;EACA;;iBAGgB;EAChB,SAAS;;YAGE,WAAW;iBAEN;;EAEhB;;EAEA,QAAQ;;EAER;KAAY;;;iBAGI,yBAAyB;;EAEzC,UAAU,QAAQ,yBAAyB;;EAE3C,SAAS,aAAa,gBAAgB;;EAEtC,SAAS,cAAc;;iBAGP;EAChB;;EAEA;;EAEA;;iBAGgB;;EAEhB;;EAEA;;EAEA,OAAO;;iBAGS;;EAEhB;;YAGW,YAAY;iBAEP;;EAEhB;;EAEA;;EAEA,QAAQ;;iBAGQ;;EAEhB;;EAEA;;EAEA;;iBAKgB;EAChB;;EAEA;;EAEA,UAAU;;EAEV;;EAEA;;IAEC,KAAK,KAAK;IACV,KAAK;;IAEL,MAAM,KAAK;;;EAGZ,QAAQ;;EAER,UAAU;;EAEV;;EAEA;;EAEA;;;YAIW,mBAAmB,OAAO;iBAErB,kBAAkB,KAAK;EACvC;;EAEA;IAAQ;IAAc;;;EAEtB,UAAU;;iBAGM;EAChB;EACA;;iBAGgB;;EAEhB;;;;;;iBAOgB,sBAAsB;EACtC,MAAM,KAAK;IACV,KAAK;;;EAGN,OAAO,cAAc;;iBAGL,6BAA6B;;EAE7C,YAAY;;iBAGI;EAChB,KAAK;EACL,OAAO;;;iBAIS;;EAEhB;;EAEA,OAAO;;EAEP,OAAO;;iBAGS;;EAEhB;;EAEA;;EAEA,SAAS,iBAAiB;;EAE1B;;iBAGgB;;EAEhB;;EAEA;;iBAGgB;EAChB;;iBAGgB;;EAEhB;;EAEA;;IAEC;OAAY;;;;iBAIG;EAChB;EACA;;iBAGgB;EAChB;EACA;;;YAMW;EACX,OAAO;EACP,OAAO;EACP,OAAO;EACP,KAAK;;;YAIM;EACX,OAAO;EACP,OAAO;EACP,OAAO;;;iBAIS;;EAEhB,KAAK;;EAEL,MAAM;;;iBAIU;;EAEhB,MAAM;;;iBAIU;;EAEhB,MAAM;;EAEN,OAAO;;;iBAIS;;EAEhB,MAAM;;YAKK,0BACX,KAAK,qBACD;YAEO,wBACX,KAAK,mBACD;YAEO,wBACX,KAAK,mBACD;YAEO,uBAAuB,KAAK,kBAAkB;;iBAKzC;;EAEhB;;EAEA;;EAEA;;EAEA;;EAEA;;;iBAIgB;EAChB,MAAM,sBAAsB;EAC5B,KAAK,sBAAsB;EAC3B,KAAK,sBAAsB;EAC3B,MAAM,sBAAsB;;;iBAIZ;;GAEf,cAAc;;;iBAIC;;;;EAIhB,IAAI,cAAc;;;;EAIlB,IAAI,aAAa,gBAAgB;;;;EAIjC,OAAO,cAAc;;;;EAIrB,SAAS;;;;EAIT,QAAQ;;;iBAIQ;;EAEhB,OAAO,OAAO,kBAAkB,QAAQ;;EAExC,YAAY,OAAO,uBAAuB,QAAQ;;EAElD,KAAK,QAAQ,gBAAgB,QAAQ;;EAErC,OAAO,OAAO,kBAAkB,QAAQ;;EAExC,OAAO,OAAO,kBAAkB,QAAQ;;EAExC,OAAO,OAAO,kBAAkB,QAAQ;;iBAGxB,2BAA2B;;EAE3C;;IAEC,OAAO,OAAO,sBAAsB,QAAQ;;;iBAI7B;;EAEhB,UAAU,SAAS;;EAEnB,QAAQ,SAAS;;EAEjB,QAAQ,SAAS;;EAEjB,OAAO,SAAS;;;iBAMA;;;;;EAKhB;;EAEA;;EAEA;;EAEA;;EAEA;;iBAGgB;;EAEhB;;EAEA;;iBAGgB;;EAEhB;;iBAGgB;;EAEhB;;iBAGgB;;EAEhB;;EAEA;;iBAGgB,sCAAsC;;EAEtD;;EAEA;;iBAGgB;;EAEhB;;EAEA;;EAEA;;EAEA;;EAEA,4BAA4B;;EAE5B;;EAEA;;;YAIW,kBAAkB,6BAEtB,oBAAoB,IAAI,QAAQ;iBAEvB;;EAEhB,cAAc,iBAAiB;;EAE/B,KAAK,aAAa,OAAO,qBAAqB;;EAE9C,QAAQ,aACP,YAAY,kBAAkB,OAC3B,kBACD,QAAQ;;EAEX,MAAM,mBAAmB;;EAEzB,MAAM,kBAAkB,OAAO,sBAAsB;;EAErD,KACC,kBACA,cACA,OAAO,qBACL;;EAEH,gBACC,kBACA,OAAO,gCACL;;EAEH,gBAAgB,aACf,YAAY,kBAAkB,OAC3B,kBACD,QAAQ;;EAEX,cAAc,QAAQ;;EAEtB,UAAU,QAAQ,gBAAgB;;EAElC,aAAa,QAAQ,gBAAgB;;EAErC,gBAAgB;;EAEhB,OAAO;;EAEP,WAAW;;EAEX,SAAS;;iBAGO;;EAEhB,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAkDf,KAAK,OAAO,qBAAqB,QAAQ;;iBAKzB;;EAEhB;;EAEA;;YAGW,cACX,SAAS,oBACL,eAAe,cAAc,QAAQ,eAAe;iBAExC;;EAEhB;;EAEA;;EAEA;;iBAGgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAsDhB,gBACC,QAAQ,OAAO,YACf,UAAU,uBACR;;;;;;;;;EASH,gBAAgB,cAAc;;iBAGd;EAChB,MAAM;EACN,SAAS;;iBAGO;;EAEhB,MAAM;;EAEN,QAAQ;;EAER,UAAU;;EAEV,SAAS;;EAET,OAAO;;EAEP,QAAQ;;EAER,SAAS;;iBAKO;EAChB;EACA;EACA;EACA;EACA,QAAQ;EACR;;YAGW,eAAe;;iBAGV;OACX,mBAAmB;GACvB,mBAAmB;;QAGb;QACD,QAAQ;QACR,cAAc"}
1
+ {"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"mappings":";;iBAGiB;;EAEhB;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA;;EAEA,aAAa;;EAEb;;EAEA,QAAQ;;EAER,SAAS;;EAET,cAAc;;EAEd,UAAU;;EAEV,UAAU;;EAEV,WAAW;;YAGA;iBAWK;GACf;;EAED;;YAGW;iBAEK;;EAEhB,OAAO;;EAEP;;iBAGgB;EAChB;EACA;;iBAGgB;EAChB;EACA;;iBAGgB;EAChB,OAAO;EACP,QAAQ;EACR;;YAGW;YAMA;EACX;EACA;;YAGW;iBAEK;EAChB;EACA;EACA;EACA;EACA,QAAQ;EACR,UAAU;;iBAGM;EAChB;EACA,OAAO;;;YAMI;YAEA;;YASA;EACX;EACA;EACA;EACA;;iBAGgB;EAChB,SAAS;;YAGE,WAAW;iBAEN;;EAEhB;;EAEA,QAAQ;;EAER;KAAY;;;iBAGI,yBAAyB;;EAEzC,UAAU,QAAQ,yBAAyB;;EAE3C,SAAS,aAAa,gBAAgB;;EAEtC,SAAS,cAAc;;iBAGP;EAChB;;EAEA;;EAEA;;iBAGgB;;EAEhB;;EAEA;;EAEA,OAAO;;iBAGS;;EAEhB;;YAGW,YAAY;iBAEP;;EAEhB;;EAEA;;EAEA,QAAQ;;iBAGQ;;EAEhB;;EAEA;;EAEA;;iBAKgB;EAChB;;EAEA;;EAEA,UAAU;;EAEV;;EAEA;;IAEC,KAAK,KAAK;IACV,KAAK;;IAEL,MAAM,KAAK;;;EAGZ,QAAQ;;EAER,UAAU;;EAEV;;EAEA;;EAEA;;;YAIW,mBAAmB,OAAO;iBAErB,kBAAkB,KAAK;EACvC;;EAEA;IAAQ;IAAc;;;EAEtB,UAAU;;iBAGM;EAChB;EACA;;iBAGgB;;EAEhB;;;;;;iBAOgB,sBAAsB;EACtC,MAAM,KAAK;IACV,KAAK;;;EAGN,OAAO,cAAc;;iBAGL,6BAA6B;;EAE7C,YAAY;;iBAGI;EAChB,KAAK;EACL,OAAO;;;iBAIS;;EAEhB;;EAEA,OAAO;;EAEP,OAAO;;iBAGS;;EAEhB;;EAEA;;EAEA,SAAS,iBAAiB;;EAE1B;;iBAGgB;;EAEhB;;EAEA;;iBAGgB;EAChB;;iBAGgB;;EAEhB;;EAEA;;IAEC;OAAY;;;;iBAIG;EAChB;EACA;;iBAGgB;EAChB;EACA;;;YAMW;EACX,OAAO;EACP,OAAO;EACP,OAAO;EACP,KAAK;;;YAIM;EACX,OAAO;EACP,OAAO;EACP,OAAO;;;iBAIS;;EAEhB,KAAK;;EAEL,MAAM;;;iBAIU;;EAEhB,MAAM;;;iBAIU;;EAEhB,MAAM;;EAEN,OAAO;;;iBAIS;;EAEhB,MAAM;;YAKK,0BACX,KAAK,qBACD;YAEO,wBACX,KAAK,mBACD;YAEO,wBACX,KAAK,mBACD;YAEO,uBAAuB,KAAK,kBAAkB;;iBAKzC;;EAEhB;;EAEA;;EAEA;;EAEA;;EAEA;;;iBAIgB;EAChB,MAAM,sBAAsB;EAC5B,KAAK,sBAAsB;EAC3B,KAAK,sBAAsB;EAC3B,MAAM,sBAAsB;;;iBAIZ;;GAEf,cAAc;;;iBAIC;;;;EAIhB,IAAI,cAAc;;;;EAIlB,IAAI,aAAa,gBAAgB;;;;EAIjC,OAAO,cAAc;;;;EAIrB,SAAS;;;;EAIT,QAAQ;;;iBAIQ;;EAEhB,OAAO,OAAO,kBAAkB,QAAQ;;EAExC,YAAY,OAAO,uBAAuB,QAAQ;;EAElD,KAAK,QAAQ,gBAAgB,QAAQ;;EAErC,OAAO,OAAO,kBAAkB,QAAQ;;EAExC,OAAO,OAAO,kBAAkB,QAAQ;;EAExC,OAAO,OAAO,kBAAkB,QAAQ;;iBAGxB,2BAA2B;;EAE3C;;IAEC,OAAO,OAAO,sBAAsB,QAAQ;;;iBAI7B;;EAEhB,UAAU,SAAS;;EAEnB,QAAQ,SAAS;;EAEjB,QAAQ,SAAS;;EAEjB,OAAO,SAAS;;;iBAMA;;;;;EAKhB;;EAEA;;EAEA;;EAEA;;EAEA;;iBAGgB;;EAEhB;;EAEA;;iBAGgB;;EAEhB;;iBAGgB;;EAEhB;;iBAGgB;;EAEhB;;EAEA;;iBAGgB,sCAAsC;;EAEtD;;EAEA;;iBAGgB;;EAEhB;;EAEA;;EAEA;;EAEA;;EAEA,4BAA4B;;EAE5B;;EAEA;;;YAIW,kBAAkB,6BAEtB,oBAAoB,IAAI,QAAQ;;iBAGvB;;EAEhB;IACC;;IAEA;;;;;;EAMD;IACC;;;EAGD;IACC;IACA;;;EAGD;;IAEC;;;;YAKU,2BAA2B;iBAEtB;;;;;;;EAOhB,GAAG,gBAAgB,iBAClB,OAAO,GACP,UAAU,MAAM,gBAAgB,cAC9B,QAAQ;;EAEX,cAAc,iBAAiB;;EAE/B,KAAK,aAAa,OAAO,qBAAqB;;EAE9C,QAAQ,aACP,YAAY,kBAAkB,OAC3B,kBACD,QAAQ;;EAEX,MAAM,mBAAmB;;EAEzB,MAAM,kBAAkB,OAAO,sBAAsB;;EAErD,KACC,kBACA,cACA,OAAO,qBACL;;EAEH,gBACC,kBACA,OAAO,gCACL;;EAEH,gBAAgB,aACf,YAAY,kBAAkB,OAC3B,kBACD,QAAQ;;EAEX,cAAc,QAAQ;;EAEtB,UAAU,QAAQ,gBAAgB;;EAElC,aAAa,QAAQ,gBAAgB;;EAErC,gBAAgB;;EAEhB,OAAO;;EAEP,WAAW;;EAEX,SAAS;;iBAGO;;EAEhB,eAAe;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAkDf,KAAK,OAAO,qBAAqB,QAAQ;;iBAKzB;;EAEhB;;EAEA;;YAGW,cACX,SAAS,oBACL,eAAe,cAAc,QAAQ,eAAe;iBAExC;;EAEhB;;EAEA;;EAEA;;iBAGgB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAsDhB,gBACC,QAAQ,OAAO,YACf,UAAU,uBACR;;;;;;;;;EASH,gBAAgB,cAAc;;iBAGd;EAChB,MAAM;EACN,SAAS;;;YAME;;iBAGK;;;;;EAKhB,sBAAsB;;;;;EAKtB,aAAa,QAAQ;;iBAGL;;EAEhB;;;iBAIgB;;EAEhB;;iBAGgB;;EAEhB;;;iBAIgB;;EAEhB,cACC,OAAO,yBACL,QAAQ;;EAEX,aAAa,OAAO,wBAAwB;;;;;;iBAO5B;;EAEhB,KAAK;;EAEL,IAAI;;iBAGY;;EAEhB,MAAM;;EAEN,QAAQ;;EAER,UAAU;;EAEV,SAAS;;EAET,OAAO;;EAEP,QAAQ;;EAER,SAAS;;EAET,MAAM;;iBAKU;EAChB;EACA;EACA;EACA;EACA,QAAQ;EACR;;YAGW,eAAe;;iBAGV;OACX,mBAAmB;GACvB,mBAAmB;;QAGb;QACD,QAAQ;QACR,cAAc"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xunlei-open/miniapp-types",
3
- "version": "0.1.1-beta.4",
3
+ "version": "0.1.1-beta.6",
4
4
  "description": "TypeScript definitions for the Xunlei Miniapp manifest and runtime APIs",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",