aboutsummaryrefslogtreecommitdiff
path: root/types/ext/language-transformer.d.ts
blob: cf5a004106fa95c48858346eaeb6973c1ffb4e11 (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
74
/*
 * Copyright (C) 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/>.
 */

export type LanguageTransformDescriptor = {
    language: string;
    conditions: ConditionMapObject;
    transforms: {
        [name: string]: Transform;
    };
};

export type ConditionMapObject = {
    [type: string]: Condition;
};

export type ConditionMapEntry = [type: string, condition: Condition];

export type ConditionMapEntries = ConditionMapEntry[];

export type Condition = {
    name: string;
    isDictionaryForm: boolean;
    i18n?: RuleI18n[];
    subConditions?: string[];
};

export type RuleI18n = {
    language: string;
    name: string;
};

export type Transform = {
    name: string;
    description?: string;
    i18n?: TransformI18n[];
    rules: Rule[];
};

export type TransformI18n = {
    language: string;
    name: string;
    description?: string;
};

export type Rule = {
    type: 'suffix' | 'prefix' | 'wholeWord' | 'other';
    isInflected: RegExp;
    deinflect: (inflectedWord: string) => string;
    conditionsIn: string[];
    conditionsOut: string[];
};

export type SuffixRule = {
    type: 'suffix';
    isInflected: RegExp;
    deinflected: string;
    deinflect: (inflectedWord: string) => string;
    conditionsIn: string[];
    conditionsOut: string[];
};