aboutsummaryrefslogtreecommitdiff
path: root/types/ext/audio-downloader.d.ts
blob: bbf7afbc096718eeebb70cd355802be4e435572c (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
76
77
78
79
80
81
82
/*
 * 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 Audio from './audio';
import type * as Language from './language';

export type GetInfoHandler = (
    term: string,
    reading: string,
    details?: Audio.AudioSourceInfo,
    languageSummary?: Language.LanguageSummary,
) => Promise<Info[]>;

export type Info = Info1 | Info2;

export type Info1 = {
    type: 'url';
    url: string;
    name?: string;
};

export type Info2 = {
    type: 'tts';
    text: string;
    voice: string;
    name?: undefined;
};

export type AudioBinaryBase64 = {
    data: string;
    contentType: string | null;
};

export type CustomAudioList = {
    type: 'audioSourceList';
    audioSources: CustomAudioListSource[];
};

export type CustomAudioListSource = {
    url: string;
    name?: string;
};

export type WikimediaCommonsLookupResponse = {
    query: {
        search: WikimediaCommonsLookupResult[];
    };
};

export type WikimediaCommonsFileResponse = {
    query: {
        pages: Record<string, WikimediaCommonsFileResult>;
    };
};

export type WikimediaCommonsLookupResult = {
    title: string;
};

export type WikimediaCommonsFileResult = {
    title: string;
    imageinfo: WikimediaCommonsFileResultImageInfo[];
};

export type WikimediaCommonsFileResultImageInfo = {
    url: string;
    user: string;
};