aboutsummaryrefslogtreecommitdiff
path: root/types/ext/settings-controller.d.ts
blob: aa6d29499d295b8cb5d63f79a640d12946c8ae7c (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
/*
 * Copyright (C) 2023-2024  Yomitan Authors
 *
 * 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 type {DictionaryController} from '../../ext/js/pages/settings/dictionary-controller';
import type {ScanInputsController} from '../../ext/js/pages/settings/scan-inputs-controller';
import type {ScanInputsSimpleController} from '../../ext/js/pages/settings/scan-inputs-simple-controller';
import type * as Core from './core';
import type * as Settings from './settings';
import type * as SettingsModifications from './settings-modifications';
import type {EventNames, EventArgument as BaseEventArgument} from './core';

export type PageExitPrevention = {
    end: () => void;
};

export type Events = {
    optionsChanged: {
        options: Settings.ProfileOptions;
        optionsContext: Settings.OptionsContext;
    };
    optionsContextChanged: Record<string, never>;
    permissionsChanged: {
        permissions: chrome.permissions.Permissions;
    };
    dictionarySettingsReordered: {
        source: DictionaryController;
    };
    scanInputsChanged: {
        source: ScanInputsController | ScanInputsSimpleController;
    };
};

export type EventArgument<TName extends EventNames<Events>> = BaseEventArgument<Events, TName>;

export type SettingsRead<THasScope extends boolean> = THasScope extends true ? SettingsModifications.ScopedRead : SettingsModifications.Read;

export type SettingsModification<THasScope extends boolean> = THasScope extends true ? SettingsModifications.ScopedModification : SettingsModifications.Modification;

export type SettingsExtraFields<THasScope extends boolean> = THasScope extends true ? null : SettingsModifications.OptionsScope;

export type ModifyResult = Core.Response<SettingsModifications.ModificationResult>;