@das-fed/upf-utils 6.4.0-dev.237 → 6.4.0-dev.239

package/theme/index.d.ts

@@ -0,0 +1,92 @@
+export type ThemeVariables = Record<string, string>;
+type ThemeVariableSource = Record<string, string | undefined>;
+export interface ThemeConfig {
+    name?: string;
+    basePresetName?: string;
+    variables?: ThemeVariableSource;
+    [key: string]: unknown;
+}
+export interface ThemeChangeEvent<TThemeName extends string = string, TVariables extends object = ThemeVariables> {
+    themeName: TThemeName;
+    config?: ThemeConfig | null;
+    variables: TVariables;
+    source?: 'change' | 'mountSync';
+    timestamp: number;
+}
+export interface ThemeBridgeAPI<TThemeName extends string = string, TVariables extends object = ThemeVariables> {
+    getCurrentTheme: () => ThemeChangeEvent<TThemeName, TVariables> | null;
+    getVariables?: () => TVariables | null;
+    changeTheme?: (themeName: TThemeName) => void;
+    onThemeChange?: (callback: (event: ThemeChangeEvent<TThemeName, TVariables>) => void) => () => void;
+}
+export interface ThemeBridgeResolveContext<TVariables extends object = ThemeVariables> {
+    variables: TVariables;
+    result: Record<string, string>;
+}
+export interface ThemeBridgeVariableItem<TVariables extends object = ThemeVariables> {
+    target: string;
+    from?: keyof TVariables | string;
+    value?: string;
+    resolve?: (context: ThemeBridgeResolveContext<TVariables> & {
+        mixHexColor: typeof mixHexColor;
+        toRgbaColor: typeof toRgbaColor;
+    }) => string;
+}
+export interface ApplyThemeVariablesOptions {
+    /** 写入目标节点；默认当前文档 html。 */
+    root?: HTMLElement | null;
+    /** 是否生成运行时桥接变量；false 时仅写入源变量。 */
+    includeBridges?: boolean;
+    /** 是否写入 Element Plus 与 das-ui/das 历史兼容变量；默认 true。 */
+    includeElementAndDasUiBridges?: boolean;
+    /** 写入 data-theme 的主题名。 */
+    themeName?: string;
+    /** 写入 data-skin 的皮肤名；传 null 时移除。 */
+    skinName?: string | null;
+}
+export interface ThemePullOptions extends ApplyThemeVariablesOptions {
+    /** 是否输出主题同步警告日志。 */
+    debug?: boolean;
+}
+export interface SubAppThemeSyncOptions extends ThemePullOptions {
+    /** 初始化时是否立即从宿主拉取当前主题。 */
+    syncOnInit?: boolean;
+    /** 是否优先使用 window.__THEME_API__ 订阅。 */
+    preferWindowSubscription?: boolean;
+    /** 后续真实主题切换后的回调，不包含 mountSync。 */
+    onThemeChange?: (event: ThemeChangeEvent) => void;
+}
+export type HostThemeRootSyncOptions = SubAppThemeSyncOptions;
+export interface RuntimeThemeVariableBuildOptions {
+    /** 是否写入 Element Plus 与 das-ui/das 历史兼容变量；默认 true。 */
+    includeElementAndDasUiBridges?: boolean;
+}
+export declare const mixHexColor: (foreground: string, background: string, foregroundWeight: number, fallback: string) => string;
+export declare const toRgbaColor: (color: string, alpha: number, fallback: string) => string;
+export declare const resolveThemeBridgeVariables: <TVariables extends object = ThemeVariables>(variables: TVariables, items: readonly ThemeBridgeVariableItem<TVariables>[]) => any;
+export declare const LEGACY_THEME_BRIDGE_ITEMS: ThemeBridgeVariableItem[];
+export declare const ELEMENT_THEME_BRIDGE_ITEMS: ThemeBridgeVariableItem[];
+export declare const DAS_UI_THEME_BRIDGE_ITEMS: ThemeBridgeVariableItem[];
+export declare const UPF_COMPONENT_THEME_BRIDGE_ITEMS: ThemeBridgeVariableItem[];
+export declare const toLegacyThemeVariables: (variables: object) => any;
+export declare const toElementThemeVariables: (variables: object) => any;
+export declare const toDasUiColorOverrides: (variables: object) => any;
+export declare const toUpfComponentThemeVariables: (variables: object) => any;
+export declare const buildRuntimeThemeVariables: (variables: object, options?: RuntimeThemeVariableBuildOptions) => Record<string, string>;
+export declare const getHostThemeSnapshotFromWindowName: (debug?: boolean) => ThemeChangeEvent | null;
+export declare const applyThemeVariablesToDocument: (variables: object, options?: ApplyThemeVariablesOptions) => any;
+export declare const applyThemeEventToDocument: (event: ThemeChangeEvent, options?: ApplyThemeVariablesOptions) => any;
+export declare const getThemeAPI: (debug?: boolean) => ThemeBridgeAPI | null;
+export declare const getCurrentTheme: (options?: ThemePullOptions) => ThemeChangeEvent<string, Record<string, string>>;
+export declare const getThemeVariables: (options?: ThemePullOptions) => any;
+export declare const changeTheme: (themeName: string, debug?: boolean) => boolean;
+export declare const syncThemeFromHost: (options?: ThemePullOptions) => ThemeChangeEvent<string, Record<string, string>>;
+export declare const syncHostThemeRoot: (options?: ThemePullOptions) => ThemeChangeEvent | null;
+export declare const initSubAppThemeSync: (options?: SubAppThemeSyncOptions) => () => void;
+export declare const initHostThemeRootSync: (options?: HostThemeRootSyncOptions) => () => void;
+export declare const getThemeVariable: (varName: string, root?: HTMLElement | null) => any;
+export declare const getVar: (key?: string) => string;
+export declare const getVarValue: (key?: string, root?: HTMLElement | null) => {
+    value: any;
+};
+export {};