xref: /MusicFree/src/core/config.ts (revision 572773643a97ed64c4f87c1da46f1097aa62b833)
1b7048bd1S猫头猫// import {Quality} from '@/constants/commonConst';
2a27adc20S猫头猫import {CustomizedColors} from '@/hooks/useColors';
3e22d5e4fS猫头猫import {getStorage, setStorage} from '@/utils/storage';
4e22d5e4fS猫头猫import produce from 'immer';
5e22d5e4fS猫头猫import {useEffect, useState} from 'react';
6e22d5e4fS猫头猫
7b7048bd1S猫头猫type ExceptionType = IMusic.IMusicItem | IMusic.IMusicItem[] | IMusic.IQuality;
8e22d5e4fS猫头猫interface IConfig {
9e22d5e4fS猫头猫    setting: {
10e22d5e4fS猫头猫        basic: {
11cfa0fc07S猫头猫            /** 使用移动网络播放 */
12cfa0fc07S猫头猫            useCelluarNetworkPlay: boolean;
13cfa0fc07S猫头猫            /** 使用移动网络下载 */
14cfa0fc07S猫头猫            useCelluarNetworkDownload: boolean;
15e22d5e4fS猫头猫            /** 最大同时下载 */
16e22d5e4fS猫头猫            maxDownload: number | string;
179297b0a0S猫头猫            /** 播放歌曲行为 */
189297b0a0S猫头猫            clickMusicInSearch: '播放歌曲' | '播放歌曲并替换播放列表';
19cbb92902S猫头猫            /** 点击专辑单曲 */
20cbb92902S猫头猫            clickMusicInAlbum: '播放专辑' | '播放单曲';
21b6261296S猫头猫            /** 下载文件夹 */
22b6261296S猫头猫            downloadPath: string;
23e22d5e4fS猫头猫            /** 同时播放 */
24e22d5e4fS猫头猫            notInterrupt: boolean;
25266badb7S猫头猫            /** 打断时 */
26266badb7S猫头猫            tempRemoteDuck: '暂停' | '降低音量';
27e22d5e4fS猫头猫            /** 播放错误时自动停止 */
28e22d5e4fS猫头猫            autoStopWhenError: boolean;
29cfa0fc07S猫头猫            /** 插件缓存策略 todo */
30cfa0fc07S猫头猫            pluginCacheControl: string;
31cfa0fc07S猫头猫            /** 最大音乐缓存 */
32cfa0fc07S猫头猫            maxCacheSize: number;
33e08d37a3S猫头猫            /** 默认播放音质 */
34b7048bd1S猫头猫            defaultPlayQuality: IMusic.IQualityKey;
35e08d37a3S猫头猫            /** 音质顺序 */
36e08d37a3S猫头猫            playQualityOrder: 'asc' | 'desc';
37e08d37a3S猫头猫            /** 默认下载音质 */
38b7048bd1S猫头猫            defaultDownloadQuality: IMusic.IQualityKey;
39e08d37a3S猫头猫            /** 下载音质顺序 */
40e08d37a3S猫头猫            downloadQualityOrder: 'asc' | 'desc';
41c342e600S猫头猫            /** 歌曲详情页 */
42c342e600S猫头猫            musicDetailDefault: 'album' | 'lyric';
43fbdbd2d3S猫头猫            /** 歌曲详情页常亮 */
44fbdbd2d3S猫头猫            musicDetailAwake: boolean;
45e22d5e4fS猫头猫            debug: {
46e22d5e4fS猫头猫                errorLog: boolean;
47e22d5e4fS猫头猫                traceLog: boolean;
48ea6d708fS猫头猫                devLog: boolean;
49e22d5e4fS猫头猫            };
500412c91bS猫头猫            maxHistoryLen: number;
51e22d5e4fS猫头猫        };
52*57277364S猫头猫        /** 歌词 */
53*57277364S猫头猫        lyric: {
54*57277364S猫头猫            showStatusBarLyric: boolean;
55*57277364S猫头猫            topPercent: number;
56*57277364S猫头猫            leftPercent: number;
57*57277364S猫头猫            align: number;
58*57277364S猫头猫            color: string;
59*57277364S猫头猫            backgroundColor: string;
60*57277364S猫头猫            widthPercent: number;
61*57277364S猫头猫            fontSize: number;
62*57277364S猫头猫        };
63e22d5e4fS猫头猫
64e22d5e4fS猫头猫        /** 主题 */
65e22d5e4fS猫头猫        theme: {
66e22d5e4fS猫头猫            background: string;
67e22d5e4fS猫头猫            backgroundOpacity: number;
68e22d5e4fS猫头猫            backgroundBlur: number;
69a27adc20S猫头猫            colors: CustomizedColors;
706cfecf1cS猫头猫            followSystem: boolean;
716cfecf1cS猫头猫            selectedTheme: string;
72e22d5e4fS猫头猫        };
738b7ddca8S猫头猫
748b7ddca8S猫头猫        plugin: {
758b7ddca8S猫头猫            subscribeUrl: string;
768b7ddca8S猫头猫        };
77e22d5e4fS猫头猫    };
78e22d5e4fS猫头猫    status: {
79e22d5e4fS猫头猫        music: {
80e22d5e4fS猫头猫            /** 当前的音乐 */
81e22d5e4fS猫头猫            track: IMusic.IMusicItem;
82e22d5e4fS猫头猫            /** 进度 */
83e22d5e4fS猫头猫            progress: number;
84e22d5e4fS猫头猫            /** 模式 */
85e22d5e4fS猫头猫            repeatMode: string;
86e22d5e4fS猫头猫            /** 列表 */
87e22d5e4fS猫头猫            musicQueue: IMusic.IMusicItem[];
88fcc60afbS猫头猫            /** 速度 */
89fcc60afbS猫头猫            rate: number;
90e22d5e4fS猫头猫        };
91f6017740S猫头猫        app: {
92f6017740S猫头猫            /** 跳过特定版本 */
93f6017740S猫头猫            skipVersion: string;
94f6017740S猫头猫        };
95e22d5e4fS猫头猫    };
96e22d5e4fS猫头猫}
97e22d5e4fS猫头猫
98e22d5e4fS猫头猫type FilterType<T, R = never> = T extends Record<string | number, any>
99e22d5e4fS猫头猫    ? {
100e22d5e4fS猫头猫          [P in keyof T]: T[P] extends ExceptionType ? R : T[P];
101e22d5e4fS猫头猫      }
102e22d5e4fS猫头猫    : never;
103e22d5e4fS猫头猫
104e22d5e4fS猫头猫type KeyPaths<
105e22d5e4fS猫头猫    T extends object,
106e22d5e4fS猫头猫    Root extends boolean = true,
107e22d5e4fS猫头猫    R = FilterType<T, ''>,
108e22d5e4fS猫头猫    K extends keyof R = keyof R,
109e22d5e4fS猫头猫> = K extends string | number
110e22d5e4fS猫头猫    ?
111e22d5e4fS猫头猫          | (Root extends true ? `${K}` : `.${K}`)
112e22d5e4fS猫头猫          | (R[K] extends Record<string | number, any>
1134060c00aS猫头猫                ? `${Root extends true ? `${K}` : `.${K}`}${KeyPaths<
1144060c00aS猫头猫                      R[K],
1154060c00aS猫头猫                      false
1164060c00aS猫头猫                  >}`
117e22d5e4fS猫头猫                : never)
118e22d5e4fS猫头猫    : never;
119e22d5e4fS猫头猫
120e22d5e4fS猫头猫type KeyPathValue<T extends object, K extends string> = T extends Record<
121e22d5e4fS猫头猫    string | number,
122e22d5e4fS猫头猫    any
123e22d5e4fS猫头猫>
124e22d5e4fS猫头猫    ? K extends `${infer S}.${infer R}`
125e22d5e4fS猫头猫        ? KeyPathValue<T[S], R>
126e22d5e4fS猫头猫        : T[K]
127e22d5e4fS猫头猫    : never;
128e22d5e4fS猫头猫
129e22d5e4fS猫头猫type KeyPathsObj<
130e22d5e4fS猫头猫    T extends object,
131e22d5e4fS猫头猫    K extends string = KeyPaths<T>,
132e22d5e4fS猫头猫> = T extends Record<string | number, any>
133e22d5e4fS猫头猫    ? {
134e22d5e4fS猫头猫          [R in K]: KeyPathValue<T, R>;
135e22d5e4fS猫头猫      }
136e22d5e4fS猫头猫    : never;
137e22d5e4fS猫头猫
138e22d5e4fS猫头猫type DeepPartial<T> = {
139e22d5e4fS猫头猫    [K in keyof T]?: T[K] extends Record<string | number, any>
140e22d5e4fS猫头猫        ? T[K] extends ExceptionType
141e22d5e4fS猫头猫            ? T[K]
142e22d5e4fS猫头猫            : DeepPartial<T[K]>
143e22d5e4fS猫头猫        : T[K];
144e22d5e4fS猫头猫};
145e22d5e4fS猫头猫
146cfa0fc07S猫头猫export type IConfigPaths = KeyPaths<IConfig>;
147e22d5e4fS猫头猫type PartialConfig = DeepPartial<IConfig> | null;
148e22d5e4fS猫头猫type IConfigPathsObj = KeyPathsObj<DeepPartial<IConfig>, IConfigPaths>;
149e22d5e4fS猫头猫
150e22d5e4fS猫头猫let config: PartialConfig = null;
151e22d5e4fS猫头猫/** 初始化config */
1521f829e09S猫头猫async function setup() {
153e22d5e4fS猫头猫    config = (await getStorage('local-config')) ?? {};
154e22d5e4fS猫头猫    // await checkValidPath(['setting.theme.background']);
155e22d5e4fS猫头猫    notify();
156e22d5e4fS猫头猫}
157e22d5e4fS猫头猫
158e22d5e4fS猫头猫/** 设置config */
159e22d5e4fS猫头猫async function setConfig<T extends IConfigPaths>(
160e22d5e4fS猫头猫    key: T,
161e22d5e4fS猫头猫    value: IConfigPathsObj[T],
162e22d5e4fS猫头猫    shouldNotify = true,
163e22d5e4fS猫头猫) {
164e22d5e4fS猫头猫    if (config === null) {
165e22d5e4fS猫头猫        return;
166e22d5e4fS猫头猫    }
167e22d5e4fS猫头猫    const keys = key.split('.');
168e22d5e4fS猫头猫
169e22d5e4fS猫头猫    const result = produce(config, draft => {
170e22d5e4fS猫头猫        draft[keys[0] as keyof IConfig] = draft[keys[0] as keyof IConfig] ?? {};
171e22d5e4fS猫头猫        let conf: any = draft[keys[0] as keyof IConfig];
172e22d5e4fS猫头猫        for (let i = 1; i < keys.length - 1; ++i) {
173e22d5e4fS猫头猫            if (!conf?.[keys[i]]) {
174e22d5e4fS猫头猫                conf[keys[i]] = {};
175e22d5e4fS猫头猫            }
176e22d5e4fS猫头猫            conf = conf[keys[i]];
177e22d5e4fS猫头猫        }
178e22d5e4fS猫头猫        conf[keys[keys.length - 1]] = value;
179e22d5e4fS猫头猫        return draft;
180e22d5e4fS猫头猫    });
181e22d5e4fS猫头猫
182e22d5e4fS猫头猫    setStorage('local-config', result);
183e22d5e4fS猫头猫    config = result;
184e22d5e4fS猫头猫    if (shouldNotify) {
185e22d5e4fS猫头猫        notify();
186e22d5e4fS猫头猫    }
187e22d5e4fS猫头猫}
188e22d5e4fS猫头猫
189b7048bd1S猫头猫// todo: 获取兜底
190e22d5e4fS猫头猫/** 获取config */
191e22d5e4fS猫头猫function getConfig(): PartialConfig;
192e22d5e4fS猫头猫function getConfig<T extends IConfigPaths>(key: T): IConfigPathsObj[T];
193e22d5e4fS猫头猫function getConfig(key?: string) {
194e22d5e4fS猫头猫    let result: any = config;
195e22d5e4fS猫头猫    if (key && config) {
196e22d5e4fS猫头猫        result = getPathValue(config, key);
197e22d5e4fS猫头猫    }
198e22d5e4fS猫头猫
199e22d5e4fS猫头猫    return result;
200e22d5e4fS猫头猫}
201e22d5e4fS猫头猫
202e22d5e4fS猫头猫/** 通过path获取值 */
203e22d5e4fS猫头猫function getPathValue(obj: Record<string, any>, path: string) {
204e22d5e4fS猫头猫    const keys = path.split('.');
205e22d5e4fS猫头猫    let tmp = obj;
206e22d5e4fS猫头猫    for (let i = 0; i < keys.length; ++i) {
207e22d5e4fS猫头猫        tmp = tmp?.[keys[i]];
208e22d5e4fS猫头猫    }
209e22d5e4fS猫头猫    return tmp;
210e22d5e4fS猫头猫}
211e22d5e4fS猫头猫
212e22d5e4fS猫头猫/** 同步hook */
213e22d5e4fS猫头猫const notifyCbs = new Set<() => void>();
214e22d5e4fS猫头猫function notify() {
215e22d5e4fS猫头猫    notifyCbs.forEach(_ => _?.());
216e22d5e4fS猫头猫}
217e22d5e4fS猫头猫
218e22d5e4fS猫头猫/** hook */
219e22d5e4fS猫头猫function useConfig(): PartialConfig;
220e22d5e4fS猫头猫function useConfig<T extends IConfigPaths>(key: T): IConfigPathsObj[T];
221e22d5e4fS猫头猫function useConfig(key?: string) {
222a27adc20S猫头猫    // TODO: 应该有性能损失
223e22d5e4fS猫头猫    const [_cfg, _setCfg] = useState<PartialConfig>(config);
224e22d5e4fS猫头猫    function setCfg() {
225e22d5e4fS猫头猫        _setCfg(config);
226e22d5e4fS猫头猫    }
227e22d5e4fS猫头猫    useEffect(() => {
228e22d5e4fS猫头猫        notifyCbs.add(setCfg);
229e22d5e4fS猫头猫        return () => {
230e22d5e4fS猫头猫            notifyCbs.delete(setCfg);
231e22d5e4fS猫头猫        };
232e22d5e4fS猫头猫    }, []);
233e22d5e4fS猫头猫
234e22d5e4fS猫头猫    if (key) {
235e22d5e4fS猫头猫        return _cfg ? getPathValue(_cfg, key) : undefined;
236e22d5e4fS猫头猫    } else {
237e22d5e4fS猫头猫        return _cfg;
238e22d5e4fS猫头猫    }
239e22d5e4fS猫头猫}
240e22d5e4fS猫头猫
241e22d5e4fS猫头猫const Config = {
242e22d5e4fS猫头猫    get: getConfig,
243e22d5e4fS猫头猫    set: setConfig,
244e22d5e4fS猫头猫    useConfig,
2451f829e09S猫头猫    setup,
246e22d5e4fS猫头猫};
247e22d5e4fS猫头猫
248e22d5e4fS猫头猫export default Config;
249