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
|
/*
* 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 {Response} from 'core';
import type {RenderMode, NoteData} from 'anki-templates';
import type {CompositeRenderData, PartialOrCompositeRenderData, RenderMultiItem, RenderResult} from 'template-renderer';
import type {
ApiMap as BaseApiMap,
ApiMapInit as BaseApiMapInit,
ApiHandler as BaseApiHandler,
ApiParams as BaseApiParams,
ApiNames as BaseApiNames,
ApiReturn as BaseApiReturn,
ApiReturnAny as BaseApiReturnAny,
} from './api-map';
// Frontend API
type FrontendApiSurface = {
render: {
params: {
template: string;
data: PartialOrCompositeRenderData;
type: RenderMode;
};
return: RenderResult;
};
renderMulti: {
params: {
items: RenderMultiItem[];
};
return: Response<RenderResult>[];
};
getModifiedData: {
params: {
data: CompositeRenderData;
type: RenderMode;
};
return: NoteData;
};
};
type FrontendApiParams<TName extends FrontendApiNames> = BaseApiParams<FrontendApiSurface[TName]>;
type FrontendApiNames = BaseApiNames<FrontendApiSurface>;
type FrontendApiReturnAny = BaseApiReturnAny<FrontendApiSurface>;
export type FrontendMessage<TName extends FrontendApiNames> = {
action: TName;
params: FrontendApiParams<TName>;
id: string;
};
export type FrontendMessageAny = FrontendMessage<FrontendApiNames>;
export type FrontendApiReturn<TName extends FrontendApiNames> = BaseApiReturn<FrontendApiSurface[TName]>;
export type FrontendApiMap = BaseApiMap<FrontendApiSurface>;
export type FrontendApiMapInit = BaseApiMapInit<FrontendApiSurface>;
export type FrontendApiHandler<TName extends FrontendApiNames> = BaseApiHandler<FrontendApiSurface[TName]>;
// Backend API
export type BackendApiSurface = {
ready: {
params: void;
return: void;
};
response: {
params: Response<FrontendApiReturnAny>;
return: void;
};
};
type BackendApiNames = BaseApiNames<BackendApiSurface>;
type BackendApiParams<TName extends BackendApiNames> = BaseApiParams<BackendApiSurface[TName]>;
export type BackendMessage<TName extends BackendApiNames> = {
action: TName;
params: BackendApiParams<TName>;
id: string | null;
};
export type BackendMessageAny = BackendMessage<BackendApiNames>;
|