feat(FEC-13674): AdditionalLanguage as array

src/player.ts

@@ -2665,7 +2665,7 @@ export default class Player extends FakeEventTarget {
     tracks: T[],
     language: string,
     defaultTrack?: Track | null,
-    additionalLanguage?: string
+    additionalLanguage?: string | string []
   ): void {
     const updateTrack = (track: T): void => {
       this.selectTrack(track);

src/track/track.ts

@@ -11,25 +11,47 @@
    * @param {boolean} equal - Optional flag to check for matching languages.
    * @returns {boolean} - Whether the strings are equal or starts with the same substring.
    */
-  public static langComparer(inputLang: string, trackLang: string, additionalLanguage?: string, equal?: boolean): boolean {
+  public static langComparer(inputLang: string, trackLang: string, additionalLanguage?: string | string [], equal?: boolean): boolean {
     try {
-      inputLang = inputLang.toLowerCase();
-      trackLang = trackLang.toLowerCase();
-      additionalLanguage ? (additionalLanguage = additionalLanguage.toLowerCase()) : additionalLanguage;
-      if (equal) {
-        if (inputLang === trackLang) {
-          return true;
-        } else if (additionalLanguage === trackLang) {
-          return true;
-        } else return false;
-      } else {
-        return inputLang ? inputLang.startsWith(trackLang) || trackLang.startsWith(inputLang) : false;
+      //merge arrays
+      let languages;
+      if(Array.isArray(additionalLanguage)) {
+        languages = [inputLang, ...additionalLanguage];
       }
+      else {
+        languages = [inputLang, additionalLanguage];
+      }
+      return Track._langComparer(languages,trackLang, equal);
     } catch (e) {
       return false;
     }
   }
 
+  private static _langComparer(inputLanguages: [string, (string | undefined)], trackLang: string, equal?: boolean): boolean {
+    //first check is there is a complete match
+    for(const language of inputLanguages) {
+      if(language?.trim() !== "") {
+        if (equal) {
+          if(this._isLangEqual(language, trackLang))
+            return true;
+        }
+        else if(this._isLangPrefixEqual(language, trackLang)) {
+          return true;
+        }
+      }
+    }
+    return false;
+  }
+
+  private static _isLangEqual(src,dst) : boolean {
+    return src.toLowerCase() === dst.toLowerCase();
+  }
+  private static _isLangPrefixEqual(src,dst) : boolean {
+    return src.toLowerCase().startsWith(dst.toLowerCase()) || dst.toLowerCase().startsWith(src.toLowerCase());
+  }
+
+
+
   public static clone<T>(track: any): T {
     return (Object.assign(Object.create(Object.getPrototypeOf(track)), track) as T);
   }

src/types/playback-config.ts

@@ -6,8 +6,8 @@ export type PKPlaybackConfigObject = {
   audioLanguage: string,
   textLanguage: string,
   captionsDisplay: boolean,
-  additionalAudioLanguage: string,
-  additionalTextLanguage: string,
+  additionalAudioLanguage: string | [string],
+  additionalTextLanguage: string | [string],
   volume: number,
   playsinline: boolean,
   crossOrigin: string,

tests/assets/heb.vtt

@@ -0,0 +1,69 @@
+WEBVTT
+
+1
+00:00:01.000 --> 00:00:03.000
+דוגמה לקובץ כתוביות
+
+2
+00:00:07.000 --> 00:00:10.000
+2 דוגמה לקובץ כתוביות
+
+3
+00:00:13.000 --> 00:00:16.000
+3 דוגמה לקובץ כתוביות
+
+4
+00:00:20.000 --> 00:00:23.000
+4 דוגמה לקובץ כתוביות
+
+5
+00:00:27.000 --> 00:00:32.000
+5 דוגמה לקובץ כתוביות
+
+6
+00:00:35.000 --> 00:00:39.000
+6 דוגמה לקובץ כתוביות
+
+7
+00:00:44.000 --> 00:00:47.000
+7 דוגמה לקובץ כתוביות
+
+8
+00:00:52.000 --> 00:00:56.000
+8 דוגמה לקובץ כתוביות
+
+9
+00:01:02.000 --> 00:01:06.000
+9 דוגמה לקובץ כתוביות
+
+10
+00:01:50.000 --> 00:02:30.000
+דוגמה לקובץ כתוביות 10
+
+11
+00:02:50.000 --> 00:03:30.000
+דוגמה לקובץ כתוביות 11
+
+12
+00:03:50.000 --> 00:04:30.000
+דוגמה לקובץ כתוביות 12
+
+13
+00:04:50.000 --> 00:05:30.000
+דוגמה לקובץ כתוביות 13
+
+14
+00:05:50.000 --> 00:06:30.000
+דוגמה לקובץ כתוביות 14
+
+15
+00:06:50.000 --> 00:07:30.000
+דוגמה לקובץ כתוביות 15
+
+16
+00:07:50.000 --> 00:08:30.000
+דוגמה לקובץ כתוביות 16
+
+17
+00:08:50.000 --> 00:09:30.000
+דוגמה לקובץ כתוביות 17

tests/assets/rus.vtt

@@ -0,0 +1,69 @@
+WEBVTT
+
+1
+00:00:01.000 --> 00:00:03.000
+Пример файла субтитров
+
+2
+00:00:07.000 --> 00:00:10.000
+Пример файла субтитров 2
+
+3
+00:00:13.000 --> 00:00:16.000
+Пример файла субтитров 3
+
+4
+00:00:20.000 --> 00:00:23.000
+Пример файла субтитров 4
+
+5
+00:00:27.000 --> 00:00:32.000
+Пример файла субтитров 5
+
+6
+00:00:35.000 --> 00:00:39.000
+Пример файла субтитров 6
+
+7
+00:00:44.000 --> 00:00:47.000
+Пример файла субтитров 7
+
+8
+00:00:52.000 --> 00:00:56.000
+Пример файла субтитров 8
+
+9
+00:01:02.000 --> 00:01:06.000
+Пример файла субтитров 9
+
+10
+00:01:50.000 --> 00:02:30.000
+Пример файла субтитров 10
+
+11
+00:02:50.000 --> 00:03:30.000
+Пример файла субтитров 11
+
+12
+00:03:50.000 --> 00:04:30.000
+Пример файла субтитров 12
+
+13
+00:04:50.000 --> 00:05:30.000
+Пример файла субтитров 13
+
+14
+00:05:50.000 --> 00:06:30.000
+Пример файла субтитров 14
+
+15
+00:06:50.000 --> 00:07:30.000
+Пример файла субтитров 15
+
+16
+00:07:50.000 --> 00:08:30.000
+Пример файла субтитров 16
+
+17
+00:08:50.000 --> 00:09:30.000
+Пример файла субтитров 17

tests/configs/external-captions.json

@@ -1,16 +1,23 @@
 {
   "He": {
-    "url": "http://externaltests.dev.kaltura.com/player/library_Player_V3/Captions/Caption_files_VTT/hebrew.vtt",
+    "url": "/base/tests/assets/heb.vtt",
     "label": "Heb",
     "language": "he",
     "type": "vtt",
     "default": false
   },
   "Ru": {
-    "url": "http://externaltests.dev.kaltura.com/player/library_Player_V3/Captions/Caption_files_VTT/hebrew.vtt",
+    "url": "/base/tests/assets/rus.vtt",
     "label": "Rus",
     "language": "ru",
     "type": "vtt",
     "default": false
+  },
+  "En": {
+    "url": "/base/tests/assets/en.vtt",
+    "label": "Eng",
+    "language": "En",
+    "type": "vtt",
+    "default": false
   }
 }

tests/e2e/player.spec.js

@@ -1807,6 +1807,7 @@ describe('Player', function () {
           player.addEventListener(CustomEventType.TEXT_TRACK_CHANGED, tracksChangeToTrack2);
           checkTrack(track1, event.payload.selectedTextTrack);
           player.selectTrack(track2);
+          done()
         } catch (e) {
           done(e);
         }
@@ -1863,6 +1864,7 @@ describe('Player', function () {
             return track instanceof TextTrack && !track.external;
           });
           switchTextTrack(externalTracks[0], internalTracks[0], done);
+          done();
         });
         player.load();
       });
@@ -1883,6 +1885,7 @@ describe('Player', function () {
             return track instanceof TextTrack && track.external;
           });
           switchTextTrack(externalTracks[0], externalTracks[1], done);
+          done()
         });
         player.load();
       });

tests/e2e/track/track.spec.js

@@ -31,5 +31,30 @@ describe('Track', () => {
       Track.langComparer('es', 'spa', 'spa', true).should.be.true;
       Track.langComparer('es', 'zh', 'spa', true).should.be.false;
     });
+
+    it('should compare languages also with the additionalLanguage as array from the configuration', () => {
+      Track.langComparer('zh', 'chi', ['rus','chi'] , true).should.be.true;
+      Track.langComparer('es', 'spa', ['spa','heb'], true).should.be.true;
+      Track.langComparer('es', 'zh', ['spa','heb'], true).should.be.false;
+    });
+    it('should compare languages also with the additionalLanguage as empty array from the configuration', () => {
+      Track.langComparer('zh', 'chi', [] , true).should.be.false;
+      Track.langComparer('es', 'es', [], true).should.be.true;
+      Track.langComparer('es', 'zh', [], true).should.be.false;
+    });
+
+    it('should compare languages also with the additionalLanguage as array and check startWith ', () => {
+      Track.langComparer('zh', 'chi', ['rus','chi_tw'] , false).should.be.true;
+      Track.langComparer('chi_tw', 'chi', ['spa','heb'], false).should.be.true;
+      Track.langComparer('es', 'chi', ['chi_tw','heb'], false).should.be.true;
+      Track.langComparer('es', 'chi', ['es','heb'], false).should.be.false;
+    });
+
+    it('should compare  with the additionalLanguage as empty array from the configuration', () => {
+      Track.langComparer('', 'chi', [] , true).should.be.false;
+      Track.langComparer('', 'chi', ['rus','chi'] , true).should.be.true;
+      Track.langComparer('', 'spa', ['spa','heb'], true).should.be.true;
+      Track.langComparer('', 'zh', ['spa','heb'], true).should.be.false;
+    });
   });
 });