aboutsummaryrefslogtreecommitdiff
path: root/types/ext/popup-preview-frame.d.ts
blob: 4b4f3009dfa8d6eb45b97c625a2c683ab3a92897 (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
75
/*
 * 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/>.
 */

import type {
    ApiMap as BaseApiMap,
    ApiHandler as BaseApiHandler,
    ApiParams as BaseApiParams,
    ApiNames as BaseApiNames,
    ApiReturn as BaseApiReturn,
} from './api-map';
import type {OptionsContext} from './settings';

export type ApiSurface = {
    setText: {
        params: {
            text: string;
        };
        return: void;
    };
    setCustomCss: {
        params: {
            css: string;
        };
        return: void;
    };
    setCustomOuterCss: {
        params: {
            css: string;
        };
        return: void;
    };
    updateOptionsContext: {
        params: {
            optionsContext: OptionsContext;
        };
        return: void;
    };
    setLanguageExampleText: {
        params: {
            language: string;
        };
        return: void;
    };
};

export type ApiParams<TName extends ApiNames> = BaseApiParams<ApiSurface[TName]>;

export type ApiNames = BaseApiNames<ApiSurface>;

export type ApiMap = BaseApiMap<ApiSurface>;

export type ApiHandler<TName extends ApiNames> = BaseApiHandler<ApiSurface[TName]>;

export type ApiReturn<TName extends ApiNames> = BaseApiReturn<ApiSurface[TName]>;

type ApiMessage<TName extends ApiNames> = {
    action: TName;
    params: ApiParams<TName>;
};

export type ApiMessageAny = {[name in ApiNames]: ApiMessage<name>}[ApiNames];