xref: /MusicFree/src/core/config.ts (revision b3a3a048036932fa4574c45563c1cac326b1d628)
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猫头猫            };
50*b3a3a048S猫头猫            /** 最大历史记录条目 */
510412c91bS猫头猫            maxHistoryLen: number;
52*b3a3a048S猫头猫            /** 启动时自动更新插件 */
53*b3a3a048S猫头猫            autoUpdatePlugin: boolean;
54e22d5e4fS猫头猫        };
5557277364S猫头猫        /** 歌词 */
5657277364S猫头猫        lyric: {
5757277364S猫头猫            showStatusBarLyric: boolean;
5857277364S猫头猫            topPercent: number;
5957277364S猫头猫            leftPercent: number;
6057277364S猫头猫            align: number;
6157277364S猫头猫            color: string;
6257277364S猫头猫            backgroundColor: string;
6357277364S猫头猫            widthPercent: number;
6457277364S猫头猫            fontSize: number;
6557277364S猫头猫        };
66e22d5e4fS猫头猫
67e22d5e4fS猫头猫        /** 主题 */
68e22d5e4fS猫头猫        theme: {
69e22d5e4fS猫头猫            background: string;
70e22d5e4fS猫头猫            backgroundOpacity: number;
71e22d5e4fS猫头猫            backgroundBlur: number;
72a27adc20S猫头猫            colors: CustomizedColors;
736cfecf1cS猫头猫            followSystem: boolean;
746cfecf1cS猫头猫            selectedTheme: string;
75e22d5e4fS猫头猫        };
768b7ddca8S猫头猫
778b7ddca8S猫头猫        plugin: {
788b7ddca8S猫头猫            subscribeUrl: string;
798b7ddca8S猫头猫        };
80e22d5e4fS猫头猫    };
81e22d5e4fS猫头猫    status: {
82e22d5e4fS猫头猫        music: {
83e22d5e4fS猫头猫            /** 当前的音乐 */
84e22d5e4fS猫头猫            track: IMusic.IMusicItem;
85e22d5e4fS猫头猫            /** 进度 */
86e22d5e4fS猫头猫            progress: number;
87e22d5e4fS猫头猫            /** 模式 */
88e22d5e4fS猫头猫            repeatMode: string;
89e22d5e4fS猫头猫            /** 列表 */
90e22d5e4fS猫头猫            musicQueue: IMusic.IMusicItem[];
91fcc60afbS猫头猫            /** 速度 */
92fcc60afbS猫头猫            rate: number;
93e22d5e4fS猫头猫        };
94f6017740S猫头猫        app: {
95f6017740S猫头猫            /** 跳过特定版本 */
96f6017740S猫头猫            skipVersion: string;
97f6017740S猫头猫        };
98e22d5e4fS猫头猫    };
99e22d5e4fS猫头猫}
100e22d5e4fS猫头猫
101e22d5e4fS猫头猫type FilterType<T, R = never> = T extends Record<string | number, any>
102e22d5e4fS猫头猫    ? {
103e22d5e4fS猫头猫          [P in keyof T]: T[P] extends ExceptionType ? R : T[P];
104e22d5e4fS猫头猫      }
105e22d5e4fS猫头猫    : never;
106e22d5e4fS猫头猫
107e22d5e4fS猫头猫type KeyPaths<
108e22d5e4fS猫头猫    T extends object,
109e22d5e4fS猫头猫    Root extends boolean = true,
110e22d5e4fS猫头猫    R = FilterType<T, ''>,
111e22d5e4fS猫头猫    K extends keyof R = keyof R,
112e22d5e4fS猫头猫> = K extends string | number
113e22d5e4fS猫头猫    ?
114e22d5e4fS猫头猫          | (Root extends true ? `${K}` : `.${K}`)
115e22d5e4fS猫头猫          | (R[K] extends Record<string | number, any>
1164060c00aS猫头猫                ? `${Root extends true ? `${K}` : `.${K}`}${KeyPaths<
1174060c00aS猫头猫                      R[K],
1184060c00aS猫头猫                      false
1194060c00aS猫头猫                  >}`
120e22d5e4fS猫头猫                : never)
121e22d5e4fS猫头猫    : never;
122e22d5e4fS猫头猫
123e22d5e4fS猫头猫type KeyPathValue<T extends object, K extends string> = T extends Record<
124e22d5e4fS猫头猫    string | number,
125e22d5e4fS猫头猫    any
126e22d5e4fS猫头猫>
127e22d5e4fS猫头猫    ? K extends `${infer S}.${infer R}`
128e22d5e4fS猫头猫        ? KeyPathValue<T[S], R>
129e22d5e4fS猫头猫        : T[K]
130e22d5e4fS猫头猫    : never;
131e22d5e4fS猫头猫
132e22d5e4fS猫头猫type KeyPathsObj<
133e22d5e4fS猫头猫    T extends object,
134e22d5e4fS猫头猫    K extends string = KeyPaths<T>,
135e22d5e4fS猫头猫> = T extends Record<string | number, any>
136e22d5e4fS猫头猫    ? {
137e22d5e4fS猫头猫          [R in K]: KeyPathValue<T, R>;
138e22d5e4fS猫头猫      }
139e22d5e4fS猫头猫    : never;
140e22d5e4fS猫头猫
141e22d5e4fS猫头猫type DeepPartial<T> = {
142e22d5e4fS猫头猫    [K in keyof T]?: T[K] extends Record<string | number, any>
143e22d5e4fS猫头猫        ? T[K] extends ExceptionType
144e22d5e4fS猫头猫            ? T[K]
145e22d5e4fS猫头猫            : DeepPartial<T[K]>
146e22d5e4fS猫头猫        : T[K];
147e22d5e4fS猫头猫};
148e22d5e4fS猫头猫
149cfa0fc07S猫头猫export type IConfigPaths = KeyPaths<IConfig>;
150e22d5e4fS猫头猫type PartialConfig = DeepPartial<IConfig> | null;
151e22d5e4fS猫头猫type IConfigPathsObj = KeyPathsObj<DeepPartial<IConfig>, IConfigPaths>;
152e22d5e4fS猫头猫
153e22d5e4fS猫头猫let config: PartialConfig = null;
154e22d5e4fS猫头猫/** 初始化config */
1551f829e09S猫头猫async function setup() {
156e22d5e4fS猫头猫    config = (await getStorage('local-config')) ?? {};
157e22d5e4fS猫头猫    // await checkValidPath(['setting.theme.background']);
158e22d5e4fS猫头猫    notify();
159e22d5e4fS猫头猫}
160e22d5e4fS猫头猫
161e22d5e4fS猫头猫/** 设置config */
162e22d5e4fS猫头猫async function setConfig<T extends IConfigPaths>(
163e22d5e4fS猫头猫    key: T,
164e22d5e4fS猫头猫    value: IConfigPathsObj[T],
165e22d5e4fS猫头猫    shouldNotify = true,
166e22d5e4fS猫头猫) {
167e22d5e4fS猫头猫    if (config === null) {
168e22d5e4fS猫头猫        return;
169e22d5e4fS猫头猫    }
170e22d5e4fS猫头猫    const keys = key.split('.');
171e22d5e4fS猫头猫
172e22d5e4fS猫头猫    const result = produce(config, draft => {
173e22d5e4fS猫头猫        draft[keys[0] as keyof IConfig] = draft[keys[0] as keyof IConfig] ?? {};
174e22d5e4fS猫头猫        let conf: any = draft[keys[0] as keyof IConfig];
175e22d5e4fS猫头猫        for (let i = 1; i < keys.length - 1; ++i) {
176e22d5e4fS猫头猫            if (!conf?.[keys[i]]) {
177e22d5e4fS猫头猫                conf[keys[i]] = {};
178e22d5e4fS猫头猫            }
179e22d5e4fS猫头猫            conf = conf[keys[i]];
180e22d5e4fS猫头猫        }
181e22d5e4fS猫头猫        conf[keys[keys.length - 1]] = value;
182e22d5e4fS猫头猫        return draft;
183e22d5e4fS猫头猫    });
184e22d5e4fS猫头猫
185e22d5e4fS猫头猫    setStorage('local-config', result);
186e22d5e4fS猫头猫    config = result;
187e22d5e4fS猫头猫    if (shouldNotify) {
188e22d5e4fS猫头猫        notify();
189e22d5e4fS猫头猫    }
190e22d5e4fS猫头猫}
191e22d5e4fS猫头猫
192b7048bd1S猫头猫// todo: 获取兜底
193e22d5e4fS猫头猫/** 获取config */
194e22d5e4fS猫头猫function getConfig(): PartialConfig;
195e22d5e4fS猫头猫function getConfig<T extends IConfigPaths>(key: T): IConfigPathsObj[T];
196e22d5e4fS猫头猫function getConfig(key?: string) {
197e22d5e4fS猫头猫    let result: any = config;
198e22d5e4fS猫头猫    if (key && config) {
199e22d5e4fS猫头猫        result = getPathValue(config, key);
200e22d5e4fS猫头猫    }
201e22d5e4fS猫头猫
202e22d5e4fS猫头猫    return result;
203e22d5e4fS猫头猫}
204e22d5e4fS猫头猫
205e22d5e4fS猫头猫/** 通过path获取值 */
206e22d5e4fS猫头猫function getPathValue(obj: Record<string, any>, path: string) {
207e22d5e4fS猫头猫    const keys = path.split('.');
208e22d5e4fS猫头猫    let tmp = obj;
209e22d5e4fS猫头猫    for (let i = 0; i < keys.length; ++i) {
210e22d5e4fS猫头猫        tmp = tmp?.[keys[i]];
211e22d5e4fS猫头猫    }
212e22d5e4fS猫头猫    return tmp;
213e22d5e4fS猫头猫}
214e22d5e4fS猫头猫
215e22d5e4fS猫头猫/** 同步hook */
216e22d5e4fS猫头猫const notifyCbs = new Set<() => void>();
217e22d5e4fS猫头猫function notify() {
218e22d5e4fS猫头猫    notifyCbs.forEach(_ => _?.());
219e22d5e4fS猫头猫}
220e22d5e4fS猫头猫
221e22d5e4fS猫头猫/** hook */
222e22d5e4fS猫头猫function useConfig(): PartialConfig;
223e22d5e4fS猫头猫function useConfig<T extends IConfigPaths>(key: T): IConfigPathsObj[T];
224e22d5e4fS猫头猫function useConfig(key?: string) {
225a27adc20S猫头猫    // TODO: 应该有性能损失
226e22d5e4fS猫头猫    const [_cfg, _setCfg] = useState<PartialConfig>(config);
227e22d5e4fS猫头猫    function setCfg() {
228e22d5e4fS猫头猫        _setCfg(config);
229e22d5e4fS猫头猫    }
230e22d5e4fS猫头猫    useEffect(() => {
231e22d5e4fS猫头猫        notifyCbs.add(setCfg);
232e22d5e4fS猫头猫        return () => {
233e22d5e4fS猫头猫            notifyCbs.delete(setCfg);
234e22d5e4fS猫头猫        };
235e22d5e4fS猫头猫    }, []);
236e22d5e4fS猫头猫
237e22d5e4fS猫头猫    if (key) {
238e22d5e4fS猫头猫        return _cfg ? getPathValue(_cfg, key) : undefined;
239e22d5e4fS猫头猫    } else {
240e22d5e4fS猫头猫        return _cfg;
241e22d5e4fS猫头猫    }
242e22d5e4fS猫头猫}
243e22d5e4fS猫头猫
244e22d5e4fS猫头猫const Config = {
245e22d5e4fS猫头猫    get: getConfig,
246e22d5e4fS猫头猫    set: setConfig,
247e22d5e4fS猫头猫    useConfig,
2481f829e09S猫头猫    setup,
249e22d5e4fS猫头猫};
250e22d5e4fS猫头猫
251e22d5e4fS猫头猫export default Config;
252