@uptime.app/contracts 1.0.37 → 1.0.38-rc.0

package/src/segment/segment.ts

@@ -1,82 +1,82 @@
-export interface SegmentVoice {
-    id: string;
-    language: string;
-    name: string;
-    countryCode: string;
-    speechProvider: string;
-}
-
-export interface Segment {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
-    hackId: string;
-    type: SegmentType;
-    title: string;
-    sections: SegmentSection[];
-    keywords: string[];
-    actions: SegmentAction[];
-    speech: SegmentSpeech[];
-    textSummary?: string;
-    lastUpdatedFromPendingSegmentId?: string;
-    hackType: string;
-    /** use @uptime.app/text-to-speech-contracts */
-    locale: string;
-}
-
-export type SegmentType =
-    'overview' | 'favourite-quote' | 'in-a-nutshell' |
-    'introduction' | 'here-are-the-insights' |
-    'insight-one' | 'insight-two' | 'insight-three' |
-    'put-in-action' | 'conclusion' |
-    'shareable-overview' | 'download-app-to-see-more';
-
-export type CardType = 'hack-cover' | 'action';
-
-export interface SegmentAction {
-    title: string;
-    cards: SegmentTextCard[];
-}
-
-export interface SegmentTextCard {
-    id: string;
-    markdown: string;
-    segmentType: SegmentType;
-    cardType?: CardType;
-    isTitle?: boolean;
-    speech?: TextCardSpeech[];
-}
-
-export interface SegmentSection {
-    heading?: string;
-    cards: SegmentTextCard[];
-}
-
-export interface SegmentSpeech {
-    voice: SegmentVoice;
-    withHeading: {
-        url: string;
-        lengthSeconds: number;
-    };
-    withoutHeading: {
-        url: string;
-        lengthSeconds: number;
-    };
-}
-
-export interface TextCardSpeech {
-    voiceId: string;
-    withHeading: {
-        timestamps: {
-            startsAt: number;
-            endsAt: number;
-        };
-    };
-    withoutHeading: {
-        timestamps: {
-            startsAt: number;
-            endsAt: number;
-        };
-    };
-}
+export interface SegmentVoice {
+    id: string;
+    language: string;
+    name: string;
+    countryCode: string;
+    speechProvider: string;
+}
+
+export interface Segment {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
+    hackId: string;
+    type: SegmentType;
+    title: string;
+    sections: SegmentSection[];
+    keywords: string[];
+    actions: SegmentAction[];
+    speech: SegmentSpeech[];
+    textSummary?: string;
+    lastUpdatedFromPendingSegmentId?: string;
+    hackType: string;
+    /** use @uptime.app/text-to-speech-contracts */
+    locale: string;
+}
+
+export type SegmentType =
+    'overview' | 'favourite-quote' | 'in-a-nutshell' |
+    'introduction' | 'here-are-the-insights' |
+    'insight-one' | 'insight-two' | 'insight-three' |
+    'put-in-action' | 'conclusion' |
+    'shareable-overview' | 'download-app-to-see-more';
+
+export type CardType = 'hack-cover' | 'action';
+
+export interface SegmentAction {
+    title: string;
+    cards: SegmentTextCard[];
+}
+
+export interface SegmentTextCard {
+    id: string;
+    markdown: string;
+    segmentType: SegmentType;
+    cardType?: CardType;
+    isTitle?: boolean;
+    speech?: TextCardSpeech[];
+}
+
+export interface SegmentSection {
+    heading?: string;
+    cards: SegmentTextCard[];
+}
+
+export interface SegmentSpeech {
+    voice: SegmentVoice;
+    withHeading: {
+        url: string;
+        lengthSeconds: number;
+    };
+    withoutHeading: {
+        url: string;
+        lengthSeconds: number;
+    };
+}
+
+export interface TextCardSpeech {
+    voiceId: string;
+    withHeading: {
+        timestamps: {
+            startsAt: number;
+            endsAt: number;
+        };
+    };
+    withoutHeading: {
+        timestamps: {
+            startsAt: number;
+            endsAt: number;
+        };
+    };
+}

package/src/skin/skin-events.ts

@@ -1,21 +1,21 @@
-import { Skin } from './skin';
-
-export interface SkinCreatedEvent {
-    id: string;
-    type: 'SkinCreated';
-    payload: Skin;
-}
-
-export interface SkinUpdatedEvent {
-    id: string;
-    type: 'SkinUpdated';
-    payload: Skin;
-}
-
-export interface SkinDeletedEvent {
-    id: string;
-    type: 'SkinDeleted';
-    payload: Skin;
-}
-
-export type SkinChangedEvent = SkinCreatedEvent | SkinUpdatedEvent | SkinDeletedEvent;
+import { Skin } from './skin';
+
+export interface SkinCreatedEvent {
+    id: string;
+    type: 'SkinCreated';
+    payload: Skin;
+}
+
+export interface SkinUpdatedEvent {
+    id: string;
+    type: 'SkinUpdated';
+    payload: Skin;
+}
+
+export interface SkinDeletedEvent {
+    id: string;
+    type: 'SkinDeleted';
+    payload: Skin;
+}
+
+export type SkinChangedEvent = SkinCreatedEvent | SkinUpdatedEvent | SkinDeletedEvent;

package/src/skin/skin.ts

@@ -1,7 +1,7 @@
-
-export interface Skin {
-    id: string;
-    v: number;
-    createdAt: string;
-    updatedAt: string;
+
+export interface Skin {
+    id: string;
+    v: number;
+    createdAt: string;
+    updatedAt: string;
 }

package/src/text-to-speech/create-speech-commands.ts

@@ -1,20 +1,20 @@
-import { TextSegment, Voice } from './text-segment';
-
-export interface CreateSpeechFromTextCommand {
-    id: string;
-    type: 'CreateSpeechFromText';
-    payload: {
-        locale: string;
-        textSegments: TextSegment[];
-    };
-}
-
-export interface CreateSpeechWithVoiceCommand {
-    id: string;
-    type: 'CreateSpeechWithVoice';
-    payload: {
-        locale: string;
-        textSegments: TextSegment[];
-        voice: Voice;
-    };
-}
+import { TextSegment, Voice } from './text-segment';
+
+export interface CreateSpeechFromTextCommand {
+    id: string;
+    type: 'CreateSpeechFromText';
+    payload: {
+        locale: string;
+        textSegments: TextSegment[];
+    };
+}
+
+export interface CreateSpeechWithVoiceCommand {
+    id: string;
+    type: 'CreateSpeechWithVoice';
+    payload: {
+        locale: string;
+        textSegments: TextSegment[];
+        voice: Voice;
+    };
+}

package/src/text-to-speech/speech-created-events.ts

@@ -1,10 +1,10 @@
-import { TextSegmentWithSpeech } from './text-segment';
-
-export interface SpeechFromTextCreatedEvent {
-    id: string;
-    type: 'SpeechFromTextCreated';
-    payload: {
-        locale: string;
-        textSegments: TextSegmentWithSpeech[];
-    };
-}
+import { TextSegmentWithSpeech } from './text-segment';
+
+export interface SpeechFromTextCreatedEvent {
+    id: string;
+    type: 'SpeechFromTextCreated';
+    payload: {
+        locale: string;
+        textSegments: TextSegmentWithSpeech[];
+    };
+}

package/src/text-to-speech/supported-voices.ts

@@ -1,127 +1,127 @@
-import { SupportedLocale } from '../localisation/supported-locales';
-import { SupportedSpeechProvider, Voice } from './text-segment';
-
-const britishSonia: Voice = { id: 'en-GB-SoniaNeural', name: 'Sonia', countryCode: 'GB', language: 'en-GB', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const britishRyan: Voice = { id: 'en-GB-RyanNeural', name: 'Ryan', countryCode: 'GB', language: 'en-GB', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-
-const americanNancy: Voice = { id: 'en-US-NancyNeural', name: 'Nancy', countryCode: 'US', language: 'en-US', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const americanSara: Voice = { id: 'en-US-SaraNeural', name: 'Sara', countryCode: 'US', language: 'en-US', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const americanChristopher: Voice = { id: 'en-US-ChristopherNeural', name: 'Christopher', countryCode: 'US', language: 'en-US', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const americanTony: Voice = { id: 'en-US-TonyNeural', name: 'Tony', countryCode: 'US', language: 'en-US', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-
-const brazilianBrenda: Voice = { id: 'pt-BR-BrendaNeural', name: 'Brenda', countryCode: 'BR', language: 'pt-BR', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const brazilianGiovanna: Voice = { id: 'pt-BR-GiovannaNeural', name: 'Giovanna', countryCode: 'BR', language: 'pt-BR', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const brazilianAntonio: Voice = { id: 'pt-BR-AntonioNeural', name: 'Antonio', countryCode: 'BR', language: 'pt-BR', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const brazilianHumberto: Voice = { id: 'pt-BR-HumbertoNeural', name: 'Humberto', countryCode: 'BR', language: 'pt-BR', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-
-const mexicanBeatriz: Voice = { id: 'es-MX-BeatrizNeural', name: 'Beatriz', countryCode: 'MX', language: 'es', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const mexicanCecilio: Voice = { id: 'es-MX-CecilioNeural', name: 'Cecilio', countryCode: 'MX', language: 'es', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const spanishAbril: Voice = { id: 'es-ES-AbrilNeural', name: 'Abril', countryCode: 'ES', language: 'es', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const spanishAlvaro: Voice = { id: 'es-ES-AlvaroNeural', name: 'Alvaro', countryCode: 'ES', language: 'es', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const latamPaloma: Voice = { id: 'es-US-PalomaNeural', name: 'Paloma', countryCode: 'LATAM', language: 'es', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const latamAlonso: Voice = { id: 'es-US-AlonsoNeural', name: 'Alonso', countryCode: 'LATAM', language: 'es', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-
-const frenchHenri: Voice = { id: 'fr-FR-HenriNeural', name: 'Henri', countryCode: 'FR', language: 'fr-FR', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const frenchJerome: Voice = { id: 'fr-FR-JeromeNeural', name: 'Jerome', countryCode: 'FR', language: 'fr-FR', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const frenchJacqueline: Voice = { id: 'fr-FR-JacquelineNeural', name: 'Jacqueline', countryCode: 'FR', language: 'fr-FR', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const belgianCharline: Voice = { id: 'fr-BE-CharlineNeural', name: 'Charline', countryCode: 'BE', language: 'fr-FR', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-
-const italianElsa: Voice = { id: 'it-IT-ElsaNeural', name: 'Elsa', countryCode: 'IT', language: 'it-IT', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const italianFabiola: Voice = { id: 'it-IT-FabiolaNeural', name: 'Fabiola', countryCode: 'IT', language: 'it-IT', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const italianCalimero: Voice = { id: 'it-IT-CalimeroNeural', name: 'Calimero', countryCode: 'IT', language: 'it-IT', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const italianCataldo: Voice = { id: 'it-IT-CataldoNeural', name: 'Cataldo', countryCode: 'IT', language: 'it-IT', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-
-const dutchColette: Voice = { id: 'nl-NL-ColetteNeural', name: 'Colette', countryCode: 'NL', language: 'nl-NL', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const dutchMaarten: Voice = { id: 'nl-NL-MaartenNeural', name: 'Maarten', countryCode: 'NL', language: 'nl-NL', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const dutchFenna: Voice = { id: 'nl-NL-FennaNeural', name: 'Fenna', countryCode: 'NL', language: 'nl-NL', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-
-const germanKatja: Voice = { id: 'de-DE-KatjaNeural', name: 'Katja', countryCode: 'DE', language: 'de-DE', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const germanConrad: Voice = { id: 'de-DE-ConradNeural', name: 'Conrad', countryCode: 'DE', language: 'de-DE', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const germanChristoph: Voice = { id: 'de-DE-ChristophNeural', name: 'Christoph', countryCode: 'DE', language: 'de-DE', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const germanElke: Voice = { id: 'de-DE-ElkeNeural', name: 'Elke', countryCode: 'DE', language: 'de-DE', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-
-const polishZofia: Voice = { id: 'pl-PL-ZofiaNeural', name: 'Zofia', countryCode: 'PL', language: 'pl-PL', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const polishMarek: Voice = { id: 'pl-PL-MarekNeural', name: 'Marek', countryCode: 'PL', language: 'pl-PL', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-
-const swedishSofie: Voice = { id: 'sv-SE-SofieNeural', name: 'Sofie', countryCode: 'SV', language: 'sv-SE', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const swedishMattias: Voice = { id: 'sv-SE-MattiasNeural', name: 'Mattias', countryCode: 'SV', language: 'sv-SE', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-
-const turkishAhmet: Voice = { id: 'tr-TR-AhmetNeural', name: 'Ahmet', countryCode: 'TR', language: 'tr-TR', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const turkishEmel: Voice = { id: 'tr-TR-EmelNeural', name: 'Emel', countryCode: 'TR', language: 'tr-TR', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-
-const canadianFrenchSylvie: Voice = { id: 'fr-CA-SylvieNeural', name: 'Sylvie', countryCode: 'CA', language: 'fr-CA', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const canadianFrenchThierry: Voice = { id: 'fr-CA-ThierryNeural', name: 'Thierry', countryCode: 'CA', language: 'fr-CA', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const canadianFrenchAntoine: Voice = { id: 'fr-CA-AntoineNeural', name: 'Antoine', countryCode: 'CA', language: 'fr-CA', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const canadianFrenchJean: Voice = { id: 'fr-CA-JeanNeural', name: 'Jean', countryCode: 'CA', language: 'fr-CA', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-
-const chineseSimplifiedXiaochen: Voice = { id: 'zh-CN-XiaochenNeural', name: 'Xiaochen', countryCode: 'CN', language: 'zh-CN', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const chineseSimplifiedXiaoyan: Voice = { id: 'zh-CN-XiaoyanNeural', name: 'Xiaoyan', countryCode: 'CN', language: 'zh-CN', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const chineseSimplifiedYunye: Voice = { id: 'zh-CN-YunyeNeural', name: 'Yunye', countryCode: 'CN', language: 'zh-CN', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const chineseSimplifiedYunyang: Voice = { id: 'zh-CN-YunyangNeural', name: 'Yunyang', countryCode: 'CN', language: 'zh-CN', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-
-const chineseTraditionalXiaochen: Voice = { id: 'zh-CN-XiaochenNeural', name: 'Xiaochen', countryCode: 'CN', language: 'zh-TW', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const chineseTraditionalXiaoyan: Voice = { id: 'zh-CN-XiaoyanNeural', name: 'Xiaoyan', countryCode: 'CN', language: 'zh-TW', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const chineseTraditionalYunye: Voice = { id: 'zh-CN-YunyeNeural', name: 'Yunye', countryCode: 'CN', language: 'zh-TW', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const chineseTraditionalYunyang: Voice = { id: 'zh-CN-YunyangNeural', name: 'Yunyang', countryCode: 'CN', language: 'zh-TW', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const chineseTraditionalYunSong: Voice = { id: 'yue-CN-YunSongNeural', name: 'YunSong', countryCode: 'CN', language: 'zh-TW', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const chineseTraditionalHiuGaai: Voice = { id: 'zh-HK-HiuGaaiNeural', name: 'HiuGaai', countryCode: 'CN', language: 'zh-TW', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-
-const norwegianPernille: Voice = { id: 'nb-NO-PernilleNeural', name: 'Pernille', countryCode: 'NO', language: 'nb-NO', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const norwegianFinn: Voice = { id: 'nb-NO-FinnNeural', name: 'Finn', countryCode: 'NO', language: 'nb-NO', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-
-const malaysianYasmin: Voice = { id: 'ms-MY-YasminNeural', name: 'Yasmin', countryCode: 'MY', language: 'ms-MY', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-const malaysianOsman: Voice = { id: 'ms-MY-OsmanNeural', name: 'Osman', countryCode: 'MY', language: 'ms-MY', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
-
-const voicesForLocales = new Map<string, Voice[]>([
-    [SupportedLocale.enGB, [britishSonia, britishRyan, americanNancy, americanSara, americanChristopher, americanTony]],
-    [SupportedLocale.enUS, [britishSonia, britishRyan, americanNancy, americanSara, americanChristopher, americanTony]],
-    [SupportedLocale.ptBR, [brazilianBrenda, brazilianGiovanna, brazilianAntonio, brazilianHumberto]],
-    [SupportedLocale.es, [mexicanBeatriz, mexicanCecilio, spanishAbril, spanishAlvaro, latamPaloma, latamAlonso]],
-    [SupportedLocale.frFR, [frenchHenri, frenchJerome, frenchJacqueline, belgianCharline]],
-    [SupportedLocale.itIT, [italianElsa, italianFabiola, italianCalimero, italianCataldo]],
-    [SupportedLocale.nlNL, [dutchColette, dutchMaarten, dutchFenna]],
-    [SupportedLocale.deDE, [germanKatja, germanConrad, germanChristoph, germanElke]],
-    [SupportedLocale.plPL, [polishZofia, polishMarek]],
-    [SupportedLocale.svSE, [swedishSofie, swedishMattias]],
-    [SupportedLocale.trTR, [turkishAhmet, turkishEmel]],
-    [SupportedLocale.frCA, [canadianFrenchSylvie, canadianFrenchThierry, canadianFrenchAntoine, canadianFrenchJean]],
-    [SupportedLocale.zhCN, [chineseSimplifiedXiaochen, chineseSimplifiedXiaoyan, chineseSimplifiedYunye, chineseSimplifiedYunyang]],
-    [SupportedLocale.zhTW, [chineseTraditionalXiaochen, chineseTraditionalXiaoyan, chineseTraditionalYunye, chineseTraditionalYunyang, chineseTraditionalYunSong, chineseTraditionalHiuGaai]],
-    [SupportedLocale.nbNO, [norwegianPernille, norwegianFinn]],
-    [SupportedLocale.msMY, [malaysianYasmin, malaysianOsman]]
-]);
-
-const defaultVoiceForLocales = new Map<string, Voice>([
-    [SupportedLocale.enGB, americanSara],
-    [SupportedLocale.enUS, americanSara],
-    [SupportedLocale.ptBR, brazilianHumberto],
-    [SupportedLocale.es, latamPaloma],
-    [SupportedLocale.frFR, frenchJacqueline],
-    [SupportedLocale.itIT, italianElsa],
-    [SupportedLocale.nlNL, dutchColette],
-    [SupportedLocale.deDE, germanKatja],
-    [SupportedLocale.plPL, polishZofia],
-    [SupportedLocale.svSE, swedishSofie],
-    [SupportedLocale.trTR, turkishAhmet],
-    [SupportedLocale.frCA, canadianFrenchSylvie],
-    [SupportedLocale.zhCN, chineseSimplifiedXiaochen],
-    [SupportedLocale.zhTW, chineseTraditionalXiaochen],
-    [SupportedLocale.nbNO, norwegianPernille],
-    [SupportedLocale.msMY, malaysianYasmin]
-]);
-
-export function getSupportedVoices(locale: string): Voice[] {
-    const voices = voicesForLocales.get(locale);
-    if (!voices) {
-        throw new Error(`Cannot list supported voices. Unsupported locale: ${JSON.stringify(locale)}`);
-    }
-    return voices;
-}
-
-export function getDefaultVoice(locale: string): Voice {
-    const voice = defaultVoiceForLocales.get(locale);
-    if (!voice) {
-        throw new Error(`Cannot find default voice. Unsupported locale: ${JSON.stringify(locale)}`);
-    }
-    return voice;
-}
+import { SupportedLocale } from '../localisation/supported-locales';
+import { SupportedSpeechProvider, Voice } from './text-segment';
+
+const britishSonia: Voice = { id: 'en-GB-SoniaNeural', name: 'Sonia', countryCode: 'GB', language: 'en-GB', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const britishRyan: Voice = { id: 'en-GB-RyanNeural', name: 'Ryan', countryCode: 'GB', language: 'en-GB', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+
+const americanNancy: Voice = { id: 'en-US-NancyNeural', name: 'Nancy', countryCode: 'US', language: 'en-US', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const americanSara: Voice = { id: 'en-US-SaraNeural', name: 'Sara', countryCode: 'US', language: 'en-US', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const americanChristopher: Voice = { id: 'en-US-ChristopherNeural', name: 'Christopher', countryCode: 'US', language: 'en-US', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const americanTony: Voice = { id: 'en-US-TonyNeural', name: 'Tony', countryCode: 'US', language: 'en-US', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+
+const brazilianBrenda: Voice = { id: 'pt-BR-BrendaNeural', name: 'Brenda', countryCode: 'BR', language: 'pt-BR', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const brazilianGiovanna: Voice = { id: 'pt-BR-GiovannaNeural', name: 'Giovanna', countryCode: 'BR', language: 'pt-BR', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const brazilianAntonio: Voice = { id: 'pt-BR-AntonioNeural', name: 'Antonio', countryCode: 'BR', language: 'pt-BR', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const brazilianHumberto: Voice = { id: 'pt-BR-HumbertoNeural', name: 'Humberto', countryCode: 'BR', language: 'pt-BR', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+
+const mexicanBeatriz: Voice = { id: 'es-MX-BeatrizNeural', name: 'Beatriz', countryCode: 'MX', language: 'es', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const mexicanCecilio: Voice = { id: 'es-MX-CecilioNeural', name: 'Cecilio', countryCode: 'MX', language: 'es', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const spanishAbril: Voice = { id: 'es-ES-AbrilNeural', name: 'Abril', countryCode: 'ES', language: 'es', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const spanishAlvaro: Voice = { id: 'es-ES-AlvaroNeural', name: 'Alvaro', countryCode: 'ES', language: 'es', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const latamPaloma: Voice = { id: 'es-US-PalomaNeural', name: 'Paloma', countryCode: 'LATAM', language: 'es', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const latamAlonso: Voice = { id: 'es-US-AlonsoNeural', name: 'Alonso', countryCode: 'LATAM', language: 'es', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+
+const frenchHenri: Voice = { id: 'fr-FR-HenriNeural', name: 'Henri', countryCode: 'FR', language: 'fr-FR', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const frenchJerome: Voice = { id: 'fr-FR-JeromeNeural', name: 'Jerome', countryCode: 'FR', language: 'fr-FR', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const frenchJacqueline: Voice = { id: 'fr-FR-JacquelineNeural', name: 'Jacqueline', countryCode: 'FR', language: 'fr-FR', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const belgianCharline: Voice = { id: 'fr-BE-CharlineNeural', name: 'Charline', countryCode: 'BE', language: 'fr-FR', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+
+const italianElsa: Voice = { id: 'it-IT-ElsaNeural', name: 'Elsa', countryCode: 'IT', language: 'it-IT', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const italianFabiola: Voice = { id: 'it-IT-FabiolaNeural', name: 'Fabiola', countryCode: 'IT', language: 'it-IT', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const italianCalimero: Voice = { id: 'it-IT-CalimeroNeural', name: 'Calimero', countryCode: 'IT', language: 'it-IT', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const italianCataldo: Voice = { id: 'it-IT-CataldoNeural', name: 'Cataldo', countryCode: 'IT', language: 'it-IT', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+
+const dutchColette: Voice = { id: 'nl-NL-ColetteNeural', name: 'Colette', countryCode: 'NL', language: 'nl-NL', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const dutchMaarten: Voice = { id: 'nl-NL-MaartenNeural', name: 'Maarten', countryCode: 'NL', language: 'nl-NL', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const dutchFenna: Voice = { id: 'nl-NL-FennaNeural', name: 'Fenna', countryCode: 'NL', language: 'nl-NL', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+
+const germanKatja: Voice = { id: 'de-DE-KatjaNeural', name: 'Katja', countryCode: 'DE', language: 'de-DE', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const germanConrad: Voice = { id: 'de-DE-ConradNeural', name: 'Conrad', countryCode: 'DE', language: 'de-DE', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const germanChristoph: Voice = { id: 'de-DE-ChristophNeural', name: 'Christoph', countryCode: 'DE', language: 'de-DE', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const germanElke: Voice = { id: 'de-DE-ElkeNeural', name: 'Elke', countryCode: 'DE', language: 'de-DE', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+
+const polishZofia: Voice = { id: 'pl-PL-ZofiaNeural', name: 'Zofia', countryCode: 'PL', language: 'pl-PL', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const polishMarek: Voice = { id: 'pl-PL-MarekNeural', name: 'Marek', countryCode: 'PL', language: 'pl-PL', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+
+const swedishSofie: Voice = { id: 'sv-SE-SofieNeural', name: 'Sofie', countryCode: 'SV', language: 'sv-SE', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const swedishMattias: Voice = { id: 'sv-SE-MattiasNeural', name: 'Mattias', countryCode: 'SV', language: 'sv-SE', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+
+const turkishAhmet: Voice = { id: 'tr-TR-AhmetNeural', name: 'Ahmet', countryCode: 'TR', language: 'tr-TR', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const turkishEmel: Voice = { id: 'tr-TR-EmelNeural', name: 'Emel', countryCode: 'TR', language: 'tr-TR', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+
+const canadianFrenchSylvie: Voice = { id: 'fr-CA-SylvieNeural', name: 'Sylvie', countryCode: 'CA', language: 'fr-CA', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const canadianFrenchThierry: Voice = { id: 'fr-CA-ThierryNeural', name: 'Thierry', countryCode: 'CA', language: 'fr-CA', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const canadianFrenchAntoine: Voice = { id: 'fr-CA-AntoineNeural', name: 'Antoine', countryCode: 'CA', language: 'fr-CA', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const canadianFrenchJean: Voice = { id: 'fr-CA-JeanNeural', name: 'Jean', countryCode: 'CA', language: 'fr-CA', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+
+const chineseSimplifiedXiaochen: Voice = { id: 'zh-CN-XiaochenNeural', name: 'Xiaochen', countryCode: 'CN', language: 'zh-CN', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const chineseSimplifiedXiaoyan: Voice = { id: 'zh-CN-XiaoyanNeural', name: 'Xiaoyan', countryCode: 'CN', language: 'zh-CN', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const chineseSimplifiedYunye: Voice = { id: 'zh-CN-YunyeNeural', name: 'Yunye', countryCode: 'CN', language: 'zh-CN', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const chineseSimplifiedYunyang: Voice = { id: 'zh-CN-YunyangNeural', name: 'Yunyang', countryCode: 'CN', language: 'zh-CN', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+
+const chineseTraditionalXiaochen: Voice = { id: 'zh-CN-XiaochenNeural', name: 'Xiaochen', countryCode: 'CN', language: 'zh-TW', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const chineseTraditionalXiaoyan: Voice = { id: 'zh-CN-XiaoyanNeural', name: 'Xiaoyan', countryCode: 'CN', language: 'zh-TW', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const chineseTraditionalYunye: Voice = { id: 'zh-CN-YunyeNeural', name: 'Yunye', countryCode: 'CN', language: 'zh-TW', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const chineseTraditionalYunyang: Voice = { id: 'zh-CN-YunyangNeural', name: 'Yunyang', countryCode: 'CN', language: 'zh-TW', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const chineseTraditionalYunSong: Voice = { id: 'yue-CN-YunSongNeural', name: 'YunSong', countryCode: 'CN', language: 'zh-TW', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const chineseTraditionalHiuGaai: Voice = { id: 'zh-HK-HiuGaaiNeural', name: 'HiuGaai', countryCode: 'CN', language: 'zh-TW', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+
+const norwegianPernille: Voice = { id: 'nb-NO-PernilleNeural', name: 'Pernille', countryCode: 'NO', language: 'nb-NO', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const norwegianFinn: Voice = { id: 'nb-NO-FinnNeural', name: 'Finn', countryCode: 'NO', language: 'nb-NO', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+
+const malaysianYasmin: Voice = { id: 'ms-MY-YasminNeural', name: 'Yasmin', countryCode: 'MY', language: 'ms-MY', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+const malaysianOsman: Voice = { id: 'ms-MY-OsmanNeural', name: 'Osman', countryCode: 'MY', language: 'ms-MY', speechProvider: SupportedSpeechProvider.MicrosoftAzure };
+
+const voicesForLocales = new Map<string, Voice[]>([
+    [SupportedLocale.enGB, [britishSonia, britishRyan, americanNancy, americanSara, americanChristopher, americanTony]],
+    [SupportedLocale.enUS, [britishSonia, britishRyan, americanNancy, americanSara, americanChristopher, americanTony]],
+    [SupportedLocale.ptBR, [brazilianBrenda, brazilianGiovanna, brazilianAntonio, brazilianHumberto]],
+    [SupportedLocale.es, [mexicanBeatriz, mexicanCecilio, spanishAbril, spanishAlvaro, latamPaloma, latamAlonso]],
+    [SupportedLocale.frFR, [frenchHenri, frenchJerome, frenchJacqueline, belgianCharline]],
+    [SupportedLocale.itIT, [italianElsa, italianFabiola, italianCalimero, italianCataldo]],
+    [SupportedLocale.nlNL, [dutchColette, dutchMaarten, dutchFenna]],
+    [SupportedLocale.deDE, [germanKatja, germanConrad, germanChristoph, germanElke]],
+    [SupportedLocale.plPL, [polishZofia, polishMarek]],
+    [SupportedLocale.svSE, [swedishSofie, swedishMattias]],
+    [SupportedLocale.trTR, [turkishAhmet, turkishEmel]],
+    [SupportedLocale.frCA, [canadianFrenchSylvie, canadianFrenchThierry, canadianFrenchAntoine, canadianFrenchJean]],
+    [SupportedLocale.zhCN, [chineseSimplifiedXiaochen, chineseSimplifiedXiaoyan, chineseSimplifiedYunye, chineseSimplifiedYunyang]],
+    [SupportedLocale.zhTW, [chineseTraditionalXiaochen, chineseTraditionalXiaoyan, chineseTraditionalYunye, chineseTraditionalYunyang, chineseTraditionalYunSong, chineseTraditionalHiuGaai]],
+    [SupportedLocale.nbNO, [norwegianPernille, norwegianFinn]],
+    [SupportedLocale.msMY, [malaysianYasmin, malaysianOsman]]
+]);
+
+const defaultVoiceForLocales = new Map<string, Voice>([
+    [SupportedLocale.enGB, americanSara],
+    [SupportedLocale.enUS, americanSara],
+    [SupportedLocale.ptBR, brazilianHumberto],
+    [SupportedLocale.es, latamPaloma],
+    [SupportedLocale.frFR, frenchJacqueline],
+    [SupportedLocale.itIT, italianElsa],
+    [SupportedLocale.nlNL, dutchColette],
+    [SupportedLocale.deDE, germanKatja],
+    [SupportedLocale.plPL, polishZofia],
+    [SupportedLocale.svSE, swedishSofie],
+    [SupportedLocale.trTR, turkishAhmet],
+    [SupportedLocale.frCA, canadianFrenchSylvie],
+    [SupportedLocale.zhCN, chineseSimplifiedXiaochen],
+    [SupportedLocale.zhTW, chineseTraditionalXiaochen],
+    [SupportedLocale.nbNO, norwegianPernille],
+    [SupportedLocale.msMY, malaysianYasmin]
+]);
+
+export function getSupportedVoices(locale: string): Voice[] {
+    const voices = voicesForLocales.get(locale);
+    if (!voices) {
+        throw new Error(`Cannot list supported voices. Unsupported locale: ${JSON.stringify(locale)}`);
+    }
+    return voices;
+}
+
+export function getDefaultVoice(locale: string): Voice {
+    const voice = defaultVoiceForLocales.get(locale);
+    if (!voice) {
+        throw new Error(`Cannot find default voice. Unsupported locale: ${JSON.stringify(locale)}`);
+    }
+    return voice;
+}

package/src/text-to-speech/text-segment.ts

@@ -1,29 +1,29 @@
-export interface TextSegment {
-    parentId: string;
-    textSegmentId: string;
-    content: string;
-}
-
-export interface TextSegmentWithSpeech extends TextSegment {
-    speech: Speech[];
-    /* The speech-friendly version of the "content" field. Trimmed, enrichment links removed, words replaced based on custom dictionary, etc. */
-    spokenContent: string;
-}
-
-export interface Speech {
-    voice: Voice;
-    url: string;
-}
-
-export interface Voice {
-    id: string;
-    language: string;
-    name: string;
-    countryCode: string;
-    /** use SupportedSpeechProvider */
-    speechProvider: string;
-}
-
-export enum SupportedSpeechProvider {
-    MicrosoftAzure = 'microsoft-azure'
-}
+export interface TextSegment {
+    parentId: string;
+    textSegmentId: string;
+    content: string;
+}
+
+export interface TextSegmentWithSpeech extends TextSegment {
+    speech: Speech[];
+    /* The speech-friendly version of the "content" field. Trimmed, enrichment links removed, words replaced based on custom dictionary, etc. */
+    spokenContent: string;
+}
+
+export interface Speech {
+    voice: Voice;
+    url: string;
+}
+
+export interface Voice {
+    id: string;
+    language: string;
+    name: string;
+    countryCode: string;
+    /** use SupportedSpeechProvider */
+    speechProvider: string;
+}
+
+export enum SupportedSpeechProvider {
+    MicrosoftAzure = 'microsoft-azure'
+}