/
api.mts
230 lines (183 loc) · 8.07 KB
/
api.mts
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
/*
This file is part of Talkie -- text-to-speech browser extension button.
<https://joelpurra.com/projects/talkie/>
Copyright (c) 2016, 2017, 2018, 2019, 2020, 2021 Joel Purra <https://joelpurra.com/>
Talkie 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.
Talkie 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 Talkie. If not, see <https://www.gnu.org/licenses/>.
*/
// TODO: implement or remove placeholder file.
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-nocheck
import {
EditionType,
IMetadataManager,
OsType,
SystemType,
} from "@talkie/shared-interfaces/imetadata-manager.mjs";
import {
LanguageTextDirection,
TalkieLocale,
} from "@talkie/shared-interfaces/italkie-locale.mjs";
import ITalkieLocaleHelper from "@talkie/shared-interfaces/italkie-locale-helper.mjs";
import {
IVoiceNameAndRateAndPitch,
SafeVoiceObject,
} from "@talkie/shared-interfaces/ivoices.mjs";
import {
KillSwitch,
} from "@talkie/shared-interfaces/killswitch.mjs";
import {
knownEventNames,
} from "@talkie/shared-interfaces/known-events.mjs";
import {
ListeningActionHandler,
} from "@talkie/shared-interfaces/listening-action-handler.mjs";
import IApi from "@talkie/split-environment-interfaces/iapi.mjs";
import ILocaleProvider from "@talkie/split-environment-interfaces/ilocale-provider.mjs";
import type {
JsonValue,
ReadonlyDeep,
} from "type-fest";
import type {
Tabs,
} from "webextension-polyfill";
export default class Api implements IApi {
constructor(private readonly metadataManager: IMetadataManager, private readonly talkieLocaleHelper: ITalkieLocaleHelper, private readonly localeProvider: ILocaleProvider) {}
getConfigurationValueSync<T extends JsonValue>(systemType: SystemType, path: string): T {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async getConfigurationValue<T>(configurationPath: string): Promise<T> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async iconClick(): Promise<void> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async debouncedSpeakTextInCustomVoice(text: string, voice: ReadonlyDeep<IVoiceNameAndRateAndPitch>): Promise<void> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async debouncedSpeakTextInVoiceWithOverrides(text: string, voiceName: string): Promise<void> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async debouncedSpeakTextInLanguageWithOverrides(text: string, languageCode: string): Promise<void> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async speakInCustomVoice(text: string, voice: ReadonlyDeep<IVoiceNameAndRateAndPitch>): Promise<void> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async speakTextInVoiceWithOverrides(text: string, voiceName: string): Promise<void> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async speakTextInLanguageWithOverrides(text: string, languageCode: string): Promise<void> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async getVoices(): Promise<SafeVoiceObject[]> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async getIsPremiumEditionOption(): Promise<boolean> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async setIsPremiumEditionOption(isPremiumEdition: boolean): Promise<void> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async getSpeakLongTextsOption(): Promise<boolean> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async setSpeakLongTextsOption(speakLongTexts: boolean): Promise<void> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async getShowAdditionalDetailsOption(): Promise<boolean> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async setShowAdditionalDetailsOption(showAdditionalDetails: boolean): Promise<void> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async getEffectiveVoiceForLanguage(languageCode: string): Promise<string | null> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async getEffectiveRateForVoice(voiceName: string): Promise<number> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async setVoiceRateOverride(voiceName: string, rate: number): Promise<void> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async getEffectivePitchForVoice(voiceName: string): Promise<number> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async setVoicePitchOverride(voiceName: string, pitch: number): Promise<void> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async toggleLanguageVoiceOverrideName(languageCode: string, voiceName: string): Promise<boolean> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async getTranslatedLanguages(): Promise<TalkieLocale[]> {
// TODO: separate "background API" from other functionality.
return this.talkieLocaleHelper.getTranslatedLanguages();
}
async isPremiumEdition(): Promise<boolean> {
// TODO: separate "background API" from other functionality.
return this.metadataManager.isPremiumEdition();
}
async getVersionName(): Promise<string | null> {
// TODO: separate "background API" from other functionality.
return this.metadataManager.getVersionName();
}
async getVersionNumber(): Promise<string | null> {
// TODO: separate "background API" from other functionality.
return this.metadataManager.getVersionNumber();
}
async getEditionType(): Promise<EditionType> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async getSystemType(): Promise<SystemType> {
// TODO: separate "background API" from other functionality.
return this.metadataManager.getSystemType();
}
async getOperatingSystemType(): Promise<OsType> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async openUrlInNewTab(url: string): Promise<Tabs.Tab> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async openShortKeysConfiguration(): Promise<Tabs.Tab> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async openOptionsPage(): Promise<void> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async registerListeningAction<TEvent extends knownEventNames, TData, TReturn>(actionName: TEvent, listeningActionHandler: ListeningActionHandler<TEvent, TData, TReturn>): Promise<KillSwitch> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async getLocationHash(): Promise<string | null> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async setLocationHash(locationHash: string): Promise<void> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async getBidiDirection(talkieLocale: TalkieLocale): Promise<LanguageTextDirection> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async getSampleText(talkieLocale: TalkieLocale): Promise<string> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async isTalkieLocale(languageGroup: string): Promise<boolean> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async getTranslationLocale(): Promise<TalkieLocale> {
// TODO: separate "background API" from other functionality.
return this.localeProvider.getTranslationLocale();
}
async getNavigatorLanguage(): Promise<Readonly<string | null>> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
async getNavigatorLanguages(): Promise<Readonly<string[]>> {
throw new Error(`Not implemented. ${JSON.stringify(arguments)}`);
}
}