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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
|
/*
* 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 Dictionary from './dictionary';
import type * as DictionaryDatabase from './dictionary-database';
import type * as DictionaryImporter from './dictionary-importer';
import type * as Environment from './environment';
import type * as Translation from './translation';
import type * as Translator from './translator';
import type {
ApiMap as BaseApiMap,
ApiMapInit as BaseApiMapInit,
ApiHandler as BaseApiHandler,
ApiParams as BaseApiParams,
ApiReturn as BaseApiReturn,
ApiNames as BaseApiNames,
} from './api-map';
type ApiSurface = {
databasePrepareOffscreen: {
params: void;
return: void;
};
getDictionaryInfoOffscreen: {
params: void;
return: DictionaryImporter.Summary[];
};
databasePurgeOffscreen: {
params: void;
return: boolean;
};
databaseGetMediaOffscreen: {
params: {
targets: DictionaryDatabase.MediaRequest[];
};
return: DictionaryDatabase.Media<string>[];
};
translatorPrepareOffscreen: {
params: void;
return: void;
};
findKanjiOffscreen: {
params: {
text: string;
options: FindKanjiOptionsOffscreen;
};
return: Dictionary.KanjiDictionaryEntry[];
};
findTermsOffscreen: {
params: {
mode: Translator.FindTermsMode;
text: string;
options: FindTermsOptionsOffscreen;
};
return: Translator.FindTermsResult;
};
getTermFrequenciesOffscreen: {
params: {
termReadingList: Translator.TermReadingList;
dictionaries: string[];
};
return: Translator.TermFrequencySimple[];
};
clearDatabaseCachesOffscreen: {
params: void;
return: void;
};
clipboardSetBrowserOffscreen: {
params: {
value: Environment.Browser | null;
};
return: void;
};
clipboardGetTextOffscreen: {
params: {
useRichText: boolean;
};
return: string;
};
clipboardGetImageOffscreen: {
params: void;
return: string | null;
};
};
export type ApiMessage<TName extends ApiNames> = (
ApiParams<TName> extends void ?
{action: TName, params?: never} :
{action: TName, params: ApiParams<TName>}
);
export type ApiNames = BaseApiNames<ApiSurface>;
export type FindKanjiOptionsOffscreen = Omit<Translation.FindKanjiOptions, 'enabledDictionaryMap'> & {
enabledDictionaryMap: [
key: string,
options: Translation.FindKanjiDictionary,
][];
};
export type FindTermsOptionsOffscreen = Omit<Translation.FindTermsOptions, 'enabledDictionaryMap' | 'excludeDictionaryDefinitions' | 'textReplacements'> & {
enabledDictionaryMap: [
key: string,
options: Translation.FindTermDictionary,
][];
excludeDictionaryDefinitions: string[] | null;
textReplacements: (FindTermsTextReplacementOffscreen[] | null)[];
};
export type FindTermsTextReplacementOffscreen = Omit<Translation.FindTermsTextReplacement, 'pattern'> & {
pattern: string;
};
export type ApiMap = BaseApiMap<ApiSurface>;
export type ApiMapInit = BaseApiMapInit<ApiSurface>;
export type ApiHandler<TName extends ApiNames> = BaseApiHandler<ApiSurface[TName]>;
export type ApiParams<TName extends ApiNames> = BaseApiParams<ApiSurface[TName]>;
export type ApiReturn<TName extends ApiNames> = BaseApiReturn<ApiSurface[TName]>;
export type ApiMessageAny = {[name in ApiNames]: ApiMessage<name>}[ApiNames];
|