aboutsummaryrefslogtreecommitdiff
path: root/src/api/SettingsStore.ts
blob: a5a0402cc6a35b8555837d807da7c67935a56206 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
/*
 * Vencord, a modification for Discord's desktop app
 * Copyright (c) 2023 Vendicated and contributors
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
*/

import Logger from "@utils/Logger";
import { proxyLazy } from "@utils/proxyLazy";
import { findModuleId, wreq } from "@webpack";

import { Settings } from "./settings";

interface Setting<T> {
    /**
     * Get the setting value
     */
    getSetting(): T;
    /**
     * Update the setting value
     * @param value The new value
     */
    updateSetting(value: T | ((old: T) => T)): Promise<void>;
    /**
     * React hook for automatically updating components when the setting is updated
     */
    useSetting(): T;
    settingsStoreApiGroup: string;
    settingsStoreApiName: string;
}

const SettingsStores: Array<Setting<any>> | undefined = proxyLazy(() => {
    const modId = findModuleId('"textAndImages","renderSpoilers"');
    if (modId == null) return new Logger("SettingsStoreAPI").error("Didn't find stores module.");

    const mod = wreq(modId);
    if (mod == null) return;

    return Object.values(mod).filter((s: any) => s?.settingsStoreApiGroup) as any;
});

/**
 * Get the store for a setting
 * @param group The setting group
 * @param name The name of the setting
 */
export function getSettingStore<T = any>(group: string, name: string): Setting<T> | undefined {
    if (!Settings.plugins.SettingsStoreAPI.enabled) throw new Error("Cannot use SettingsStoreAPI without setting as dependency.");

    return SettingsStores?.find(s => s?.settingsStoreApiGroup === group && s?.settingsStoreApiName === name);
}

/**
 * getSettingStore but lazy
 */
export function getSettingStoreLazy<T = any>(group: string, name: string) {
    return proxyLazy(() => getSettingStore<T>(group, name));
}