aboutsummaryrefslogtreecommitdiff
path: root/types/ext/profile-conditions-ui.d.ts
blob: 0193d4d71b7a59cae3e3dd8aaf2727a3d0ec8538 (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
70
71
72
73
/*
 * 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 * as Settings from './settings';
import type {EventNames, EventArgument as BaseEventArgument} from './core';

export type Events = {
    conditionGroupCountChanged: {
        count: number;
        profileIndex: number;
    };
};

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

export type DescriptorType = Settings.ProfileConditionType;

export type Descriptor = {
    displayName: string;
    defaultOperator: string;
    operators: Map<string, OperatorInternal>;
};

export type ValidateFunction = (value: string) => boolean;

export type NormalizeFunction = (value: unknown) => string;

export type OperatorInternal = {
    displayName: string;
    type: string;
    defaultValue: string;
    resetDefaultOnChange?: boolean;
    validate?: ValidateFunction;
    normalize?: NormalizeFunction;
};

export type Operator = {
    displayName: string;
    type: string;
    defaultValue: string;
    resetDefaultOnChange: boolean | null;
    validate: ValidateFunction | null;
    normalize: NormalizeFunction | null;
};

export type DescriptorInfo = {
    name: DescriptorType;
    displayName: string;
};

export type OperatorInfo = {
    name: string;
    displayName: string;
};

export type InputData = {
    validate: ValidateFunction | null;
    normalize: NormalizeFunction | null;
};