xref: /MusicFree/src/core/config.ts (revision 266badb71020780e01a05212e3dc854f9d73dfad)
1b7048bd1S猫头猫// import {Quality} from '@/constants/commonConst';
2e22d5e4fS猫头猫import {getStorage, setStorage} from '@/utils/storage';
3e22d5e4fS猫头猫import produce from 'immer';
4e22d5e4fS猫头猫import {useEffect, useState} from 'react';
5e22d5e4fS猫头猫
6b7048bd1S猫头猫type ExceptionType = IMusic.IMusicItem | IMusic.IMusicItem[] | IMusic.IQuality;
7e22d5e4fS猫头猫interface IConfig {
8e22d5e4fS猫头猫    setting: {
9e22d5e4fS猫头猫        basic: {
10cfa0fc07S猫头猫            /** 使用移动网络播放 */
11cfa0fc07S猫头猫            useCelluarNetworkPlay: boolean;
12cfa0fc07S猫头猫            /** 使用移动网络下载 */
13cfa0fc07S猫头猫            useCelluarNetworkDownload: boolean;
14e22d5e4fS猫头猫            /** 最大同时下载 */
15e22d5e4fS猫头猫            maxDownload: number | string;
16cbb92902S猫头猫            /** 点击专辑单曲 */
17cbb92902S猫头猫            clickMusicInAlbum: '播放专辑' | '播放单曲';
18b6261296S猫头猫            /** 下载文件夹 */
19b6261296S猫头猫            downloadPath: string;
20e22d5e4fS猫头猫            /** 同时播放 */
21e22d5e4fS猫头猫            notInterrupt: boolean;
22*266badb7S猫头猫            /** 打断时 */
23*266badb7S猫头猫            tempRemoteDuck: '暂停' | '降低音量';
24e22d5e4fS猫头猫            /** 播放错误时自动停止 */
25e22d5e4fS猫头猫            autoStopWhenError: boolean;
26cfa0fc07S猫头猫            /** 插件缓存策略 todo */
27cfa0fc07S猫头猫            pluginCacheControl: string;
28cfa0fc07S猫头猫            /** 最大音乐缓存 */
29cfa0fc07S猫头猫            maxCacheSize: number;
30e08d37a3S猫头猫            /** 默认播放音质 */
31b7048bd1S猫头猫            defaultPlayQuality: IMusic.IQualityKey;
32e08d37a3S猫头猫            /** 音质顺序 */
33e08d37a3S猫头猫            playQualityOrder: 'asc' | 'desc';
34e08d37a3S猫头猫            /** 默认下载音质 */
35b7048bd1S猫头猫            defaultDownloadQuality: IMusic.IQualityKey;
36e08d37a3S猫头猫            /** 下载音质顺序 */
37e08d37a3S猫头猫            downloadQualityOrder: 'asc' | 'desc';
38e22d5e4fS猫头猫            debug: {
39e22d5e4fS猫头猫                errorLog: boolean;
40e22d5e4fS猫头猫                traceLog: boolean;
41e22d5e4fS猫头猫            };
42e22d5e4fS猫头猫        };
43e22d5e4fS猫头猫
44e22d5e4fS猫头猫        /** 主题 */
45e22d5e4fS猫头猫        theme: {
46e22d5e4fS猫头猫            mode: 'light' | 'dark' | 'custom-light' | 'custom-dark';
47e22d5e4fS猫头猫            background: string;
48e22d5e4fS猫头猫            backgroundOpacity: number;
49e22d5e4fS猫头猫            backgroundBlur: number;
50e22d5e4fS猫头猫            colors: {
51e22d5e4fS猫头猫                primary: string;
52e22d5e4fS猫头猫                secondary: string;
53e22d5e4fS猫头猫                textHighlight: string;
54e22d5e4fS猫头猫                pageBackground: string;
55f415a09cS猫头猫                accent: string;
56e22d5e4fS猫头猫            };
57e22d5e4fS猫头猫        };
588b7ddca8S猫头猫
598b7ddca8S猫头猫        plugin: {
608b7ddca8S猫头猫            subscribeUrl: string;
618b7ddca8S猫头猫        };
62e22d5e4fS猫头猫    };
63e22d5e4fS猫头猫    status: {
64e22d5e4fS猫头猫        music: {
65e22d5e4fS猫头猫            /** 当前的音乐 */
66e22d5e4fS猫头猫            track: IMusic.IMusicItem;
67e22d5e4fS猫头猫            /** 进度 */
68e22d5e4fS猫头猫            progress: number;
69e22d5e4fS猫头猫            /** 模式 */
70e22d5e4fS猫头猫            repeatMode: string;
71e22d5e4fS猫头猫            /** 列表 */
72e22d5e4fS猫头猫            musicQueue: IMusic.IMusicItem[];
73e22d5e4fS猫头猫        };
74e22d5e4fS猫头猫    };
75e22d5e4fS猫头猫}
76e22d5e4fS猫头猫
77e22d5e4fS猫头猫type FilterType<T, R = never> = T extends Record<string | number, any>
78e22d5e4fS猫头猫    ? {
79e22d5e4fS猫头猫          [P in keyof T]: T[P] extends ExceptionType ? R : T[P];
80e22d5e4fS猫头猫      }
81e22d5e4fS猫头猫    : never;
82e22d5e4fS猫头猫
83e22d5e4fS猫头猫type KeyPaths<
84e22d5e4fS猫头猫    T extends object,
85e22d5e4fS猫头猫    Root extends boolean = true,
86e22d5e4fS猫头猫    R = FilterType<T, ''>,
87e22d5e4fS猫头猫    K extends keyof R = keyof R,
88e22d5e4fS猫头猫> = K extends string | number
89e22d5e4fS猫头猫    ?
90e22d5e4fS猫头猫          | (Root extends true ? `${K}` : `.${K}`)
91e22d5e4fS猫头猫          | (R[K] extends Record<string | number, any>
924060c00aS猫头猫                ? `${Root extends true ? `${K}` : `.${K}`}${KeyPaths<
934060c00aS猫头猫                      R[K],
944060c00aS猫头猫                      false
954060c00aS猫头猫                  >}`
96e22d5e4fS猫头猫                : never)
97e22d5e4fS猫头猫    : never;
98e22d5e4fS猫头猫
99e22d5e4fS猫头猫type KeyPathValue<T extends object, K extends string> = T extends Record<
100e22d5e4fS猫头猫    string | number,
101e22d5e4fS猫头猫    any
102e22d5e4fS猫头猫>
103e22d5e4fS猫头猫    ? K extends `${infer S}.${infer R}`
104e22d5e4fS猫头猫        ? KeyPathValue<T[S], R>
105e22d5e4fS猫头猫        : T[K]
106e22d5e4fS猫头猫    : never;
107e22d5e4fS猫头猫
108e22d5e4fS猫头猫type KeyPathsObj<
109e22d5e4fS猫头猫    T extends object,
110e22d5e4fS猫头猫    K extends string = KeyPaths<T>,
111e22d5e4fS猫头猫> = T extends Record<string | number, any>
112e22d5e4fS猫头猫    ? {
113e22d5e4fS猫头猫          [R in K]: KeyPathValue<T, R>;
114e22d5e4fS猫头猫      }
115e22d5e4fS猫头猫    : never;
116e22d5e4fS猫头猫
117e22d5e4fS猫头猫type DeepPartial<T> = {
118e22d5e4fS猫头猫    [K in keyof T]?: T[K] extends Record<string | number, any>
119e22d5e4fS猫头猫        ? T[K] extends ExceptionType
120e22d5e4fS猫头猫            ? T[K]
121e22d5e4fS猫头猫            : DeepPartial<T[K]>
122e22d5e4fS猫头猫        : T[K];
123e22d5e4fS猫头猫};
124e22d5e4fS猫头猫
125cfa0fc07S猫头猫export type IConfigPaths = KeyPaths<IConfig>;
126e22d5e4fS猫头猫type PartialConfig = DeepPartial<IConfig> | null;
127e22d5e4fS猫头猫type IConfigPathsObj = KeyPathsObj<DeepPartial<IConfig>, IConfigPaths>;
128e22d5e4fS猫头猫
129e22d5e4fS猫头猫let config: PartialConfig = null;
130e22d5e4fS猫头猫/** 初始化config */
1311f829e09S猫头猫async function setup() {
132e22d5e4fS猫头猫    config = (await getStorage('local-config')) ?? {};
133e22d5e4fS猫头猫    // await checkValidPath(['setting.theme.background']);
134e22d5e4fS猫头猫    notify();
135e22d5e4fS猫头猫}
136e22d5e4fS猫头猫
137e22d5e4fS猫头猫/** 设置config */
138e22d5e4fS猫头猫async function setConfig<T extends IConfigPaths>(
139e22d5e4fS猫头猫    key: T,
140e22d5e4fS猫头猫    value: IConfigPathsObj[T],
141e22d5e4fS猫头猫    shouldNotify = true,
142e22d5e4fS猫头猫) {
143e22d5e4fS猫头猫    if (config === null) {
144e22d5e4fS猫头猫        return;
145e22d5e4fS猫头猫    }
146e22d5e4fS猫头猫    const keys = key.split('.');
147e22d5e4fS猫头猫
148e22d5e4fS猫头猫    const result = produce(config, draft => {
149e22d5e4fS猫头猫        draft[keys[0] as keyof IConfig] = draft[keys[0] as keyof IConfig] ?? {};
150e22d5e4fS猫头猫        let conf: any = draft[keys[0] as keyof IConfig];
151e22d5e4fS猫头猫        for (let i = 1; i < keys.length - 1; ++i) {
152e22d5e4fS猫头猫            if (!conf?.[keys[i]]) {
153e22d5e4fS猫头猫                conf[keys[i]] = {};
154e22d5e4fS猫头猫            }
155e22d5e4fS猫头猫            conf = conf[keys[i]];
156e22d5e4fS猫头猫        }
157e22d5e4fS猫头猫        conf[keys[keys.length - 1]] = value;
158e22d5e4fS猫头猫        return draft;
159e22d5e4fS猫头猫    });
160e22d5e4fS猫头猫
161e22d5e4fS猫头猫    setStorage('local-config', result);
162e22d5e4fS猫头猫    config = result;
163e22d5e4fS猫头猫    if (shouldNotify) {
164e22d5e4fS猫头猫        notify();
165e22d5e4fS猫头猫    }
166e22d5e4fS猫头猫}
167e22d5e4fS猫头猫
168b7048bd1S猫头猫// todo: 获取兜底
169e22d5e4fS猫头猫/** 获取config */
170e22d5e4fS猫头猫function getConfig(): PartialConfig;
171e22d5e4fS猫头猫function getConfig<T extends IConfigPaths>(key: T): IConfigPathsObj[T];
172e22d5e4fS猫头猫function getConfig(key?: string) {
173e22d5e4fS猫头猫    let result: any = config;
174e22d5e4fS猫头猫    if (key && config) {
175e22d5e4fS猫头猫        result = getPathValue(config, key);
176e22d5e4fS猫头猫    }
177e22d5e4fS猫头猫
178e22d5e4fS猫头猫    return result;
179e22d5e4fS猫头猫}
180e22d5e4fS猫头猫
181e22d5e4fS猫头猫/** 通过path获取值 */
182e22d5e4fS猫头猫function getPathValue(obj: Record<string, any>, path: string) {
183e22d5e4fS猫头猫    const keys = path.split('.');
184e22d5e4fS猫头猫    let tmp = obj;
185e22d5e4fS猫头猫    for (let i = 0; i < keys.length; ++i) {
186e22d5e4fS猫头猫        tmp = tmp?.[keys[i]];
187e22d5e4fS猫头猫    }
188e22d5e4fS猫头猫    return tmp;
189e22d5e4fS猫头猫}
190e22d5e4fS猫头猫
191e22d5e4fS猫头猫/** 同步hook */
192e22d5e4fS猫头猫const notifyCbs = new Set<() => void>();
193e22d5e4fS猫头猫function notify() {
194e22d5e4fS猫头猫    notifyCbs.forEach(_ => _?.());
195e22d5e4fS猫头猫}
196e22d5e4fS猫头猫
197e22d5e4fS猫头猫/** hook */
198e22d5e4fS猫头猫function useConfig(): PartialConfig;
199e22d5e4fS猫头猫function useConfig<T extends IConfigPaths>(key: T): IConfigPathsObj[T];
200e22d5e4fS猫头猫function useConfig(key?: string) {
201e22d5e4fS猫头猫    const [_cfg, _setCfg] = useState<PartialConfig>(config);
202e22d5e4fS猫头猫    function setCfg() {
203e22d5e4fS猫头猫        _setCfg(config);
204e22d5e4fS猫头猫    }
205e22d5e4fS猫头猫    useEffect(() => {
206e22d5e4fS猫头猫        notifyCbs.add(setCfg);
207e22d5e4fS猫头猫        return () => {
208e22d5e4fS猫头猫            notifyCbs.delete(setCfg);
209e22d5e4fS猫头猫        };
210e22d5e4fS猫头猫    }, []);
211e22d5e4fS猫头猫
212e22d5e4fS猫头猫    if (key) {
213e22d5e4fS猫头猫        return _cfg ? getPathValue(_cfg, key) : undefined;
214e22d5e4fS猫头猫    } else {
215e22d5e4fS猫头猫        return _cfg;
216e22d5e4fS猫头猫    }
217e22d5e4fS猫头猫}
218e22d5e4fS猫头猫
219e22d5e4fS猫头猫const Config = {
220e22d5e4fS猫头猫    get: getConfig,
221e22d5e4fS猫头猫    set: setConfig,
222e22d5e4fS猫头猫    useConfig,
2231f829e09S猫头猫    setup,
224e22d5e4fS猫头猫};
225e22d5e4fS猫头猫
226e22d5e4fS猫头猫export default Config;
227