fix filterOnRecommended: push to lowerQuality the altNames voices found

build/src/voices.js

@@ -147,10 +147,38 @@ export function filterOnRecommended(voices, _recommended = recommended) {
                 for (let i = 1; i < voicesFound.length; i++) {
                     voicesLowerQuality.push(voicesFound[i]);
                 }
-                voice.quality = voicesFound.length > 3 ? "veryHigh" : voicesFound.length === 2 ? "high" : "normal";
+                voice.quality = voicesFound.length > 3 ? "veryHigh" : voicesFound.length > 2 ? "high" : "normal";
                 voicesRecommended.push(updateVoiceInfo(recommendedVoice, voice));
             }
         }
+        else if (Array.isArray(recommendedVoice.altNames) && recommendedVoice.altNames.length) {
+            const voiceFound = voices.find(({ name }) => name === recommendedVoice.name);
+            if (voiceFound) {
+                const voice = voiceFound;
+                voice.quality = Array.isArray(recommendedVoice.quality) ? recommendedVoice.quality[0] : undefined;
+                voicesRecommended.push(updateVoiceInfo(recommendedVoice, voice));
+                // voice Name found so altNames array must be filter and push to voicesLowerQuality
+                const altNamesVoicesFound = voices.filter(({ name }) => recommendedVoice.altNames.includes(name));
+                // TODO: Typescript bug type assertion doesn't work, need to force the compiler with the Non-null Assertion Operator
+                voicesLowerQuality.push(...(altNamesVoicesFound.map((v) => {
+                    v.quality = recommendedVoice.quality[0];
+                    return updateVoiceInfo(recommendedVoice, v);
+                })));
+            }
+            else {
+                // filter voices on altNames, keep the first and push the remaining to voicesLowerQuality
+                const altNamesVoicesFound = voices.filter(({ name }) => recommendedVoice.altNames.includes(name));
+                if (altNamesVoicesFound.length) {
+                    const voice = altNamesVoicesFound.shift();
+                    voice.quality = Array.isArray(recommendedVoice.quality) ? recommendedVoice.quality[0] : undefined;
+                    voicesRecommended.push(updateVoiceInfo(recommendedVoice, voice));
+                    voicesLowerQuality.push(...(altNamesVoicesFound.map((v) => {
+                        v.quality = recommendedVoice.quality[0];
+                        return updateVoiceInfo(recommendedVoice, v);
+                    })));
+                }
+            }
+        }
         else {
             const voiceFound = voices.find(({ name }) => name.startsWith(recommendedVoice.name));
             if (voiceFound) {

build/test/voices.test.js

@@ -219,6 +219,69 @@ test('filterOnRecommended: Multiple recommended voices', t => {
         [],
     ]);
 });
+test('filterOnRecommended: Recommended voices with altNames', t => {
+    const voices = [
+        { label: 'Voice 1', voiceURI: 'uri1', name: 'Name 1', language: 'en-US', offlineAvailability: true, pitchControl: true },
+        { label: 'Voice 1-1', voiceURI: 'uri1-1', name: 'Name 1 with an altNames', language: 'en-US', offlineAvailability: true, pitchControl: true },
+        { label: 'Voice 2', voiceURI: 'uri2', name: 'Name 2', language: 'es-ES', offlineAvailability: false, pitchControl: false },
+        { label: 'Voice 3', voiceURI: 'uri3', name: 'Name 3', language: 'fr-FR', offlineAvailability: true, pitchControl: true },
+    ];
+    const recommended = [
+        { name: 'Name 1', label: 'Voice 1', quality: ['high'], altNames: ['Name 1 with an altNames'], language: 'en-US', localizedName: "" },
+        { name: 'Name 2', label: 'Voice 2', quality: ['normal'], language: 'es-ES', localizedName: "" },
+    ];
+    const result = filterOnRecommended(voices, recommended);
+    t.deepEqual(result, [
+        [
+            { label: 'Voice 1', voiceURI: 'uri1', name: 'Name 1', language: 'en-US', offlineAvailability: true, pitchControl: true, quality: 'high', recommendedRate: undefined, recommendedPitch: undefined, gender: undefined },
+            { label: 'Voice 2', voiceURI: 'uri2', name: 'Name 2', language: 'es-ES', offlineAvailability: false, pitchControl: false, quality: 'normal', recommendedRate: undefined, recommendedPitch: undefined, gender: undefined },
+        ],
+        [
+            { label: 'Voice 1', voiceURI: 'uri1-1', name: 'Name 1 with an altNames', language: 'en-US', offlineAvailability: true, pitchControl: true, quality: 'high', recommendedRate: undefined, recommendedPitch: undefined, gender: undefined },
+        ],
+    ]);
+});
+test('filterOnRecommended: Recommended voices with altNames only and voices not in name', t => {
+    const voices = [
+        { label: 'Voice 1', voiceURI: 'uri1', name: 'Name 1 with an altNames', language: 'en-US', offlineAvailability: true, pitchControl: true },
+        { label: 'Voice 2', voiceURI: 'uri2', name: 'Name 2', language: 'es-ES', offlineAvailability: false, pitchControl: false },
+        { label: 'Voice 3', voiceURI: 'uri3', name: 'Name 3', language: 'fr-FR', offlineAvailability: true, pitchControl: true },
+    ];
+    const recommended = [
+        { name: 'Name 1', label: 'Voice 1', quality: ['high'], altNames: ['Name 1 with an altNames'], language: 'en-US', localizedName: "" },
+        { name: 'Name 2', label: 'Voice 2', quality: ['normal'], language: 'es-ES', localizedName: "" },
+    ];
+    const result = filterOnRecommended(voices, recommended);
+    t.deepEqual(result, [
+        [
+            { label: 'Voice 1', voiceURI: 'uri1', name: 'Name 1 with an altNames', language: 'en-US', offlineAvailability: true, pitchControl: true, quality: 'high', recommendedRate: undefined, recommendedPitch: undefined, gender: undefined },
+            { label: 'Voice 2', voiceURI: 'uri2', name: 'Name 2', language: 'es-ES', offlineAvailability: false, pitchControl: false, quality: 'normal', recommendedRate: undefined, recommendedPitch: undefined, gender: undefined },
+        ],
+        [],
+    ]);
+});
+test('filterOnRecommended: Recommended voices with multiple altNames and voices not in name', t => {
+    const voices = [
+        { label: 'Voice 1', voiceURI: 'uri1', name: 'Name 1 with an altNames', language: 'en-US', offlineAvailability: true, pitchControl: true },
+        { label: 'Voice 1-1', voiceURI: 'uri1-1', name: 'Name 1 with a second altNames', language: 'en-US', offlineAvailability: true, pitchControl: true },
+        { label: 'Voice 2', voiceURI: 'uri2', name: 'Name 2', language: 'es-ES', offlineAvailability: false, pitchControl: false },
+        { label: 'Voice 3', voiceURI: 'uri3', name: 'Name 3', language: 'fr-FR', offlineAvailability: true, pitchControl: true },
+    ];
+    const recommended = [
+        { name: 'Name 1', label: 'Voice 1', quality: ['high'], altNames: ['Name 1 with an altNames', 'Name 1 with a second altNames'], language: 'en-US', localizedName: "" },
+        { name: 'Name 2', label: 'Voice 2', quality: ['normal'], language: 'es-ES', localizedName: "" },
+    ];
+    const result = filterOnRecommended(voices, recommended);
+    t.deepEqual(result, [
+        [
+            { label: 'Voice 1', voiceURI: 'uri1', name: 'Name 1 with an altNames', language: 'en-US', offlineAvailability: true, pitchControl: true, quality: 'high', recommendedRate: undefined, recommendedPitch: undefined, gender: undefined },
+            { label: 'Voice 2', voiceURI: 'uri2', name: 'Name 2', language: 'es-ES', offlineAvailability: false, pitchControl: false, quality: 'normal', recommendedRate: undefined, recommendedPitch: undefined, gender: undefined },
+        ],
+        [
+            { label: 'Voice 1', voiceURI: 'uri1-1', name: 'Name 1 with a second altNames', language: 'en-US', offlineAvailability: true, pitchControl: true, quality: 'high', recommendedRate: undefined, recommendedPitch: undefined, gender: undefined },
+        ],
+    ]);
+});
 test('groupByLanguage: ', t => {
     const voices = [
         { label: 'Voice 1', voiceURI: 'uri1', name: 'Name 1', language: 'en-US', offlineAvailability: true, pitchControl: true },

script/extract-json.mjs

@@ -151,6 +151,7 @@ for (const file of jsonFiles) {
       recommended.push({
         label: voice.label,
         name: voice.name || undefined,
+        altNames: voice.altNames || undefined,
         language: voice.language || undefined,
         gender: voice.gender || undefined,
         age: voice.age || undefined,
@@ -205,6 +206,7 @@ export type TQuality =  "veryLow" | "low" | "normal" | "high" | "veryHigh";
 export interface IRecommended {
     label: string;
     name: string;
+    altNames?: string[];
     language: string;
     gender?: TGender | undefined;
     age?: string | undefined;

src/voices.ts

@@ -177,10 +177,45 @@ export function filterOnRecommended(voices: IVoices[], _recommended: IRecommende
                     voicesLowerQuality.push(voicesFound[i]);
                 }
 
-                voice.quality = voicesFound.length > 3 ? "veryHigh" : voicesFound.length === 2 ? "high" : "normal";
+                voice.quality = voicesFound.length > 3 ? "veryHigh" : voicesFound.length > 2 ? "high" : "normal";
                 voicesRecommended.push(updateVoiceInfo(recommendedVoice, voice));
 
             }
+        } else if (Array.isArray(recommendedVoice.altNames) && recommendedVoice.altNames.length) {
+
+            const voiceFound = voices.find(({ name }) => name === recommendedVoice.name);
+            if (voiceFound) {
+                const voice = voiceFound;
+
+                voice.quality = Array.isArray(recommendedVoice.quality) ? recommendedVoice.quality[0] : undefined;
+                voicesRecommended.push(updateVoiceInfo(recommendedVoice, voice));
+
+                // voice Name found so altNames array must be filter and push to voicesLowerQuality
+                const altNamesVoicesFound = voices.filter(({name}) => recommendedVoice.altNames!.includes(name));
+                // TODO: Typescript bug type assertion doesn't work, need to force the compiler with the Non-null Assertion Operator
+
+                voicesLowerQuality.push(...(altNamesVoicesFound.map((v) => {
+                    v.quality = recommendedVoice.quality[0];
+                    return updateVoiceInfo(recommendedVoice, v);
+                })));
+            } else {
+
+                // filter voices on altNames, keep the first and push the remaining to voicesLowerQuality
+                const altNamesVoicesFound = voices.filter(({name}) => recommendedVoice.altNames!.includes(name));
+                if (altNamesVoicesFound.length) {
+
+                    const voice = altNamesVoicesFound.shift() as IVoices;
+
+                    voice.quality = Array.isArray(recommendedVoice.quality) ? recommendedVoice.quality[0] : undefined;
+                    voicesRecommended.push(updateVoiceInfo(recommendedVoice, voice));
+
+
+                    voicesLowerQuality.push(...(altNamesVoicesFound.map((v) => {
+                        v.quality = recommendedVoice.quality[0];
+                        return updateVoiceInfo(recommendedVoice, v);
+                    })));
+                }
+            }
         } else {
 
             const voiceFound = voices.find(({ name }) => name.startsWith(recommendedVoice.name));

test/voices.test.ts

@@ -248,6 +248,70 @@ test('filterOnRecommended: Multiple recommended voices', t => {
 		[],
 	]);
 });
+test('filterOnRecommended: Recommended voices with altNames', t => {
+	const voices = [
+		{ label: 'Voice 1', voiceURI: 'uri1', name: 'Name 1', language: 'en-US', offlineAvailability: true, pitchControl: true },
+		{ label: 'Voice 1-1', voiceURI: 'uri1-1', name: 'Name 1 with an altNames', language: 'en-US', offlineAvailability: true, pitchControl: true },
+		{ label: 'Voice 2', voiceURI: 'uri2', name: 'Name 2', language: 'es-ES', offlineAvailability: false, pitchControl: false },
+		{ label: 'Voice 3', voiceURI: 'uri3', name: 'Name 3', language: 'fr-FR', offlineAvailability: true, pitchControl: true },
+	];
+	const recommended: IRecommended[] = [
+		{ name: 'Name 1', label: 'Voice 1', quality: ['high'], altNames: ['Name 1 with an altNames'], language: 'en-US', localizedName: "" },
+		{ name: 'Name 2', label: 'Voice 2', quality: ['normal'], language: 'es-ES', localizedName: "" },
+	];
+	const result = filterOnRecommended(voices, recommended);
+	t.deepEqual(result, [
+		[
+			{ label: 'Voice 1', voiceURI: 'uri1', name: 'Name 1', language: 'en-US', offlineAvailability: true, pitchControl: true, quality: 'high', recommendedRate: undefined, recommendedPitch: undefined, gender: undefined },
+			{ label: 'Voice 2', voiceURI: 'uri2', name: 'Name 2', language: 'es-ES', offlineAvailability: false, pitchControl: false, quality: 'normal', recommendedRate: undefined, recommendedPitch: undefined, gender: undefined },
+		],
+		[
+			{ label: 'Voice 1', voiceURI: 'uri1-1', name: 'Name 1 with an altNames', language: 'en-US', offlineAvailability: true, pitchControl: true, quality: 'high', recommendedRate: undefined, recommendedPitch: undefined, gender: undefined },
+		],
+	]);
+});
+test('filterOnRecommended: Recommended voices with altNames only and voices not in name', t => {
+	const voices = [
+		{ label: 'Voice 1', voiceURI: 'uri1', name: 'Name 1 with an altNames', language: 'en-US', offlineAvailability: true, pitchControl: true },
+		{ label: 'Voice 2', voiceURI: 'uri2', name: 'Name 2', language: 'es-ES', offlineAvailability: false, pitchControl: false },
+		{ label: 'Voice 3', voiceURI: 'uri3', name: 'Name 3', language: 'fr-FR', offlineAvailability: true, pitchControl: true },
+	];
+	const recommended: IRecommended[] = [
+		{ name: 'Name 1', label: 'Voice 1', quality: ['high'], altNames: ['Name 1 with an altNames'], language: 'en-US', localizedName: "" },
+		{ name: 'Name 2', label: 'Voice 2', quality: ['normal'], language: 'es-ES', localizedName: "" },
+	];
+	const result = filterOnRecommended(voices, recommended);
+	t.deepEqual(result, [
+		[
+			{ label: 'Voice 1', voiceURI: 'uri1', name: 'Name 1 with an altNames', language: 'en-US', offlineAvailability: true, pitchControl: true, quality: 'high', recommendedRate: undefined, recommendedPitch: undefined, gender: undefined },
+			{ label: 'Voice 2', voiceURI: 'uri2', name: 'Name 2', language: 'es-ES', offlineAvailability: false, pitchControl: false, quality: 'normal', recommendedRate: undefined, recommendedPitch: undefined, gender: undefined },
+		],
+		[
+		],
+	]);
+});
+test('filterOnRecommended: Recommended voices with multiple altNames and voices not in name', t => {
+	const voices = [
+		{ label: 'Voice 1', voiceURI: 'uri1', name: 'Name 1 with an altNames', language: 'en-US', offlineAvailability: true, pitchControl: true },
+		{ label: 'Voice 1-1', voiceURI: 'uri1-1', name: 'Name 1 with a second altNames', language: 'en-US', offlineAvailability: true, pitchControl: true },
+		{ label: 'Voice 2', voiceURI: 'uri2', name: 'Name 2', language: 'es-ES', offlineAvailability: false, pitchControl: false },
+		{ label: 'Voice 3', voiceURI: 'uri3', name: 'Name 3', language: 'fr-FR', offlineAvailability: true, pitchControl: true },
+	];
+	const recommended: IRecommended[] = [
+		{ name: 'Name 1', label: 'Voice 1', quality: ['high'], altNames: ['Name 1 with an altNames', 'Name 1 with a second altNames'], language: 'en-US', localizedName: "" },
+		{ name: 'Name 2', label: 'Voice 2', quality: ['normal'], language: 'es-ES', localizedName: "" },
+	];
+	const result = filterOnRecommended(voices, recommended);
+	t.deepEqual(result, [
+		[
+			{ label: 'Voice 1', voiceURI: 'uri1', name: 'Name 1 with an altNames', language: 'en-US', offlineAvailability: true, pitchControl: true, quality: 'high', recommendedRate: undefined, recommendedPitch: undefined, gender: undefined },
+			{ label: 'Voice 2', voiceURI: 'uri2', name: 'Name 2', language: 'es-ES', offlineAvailability: false, pitchControl: false, quality: 'normal', recommendedRate: undefined, recommendedPitch: undefined, gender: undefined },
+		],
+		[
+			{ label: 'Voice 1', voiceURI: 'uri1-1', name: 'Name 1 with a second altNames', language: 'en-US', offlineAvailability: true, pitchControl: true, quality: 'high', recommendedRate: undefined, recommendedPitch: undefined, gender: undefined },
+		],
+	]);
+});
 test('groupByLanguage: ', t => {
 	const voices = [
 		{ label: 'Voice 1', voiceURI: 'uri1', name: 'Name 1', language: 'en-US', offlineAvailability: true, pitchControl: true },