@quicktvui/qtx 0.9.0-alpha.1 → 0.9.0-alpha.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.
@@ -0,0 +1,119 @@
1
+ /** qtx 统一(主)插件包名 */
2
+ export declare const QTX_PLUGIN_PKG = "com.quicktvui.plugin.qtx";
3
+ /** 插件入口类(宿主 callReflect 调用其 setup());能力域按 `${pkg}.QtxPluginApp` 同一约定派生 */
4
+ export declare const QTX_PLUGIN_INIT_CLASS = "com.quicktvui.plugin.qtx.QtxPluginApp";
5
+ /** JS 侧要求的最低指令协议版本(与 GridTabsSDUI.md 同步;仅 core 分支校验,协议 §3) */
6
+ export declare const QTX_MIN_PROTOCOL_VERSION = "1.28.0";
7
+ /**
8
+ * 能力域描述。能力域(qtx.file 等)由 qtx-cli generate 按
9
+ * android/qtx-<name>/capability.json 写入注册表(minVersion 与类型同源,禁止手改);
10
+ * 主插件同轨域(core + dogfood 四模块)为内建手写条目。
11
+ */
12
+ export interface QtxCapabilitySpec {
13
+ /** JS 命名空间段,如 'file';子域用点号,如 'config.gridTabs' */
14
+ ns: string;
15
+ /** 插件 APK 包名,如 'com.quicktvui.plugin.qtx.file' */
16
+ pkg: string;
17
+ /** 原生主模块名(Proxy 方法直连目标),如 'QtxFileModule' */
18
+ module: string;
19
+ /** 原生版本模块名(就绪探测 + 版本协商),如 'QtxFileVersionModule' */
20
+ versionModule: string;
21
+ /** JS 侧要求的最低插件版本(域轨 semver);空串 = 随主插件轨(编译期注入) */
22
+ minVersion: string;
23
+ /** 可选子模块(ns 内多模块分发时登记,供诊断与文档) */
24
+ subModules?: Record<string, string>;
25
+ }
26
+ /** 能力域版本信息(各域版本模块 getVersionInfo 的返回;core 分支另含 protocolVersion/components) */
27
+ export interface QtxCapabilityVersionInfo {
28
+ pluginVersion: string;
29
+ /** 仅主插件轨返回 */
30
+ protocolVersion?: string;
31
+ /** 仅主插件轨返回 */
32
+ components?: Record<string, string>;
33
+ mode: 'plugin' | 'embedded';
34
+ }
35
+ /** ensureCapability 选项(installQtx 的 InstallQtxOptions 在 core 包装层映射到此) */
36
+ export interface EnsureCapabilityOptions {
37
+ /** 覆盖注册表 minVersion 的最低插件版本 */
38
+ minVersion?: string;
39
+ /** 仅 core:兼容的最低指令协议版本 */
40
+ minProtocolVersion?: string;
41
+ /** auto=缺失/过期时驱动宿主插件管理器下载安装;manual=只报错不动作 */
42
+ upgrade?: 'auto' | 'manual';
43
+ /** 单次安装超时(毫秒),默认 8000 */
44
+ timeout?: number;
45
+ }
46
+ /**
47
+ * 引导层错误。`capability` 标明哪个命名空间的引导失败(core 向后兼容:默认 'core'),
48
+ * 错误信息指明插件包名与两侧版本号(协议 §4.3)。
49
+ */
50
+ export declare class QtxInstallError extends Error {
51
+ code: 'PROBE_FAILED' | 'INSTALL_FAILED' | 'VERSION_TOO_LOW' | 'PROTOCOL_MISMATCH' | 'TIMEOUT' | 'UNKNOWN_CAPABILITY';
52
+ capability: string;
53
+ detail?: Partial<QtxCapabilityVersionInfo> & {
54
+ minPluginVersion?: string;
55
+ minProtocolVersion?: string;
56
+ };
57
+ constructor(code: QtxInstallError['code'], message: string, detail?: QtxInstallError['detail'], capability?: string);
58
+ }
59
+ /** 协议 §2 保留命名空间:主插件自身模块与列表族命令式 API 专用,能力域不得占用 */
60
+ export declare const RESERVED_NAMESPACE_ROOTS: readonly string[];
61
+ /** 宽松 semver 比较(actual >= required) */
62
+ export declare function isVersionAtLeast(actual: string, required: string): boolean;
63
+ /** 能力注册表(只读视图;内建条目 + generate 产出的能力域条目) */
64
+ export declare const CAPABILITIES: ReadonlyMap<string, QtxCapabilitySpec>;
65
+ /**
66
+ * 注册能力域(qtx-cli generate 产物的入口;也可用于宿主侧扩展)。
67
+ * 校验:ns 格式合法、根段不占用保留命名空间、字段齐全、minVersion 为字面量(与类型同源)。
68
+ */
69
+ export declare function registerCapability(spec: QtxCapabilitySpec): QtxCapabilitySpec;
70
+ /** 取能力域 spec(不存在返回 null) */
71
+ export declare function getCapabilitySpec(ns: string): QtxCapabilitySpec | null;
72
+ /**
73
+ * 引导某能力域(幂等单例,可重试——失败后再次调用会重新走流程)。
74
+ * `qtx.<ns>.*` 首调自动触发;一般无需手动调用。
75
+ */
76
+ export declare function ensureCapability(ns: string, options?: EnsureCapabilityOptions): Promise<QtxCapabilityVersionInfo>;
77
+ /** 当前就绪状态快照(同步,不触发引导) */
78
+ export declare function getCapabilityInfo(ns: string): QtxCapabilityVersionInfo | null;
79
+ /** 命名空间保留字(Proxy 特判,不透传原生) */
80
+ export interface QtxCapabilityReservedMethods {
81
+ /** 触发(或等待)引导完成,返回版本信息 */
82
+ ready(): Promise<QtxCapabilityVersionInfo>;
83
+ /** 只触发引导(预热),完成即返回 */
84
+ preheat(): Promise<void>;
85
+ /** 当前就绪信息快照(同步,未就绪为 null,不触发引导) */
86
+ getInfo(): QtxCapabilityVersionInfo | null;
87
+ }
88
+ /**
89
+ * 定义能力命名空间代理:`qtx.<ns>.<method>(...)` → `await ensureCapability(ns)` →
90
+ * `callNativeWithPromise(spec.module, method, ...args)`。保留字特判;thenable / JSON
91
+ * 序列化安全。方法函数按属性名缓存(同名取回同引用)。
92
+ */
93
+ export declare function defineCapability<M extends object = Record<string, (...args: any[]) => any>>(ns: string): QtxCapabilityReservedMethods & M;
94
+ /** qtx.version 方法面(主插件版本信息,只读诊断) */
95
+ export interface QtxVersionMethods {
96
+ /** 获取插件 / 内嵌版本信息(pluginVersion / protocolVersion / components / mode) */
97
+ getVersionInfo(): Promise<QtxCapabilityVersionInfo>;
98
+ }
99
+ /** qtx.env 方法面(宿主内建模块清单,只读诊断) */
100
+ export interface QtxEnvMethods {
101
+ /** 获取宿主内建(embedded)模块版本清单:模块名 → 版本串 */
102
+ getBuiltInVersions(): Promise<Record<string, string>>;
103
+ }
104
+ /** qtx.config.gridTabs 方法面(GridTabs 全局兜底配置) */
105
+ export interface QtxConfigGridTabsMethods {
106
+ /** 设置全局兜底配置(themeConfig / loadingConfig 等;对象入参自动按 JSON 字符串过桥) */
107
+ setDefaultConfig(config: Record<string, any> | string): Promise<any>;
108
+ }
109
+ /** qtx.config.extraUI 方法面(ExtraUI 全局主题) */
110
+ export interface QtxConfigExtraUIMethods {
111
+ /** 设置全局主题(primaryColor / focusBorderColor / cornerRadius 等;对象入参自动按 JSON 字符串过桥) */
112
+ setThemeConfig(theme: Record<string, any> | string): Promise<any>;
113
+ }
114
+ /**
115
+ * 把注册表中的命名空间挂到目标对象(qtx 默认导出):已手写挂载的根跳过(dogfood 带
116
+ * 完整类型),其余(未来 generate 产出的能力域,如 qtx.file)逐 ns 懒挂载。
117
+ * core 不挂方法面(主插件引导走 installQtx(),qtx.core 保留给框架自身)。
118
+ */
119
+ export declare function attachCapabilityNamespaces(target: Record<string, any>): void;
@@ -1,8 +1,5 @@
1
- /** qtx 统一插件 */
2
1
  export declare const QTX_PLUGIN_PKG = "com.quicktvui.plugin.qtx";
3
- /** 插件入口类(宿主 callReflect 调用其 setup()) */
4
2
  export declare const QTX_PLUGIN_INIT_CLASS = "com.quicktvui.plugin.qtx.QtxPluginApp";
5
- /** JS 侧要求的最低指令协议版本(与 GridTabsSDUI.md 同步) */
6
3
  export declare const QTX_MIN_PROTOCOL_VERSION = "1.28.0";
7
4
  export interface QtxVersionInfo {
8
5
  pluginVersion: string;
@@ -20,14 +17,7 @@ export interface InstallQtxOptions {
20
17
  /** 单次安装超时(毫秒),默认 8000 */
21
18
  timeout?: number;
22
19
  }
23
- export declare class QtxInstallError extends Error {
24
- code: 'PROBE_FAILED' | 'INSTALL_FAILED' | 'VERSION_TOO_LOW' | 'PROTOCOL_MISMATCH' | 'TIMEOUT';
25
- detail?: Partial<QtxVersionInfo> & {
26
- minPluginVersion?: string;
27
- minProtocolVersion?: string;
28
- };
29
- constructor(code: QtxInstallError['code'], message: string, detail?: QtxInstallError['detail']);
30
- }
20
+ export { QtxInstallError } from './capabilities';
31
21
  export declare function isVersionAtLeast(actual: string, required: string): boolean;
32
22
  /**
33
23
  * 引导 qtx(全局单例,幂等,可重试——失败后再次调用会重新走流程)。
@@ -1,9 +1,6 @@
1
- /**
2
- * 全局主题初始化(自旧 AddonProvider 迁出的纯函数部分,shade/env 逻辑已退役)。
3
- */
4
- /** 初始化 GridTabs 的全局兜底配置(themeConfig / loadingConfig 等) */
1
+ /** 初始化 GridTabs 的全局兜底配置(themeConfig / loadingConfig 等);等价 qtx.config.gridTabs.setDefaultConfig */
5
2
  export declare function initGridTabsGlobalConfig(config: Record<string, any>): Promise<boolean>;
6
- /** 初始化 ExtraUI 的全局主题(primaryColor、focusBorderColor、cornerRadius 等) */
3
+ /** 初始化 ExtraUI 的全局主题(primaryColor、focusBorderColor、cornerRadius 等);等价 qtx.config.extraUI.setThemeConfig */
7
4
  export declare function initExtraUIGlobalTheme(config: Record<string, any>): Promise<boolean>;
8
5
  /**
9
6
  * 一键设置全局主题(联合配置):同时配置 extra-ui 与 grid-tabs/glint 的主题参数。
package/dist/index.d.ts CHANGED
@@ -3,6 +3,8 @@ export { useGridTabs } from './components/QtxGridTabs/useGridTabs';
3
3
  export type { QtxListItem, QtxListProps, QtxListItemEvent, QtxListLoadMoreEvent, QtxListEventName, QtxListExpose, } from './components/QtxList/types';
4
4
  export { QTX_LIST_EVENTS } from './components/QtxList/types';
5
5
  export { captureItemTemplate } from './components/QtxList/capture';
6
+ export type { QtxChannelNavItem, QtxChannelNavProps, QtxChannelNavEvents, QtxChannelNavExpose } from './components/QtxChannelNav/types';
7
+ export { QTX_CHANNEL_NAV_EVENTS } from './components/QtxChannelNav/types';
6
8
  export type { QtxPosterProps, QtxPosterExpose } from './components/QtxPoster/types';
7
9
  export type { QtxAppIconProps, QtxAppIconExpose } from './components/QtxAppIcon/types';
8
10
  export { glintStylePack, compactStylePack, presetItem, styledRows, resolvePresetViewType, registerStylePack, getStylePack, listStylePacks, listPresetViewTypes, isKnownPresetViewType, } from './preset-items';
@@ -31,19 +33,36 @@ import { QtxListPlugin, QtxList } from './components/QtxList';
31
33
  import { QtxTabsPlugin, QtxTabs, QtxTabContent } from './components/QtxTabs';
32
34
  import { QtxPosterPlugin, QtxPoster } from './components/QtxPoster';
33
35
  import { QtxAppIconPlugin, QtxAppIcon } from './components/QtxAppIcon';
34
- export { QtxGridTabsPlugin, QtxGridTabs, QtxKeyboardPlugin, QtxKeyboard, QtxNumericKeyboardPlugin, QtxNumericKeyboard, QtxPortalPoolPlugin, QtxPortalPool, QtxPortalItemPlugin, QtxPortalItem, QtxHsvBackgroundPlugin, QtxHsvBackground, QtxSvgImagePlugin, QtxSvgImage, QtxButtonPlugin, QtxButton, QtxCheckboxPlugin, QtxCheckbox, QtxRadioGroupPlugin, QtxRadioGroup, QtxCheckboxGroupPlugin, QtxCheckboxGroup, QtxSwitcherPlugin, QtxSwitcher, QtxSettingSwitchPlugin, QtxSettingSwitch, QtxCollapseMenuGroupPlugin, QtxCollapseMenuGroup, QtxCollapseMenuListPlugin, QtxCollapseMenuList, QtxInputViewPlugin, QtxInputView, QtxDatePickerPlugin, QtxDatePicker, QtxRatingBarPlugin, QtxRatingBar, QtxListPlugin, QtxList, QtxTabsPlugin, QtxTabs, QtxTabContent, QtxPosterPlugin, QtxPoster, QtxAppIconPlugin, QtxAppIcon };
36
+ import { QtxChannelNavPlugin, QtxChannelNav } from './components/QtxChannelNav';
37
+ export { QtxGridTabsPlugin, QtxGridTabs, QtxKeyboardPlugin, QtxKeyboard, QtxNumericKeyboardPlugin, QtxNumericKeyboard, QtxPortalPoolPlugin, QtxPortalPool, QtxPortalItemPlugin, QtxPortalItem, QtxHsvBackgroundPlugin, QtxHsvBackground, QtxSvgImagePlugin, QtxSvgImage, QtxButtonPlugin, QtxButton, QtxCheckboxPlugin, QtxCheckbox, QtxRadioGroupPlugin, QtxRadioGroup, QtxCheckboxGroupPlugin, QtxCheckboxGroup, QtxSwitcherPlugin, QtxSwitcher, QtxSettingSwitchPlugin, QtxSettingSwitch, QtxCollapseMenuGroupPlugin, QtxCollapseMenuGroup, QtxCollapseMenuListPlugin, QtxCollapseMenuList, QtxInputViewPlugin, QtxInputView, QtxDatePickerPlugin, QtxDatePicker, QtxRatingBarPlugin, QtxRatingBar, QtxListPlugin, QtxList, QtxTabsPlugin, QtxTabs, QtxTabContent, QtxPosterPlugin, QtxPoster, QtxAppIconPlugin, QtxAppIcon, QtxChannelNavPlugin, QtxChannelNav };
35
38
  export { installQtx, ensureQtxReady, getQtxReadyInfo, QtxInstallError, isVersionAtLeast } from './core/installQtx';
36
39
  export type { QtxVersionInfo, InstallQtxOptions } from './core/installQtx';
40
+ export { CAPABILITIES, RESERVED_NAMESPACE_ROOTS, ensureCapability, getCapabilityInfo, getCapabilitySpec, registerCapability, defineCapability, attachCapabilityNamespaces, } from './core/capabilities';
41
+ export type { QtxCapabilitySpec, QtxCapabilityVersionInfo, EnsureCapabilityOptions, QtxCapabilityReservedMethods, QtxVersionMethods, QtxEnvMethods, QtxConfigGridTabsMethods, QtxConfigExtraUIMethods, } from './core/capabilities';
37
42
  export { createQtxGate } from './core/qtxGate';
38
43
  export { initGlobalTheme, initExtraUIGlobalTheme, initGridTabsGlobalConfig } from './core/theme';
39
44
  export { vPortalTo } from './directives/v-portal-to';
40
45
  export { setPortalListViewId, getPortalListViewId, registerPortalLive } from './core/portalCoordinator';
41
46
  import { App } from 'vue';
47
+ import { type QtxConfigExtraUIMethods, type QtxConfigGridTabsMethods, type QtxEnvMethods, type QtxVersionMethods } from './core/capabilities';
48
+ import './capabilities';
42
49
  /**
43
50
  * qtx Vue 插件:注册全部 qtx-* 组件,并自动触发插件引导(探测/协商/安装)。
44
51
  * 这是用户唯一需要写的一行:app.use(qtx)。
52
+ *
53
+ * 命名空间属性(version / env / config 等)是能力接入层资产,与全局组件注册互不冲突
54
+ * (app.use 只读取 install;组件仍走 app.component / registerElement 通道)。
45
55
  */
46
56
  export declare const qtx: {
57
+ /** 版本与就绪信息(qtx.version.*,保留字 ready/preheat/getInfo) */
58
+ version: import("./core/capabilities").QtxCapabilityReservedMethods & QtxVersionMethods;
59
+ /** 宿主内建模块清单(qtx.env.*) */
60
+ env: import("./core/capabilities").QtxCapabilityReservedMethods & QtxEnvMethods;
61
+ /** 全局配置命名空间(qtx.config.gridTabs / qtx.config.extraUI) */
62
+ config: {
63
+ gridTabs: import("./core/capabilities").QtxCapabilityReservedMethods & QtxConfigGridTabsMethods;
64
+ extraUI: import("./core/capabilities").QtxCapabilityReservedMethods & QtxConfigExtraUIMethods;
65
+ };
47
66
  install: (app: App) => void;
48
67
  };
49
68
  export default qtx;
@@ -89,6 +108,8 @@ declare module '@vue/runtime-core' {
89
108
  'qtx-poster': typeof QtxPoster;
90
109
  QtxAppIcon: typeof QtxAppIcon;
91
110
  'qtx-app-icon': typeof QtxAppIcon;
111
+ QtxChannelNav: typeof QtxChannelNav;
112
+ 'qtx-channel-nav': typeof QtxChannelNav;
92
113
  QtxStyledList: typeof QtxStyledList;
93
114
  }
94
115
  }
@@ -134,6 +155,8 @@ declare module 'vue' {
134
155
  'qtx-poster': typeof QtxPoster;
135
156
  QtxAppIcon: typeof QtxAppIcon;
136
157
  'qtx-app-icon': typeof QtxAppIcon;
158
+ QtxChannelNav: typeof QtxChannelNav;
159
+ 'qtx-channel-nav': typeof QtxChannelNav;
137
160
  QtxStyledList: typeof QtxStyledList;
138
161
  }
139
162
  }