aboutsummaryrefslogtreecommitdiff
path: root/types/ext/anki-templates-internal.d.ts
blob: df1b2dfe98e35d6933a21d28ec4e5a0bc337a3af (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
/*
 * 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 AnkiTemplates from './anki-templates';
import type * as Dictionary from './dictionary';
import type * as Settings from './settings';

export type Context = {
    url: string;
    documentTitle: string;
    query: string;
    fullQuery: string;
    sentence: ContextSentence;
};

export type ContextSentence = {
    text?: string;
    offset?: number;
};

export type CreateModeNoTest = 'kanji' | 'term-kanji' | 'term-kana';

export type CreateMode = CreateModeNoTest | 'test';

export type CreateDetails = {
    /** The dictionary entry. */
    dictionaryEntry: Dictionary.DictionaryEntry;
    /** The result output mode. */
    resultOutputMode: Settings.ResultOutputMode;
    /** The mode being used to generate the Anki data. */
    mode: CreateMode;
    /** The glossary layout mode. */
    glossaryLayoutMode: Settings.GlossaryLayoutMode;
    /** Whether or not compact tags mode is enabled. */
    compactTags: boolean;
    /** Contextual information about the source of the dictionary entry. */
    context: Context;
    /** Media data. */
    media?: AnkiTemplates.Media;
    dictionaryStylesMap: Map<string, string>;
};

export type CachedValue<T = unknown> = {
    getter: () => T;
    hasValue: boolean;
    value: T | undefined;
};