@playkit-js/playkit-js-dual-screen 3.2.0-canary.3-780c36d → 3.2.0

package/CHANGELOG.md

@@ -2,20 +2,218 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-## [3.2.0-canary.3-780c36d](https://github.com/kaltura/playkit-js-dual-screen/compare/v3.1.4...v3.2.0-canary.3-780c36d) (2023-05-15)
+## 3.2.0 (2025-03-06)
+
+
+### Features
+
+* **FEC-14380:** update package.json ([#172](https://github.com/kaltura/playkit-js-dual-screen/issues/172)) ([396c667](https://github.com/kaltura/playkit-js-dual-screen/commit/396c667))
+
+
+
+### 3.1.42 (2025-01-23)
+
+
+### Bug Fixes
+
+* **FEC-14011:** Slide and CTA Analytics ([#167](https://github.com/kaltura/playkit-js-dual-screen/issues/167)) ([ac08f3f](https://github.com/kaltura/playkit-js-dual-screen/commit/ac08f3f))
+
+
+
+### 3.1.41 (2025-01-09)
+
+
+
+### 3.1.40 (2024-12-19)
+
+
+
+### 3.1.39 (2024-11-14)
+
+
+
+### 3.1.38 (2024-10-13)
+
+
+
+### 3.1.37 (2024-10-13)
+
+
+
+### 3.1.36 (2024-09-19)
+
+
+
+### 3.1.35 (2024-09-19)
+
+
+### Bug Fixes
+
+* **FEC-14080:** Accessibility fix for the top bar and the bottom bar ([cb40886](https://github.com/kaltura/playkit-js-dual-screen/commit/cb40886))
+
+
+
+### 3.1.34 (2024-09-08)
+
+
+
+### 3.1.33 (2024-09-05)
+
+
+
+### 3.1.32 (2024-09-05)
+
+
+### Bug Fixes
+
+* **FEC-14080:** Accessibility fix for the top bar and the bottom bar ([ea4e2d6](https://github.com/kaltura/playkit-js-dual-screen/commit/ea4e2d6))
+
+
+
+### 3.1.31 (2024-08-22)
+
+
+
+### 3.1.30 (2024-08-03)
+
+
+
+### 3.1.29 (2024-05-05)
+
+
+
+### 3.1.28 (2024-05-02)
+
+
+
+### 3.1.27 (2024-04-10)
+
+
+
+### 3.1.26 (2024-04-09)
+
+
+
+### 3.1.25 (2024-03-31)
+
+
+
+### 3.1.24 (2024-03-31)
+
+
+
+### 3.1.23 (2024-03-31)
+
+
+
+### 3.1.22 (2024-02-25)
+
+
+
+### 3.1.21 (2024-02-25)
+
+
+
+### 3.1.20 (2024-01-18)
+
+
+### Bug Fixes
+
+* **FEC-13591:** disable FF native PiP for dualscreen player ([#128](https://github.com/kaltura/playkit-js-dual-screen/issues/128)) ([d1a041d](https://github.com/kaltura/playkit-js-dual-screen/commit/d1a041d))
+
+
+
+### 3.1.19 (2024-01-07)
+
+
+
+### 3.1.18 (2024-01-07)
+
+
+
+### 3.1.17 (2023-12-24)
+
+
+
+### 3.1.16 (2023-12-07)
+
+
+
+### 3.1.15 (2023-11-28)
+
+
+
+### 3.1.14 (2023-11-12)
+
+
+
+### 3.1.13 (2023-11-12)
 
 
 ### Bug Fixes
 
-* **FEC-13121:** add configuration that allow control if settings component should be removed from player ([#104](https://github.com/kaltura/playkit-js-dual-screen/issues/104)) ([0bddc2f](https://github.com/kaltura/playkit-js-dual-screen/commit/0bddc2f))
-* **FEC-13145:** upgrade dependancies for common and ui-managers etc  ([#105](https://github.com/kaltura/playkit-js-dual-screen/issues/105)) ([780c36d](https://github.com/kaltura/playkit-js-dual-screen/commit/780c36d))
+* **FEC-13421:** Future slides thumbnail are not shown on timline when hovering on timeline ([#121](https://github.com/kaltura/playkit-js-dual-screen/issues/121)) ([ed0fafb](https://github.com/kaltura/playkit-js-dual-screen/commit/ed0fafb))
+
+
+
+### 3.1.12 (2023-10-16)
+
+
+
+### 3.1.11 (2023-08-21)
+
+
+
+### 3.1.10 (2023-07-26)
+
+
+### Bug Fixes
+
+* **FEC-13265:** upd dependency script ([#116](https://github.com/kaltura/playkit-js-dual-screen/issues/116)) ([92465f2](https://github.com/kaltura/playkit-js-dual-screen/commit/92465f2))
+
+
+
+### 3.1.9 (2023-07-05)
+
+
+### Bug Fixes
+
+* **FEC-13260:** player pauses if video el absent ([#115](https://github.com/kaltura/playkit-js-dual-screen/issues/115)) ([f780a66](https://github.com/kaltura/playkit-js-dual-screen/commit/f780a66))
+
+
+
+### 3.1.8 (2023-07-03)
+
+
+### Bug Fixes
+
+* **FEC-13257:** invalid icon in sbs mode ([#113](https://github.com/kaltura/playkit-js-dual-screen/issues/113)) ([1c3580e](https://github.com/kaltura/playkit-js-dual-screen/commit/1c3580e))
+
+
+
+### 3.1.7 (2023-06-27)
+
+
+### Bug Fixes
+
+* **FEC-13224:** fix race condition for image player ([#111](https://github.com/kaltura/playkit-js-dual-screen/issues/111)) ([c6ccb69](https://github.com/kaltura/playkit-js-dual-screen/commit/c6ccb69))
+
+
+
+### 3.1.6 (2023-06-07)
+
+### [3.1.5](https://github.com/kaltura/playkit-js-dual-screen/compare/v3.1.4...v3.1.5) (2023-05-15)
 
 
 ### Features
 
-* **FEC-12946:** multiscreen ([#103](https://github.com/kaltura/playkit-js-dual-screen/issues/103)) ([5d973b8](https://github.com/kaltura/playkit-js-dual-screen/commit/5d973b8))
+* **FEC-12946:** multiscreen ([#103](https://github.com/kaltura/playkit-js-dual-screen/issues/103)) ([5d973b8](https://github.com/kaltura/playkit-js-dual-screen/commit/5d973b8632ac6136335418abcbc61f06863dc3a7))
 
 
+### Bug Fixes
+
+* **FEC-13121:** add configuration that allow control if settings component should be removed from player ([#104](https://github.com/kaltura/playkit-js-dual-screen/issues/104)) ([0bddc2f](https://github.com/kaltura/playkit-js-dual-screen/commit/0bddc2f66c0e6a88a10f9e0e1253ff6c07195780))
+* **FEC-13145:** upgrade dependancies for common and ui-managers etc  ([#105](https://github.com/kaltura/playkit-js-dual-screen/issues/105)) ([780c36d](https://github.com/kaltura/playkit-js-dual-screen/commit/780c36d85555ae24143b76283af55ca6656d7596))
 
 ### [3.1.4](https://github.com/kaltura/playkit-js-dual-screen/compare/v3.1.3...v3.1.4) (2023-04-19)
 
@@ -154,7 +352,7 @@ All notable changes to this project will be documented in this file. See [standa
 
 * **FEV-1103:** incorrect live indicator color (state) appear when changing states between DVR to live ([#43](https://github.com/kaltura/playkit-js-dual-screen/issues/43)) ([b020a2b](https://github.com/kaltura/playkit-js-dual-screen/commit/b020a2b8cb8480bd12073cd1dd54534b207191fc))
 * **FEV-1120:** parent and child screens cannot be switched on SBS layout ([#45](https://github.com/kaltura/playkit-js-dual-screen/issues/45)) ([a7c1f95](https://github.com/kaltura/playkit-js-dual-screen/commit/a7c1f95907784881770f8bc3620400470e1e3815))
-* **FEV-1127:** slide appear in child container when changing slides in webcast application while producer set "hide slides" mode ([#44](https://github.com/kaltura/playkit-js-dual-screen/issues/44)) ([914225e](https://github.com/kaltura/playkit-js-dual-screen/commit/914225ebcfc18a4c3e97ef9b29e98ae342002bdd))
+* **FEV-1127:** slide appear in child container when changing slides in webcast application while producer set "hide slides" mode ([#44](https://github.com/kaltura/playkit-js-dual-screen/issues/44)) ([914225e](https://github.com/kaltura/playkit-js-dual-screen/commit/914225ebcfc18a4c3e97ef9b29e98ae3.2.02bdd))
 * **FEV-1130:** Captions disappear when child video is in hidden mode ([#46](https://github.com/kaltura/playkit-js-dual-screen/issues/46)) ([3108788](https://github.com/kaltura/playkit-js-dual-screen/commit/31087880e4cc8265e435610976126cde763e548a))
 
 ### [1.7.4](https://github.com/kaltura/playkit-js-dual-screen/compare/v1.7.3...v1.7.4) (2021-11-04)

package/README.md

@@ -1,5 +1,10 @@
 # PlayKit JS Dual Screen - Dual Screen plugin for the [PlayKit JS Player]
 
+[![Build Status](https://github.com/kaltura/playkit-js-dual-screen/actions/workflows/run_canary_full_flow.yaml/badge.svg)](https://github.com/kaltura/playkit-js-dual-screen/actions/workflows/run_canary_full_flow.yaml)
+[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
+[![](https://img.shields.io/npm/v/@playkit-js/playkit-js-dual-screen/latest.svg)](https://www.npmjs.com/package/@playkit-js/playkit-js-dual-screen)
+[![](https://img.shields.io/npm/v/@playkit-js/playkit-js-dual-screen/canary.svg)](https://www.npmjs.com/package/@playkit-js/playkit-js-dual-screen/v/canary)
+
 PlayKit JS Dual Screen is written in [ECMAScript6], statically analysed using [Typescript] and transpiled in ECMAScript5 using [Babel].
 
 [typescript]: https://www.typescriptlang.org/

package/cypress/e2e/dual-screen.cy.ts

@@ -4,6 +4,10 @@ import {mockKalturaBe, loadPlayer, MANIFEST, MANIFEST_SAFARI, getPlayer} from '.
 
 const {EventType, FakeEvent, Error} = core;
 
+Cypress.on('uncaught:exception', (err, runnable) => {
+  return false;
+});
+
 describe('Dual-Screen plugin', () => {
   beforeEach(() => {
     // manifest
@@ -12,7 +16,7 @@ describe('Dual-Screen plugin', () => {
     cy.intercept('GET', '**/width/164/vid_slices/100', {fixture: '100.jpeg'});
     cy.intercept('GET', '**/height/360/width/640', {fixture: '640.jpeg'});
     // kava
-    cy.intercept('GET', '**/index.php?service=analytics*', {});
+    cy.intercept('**/index.php?service=analytics*', {});
   });
 
   describe('dual-screen layouts', () => {
@@ -169,8 +173,7 @@ describe('Dual-Screen plugin', () => {
         });
       });
     });
-    it.skip('should render multiscreen wrapper with 2 players', () => {
-      // TODO: enable test after fix done for image player in multiscreen
+    it('should render multiscreen wrapper with 2 players', () => {
       mockKalturaBe('dual-screen-2-media.json', 'cue-points.json');
       loadPlayer({}, {startTime: 15}).then(() => {
         cy.get('[data-testid="dualscreen_multiscreen"]').within(() => {
@@ -350,4 +353,112 @@ describe('Dual-Screen plugin', () => {
       });
     });
   });
+
+  describe('Dual-screen plugin API', () => {
+    const testThumbsResult = (result: any, expectedResult: any) => {
+      return (
+        result.height === expectedResult.height &&
+        result.url === expectedResult.url &&
+        result.width === expectedResult.width &&
+        result.x === expectedResult.x &&
+        result.y === expectedResult.y &&
+        result.slide === expectedResult.slide
+      );
+    };
+    it('should check dual-screen service got registered', () => {
+      mockKalturaBe('dual-screen-0-media.json', 'cue-points-empty.json');
+      loadPlayer({}, {autoplay: false}).then(kalturaPlayer => {
+        const dualScreenService = kalturaPlayer.getService('dualScreen');
+        expect(dualScreenService).not.undefined;
+        expect(dualScreenService).has.keys(['getDualScreenThumbs', 'getDualScreenPlayers', 'ready']);
+      });
+    });
+    it('should return thumbs for 2 active media', () => {
+      mockKalturaBe('dual-screen-2-media.json', 'cue-points-empty.json');
+      loadPlayer({layout: 'PIP'}).then(kalturaPlayer => {
+        const thumbResult = {
+          height: 92,
+          url: 'https://qa-apache-php7.dev.kaltura.com/p/5174/sp/517400/thumbnail/entry_id/0_5n7s22ge/version/100002/width/164/vid_slices/100',
+          width: 164,
+          x: 164,
+          y: 0,
+          slide: undefined
+        };
+        const dualScreenService = kalturaPlayer.getService('dualScreen');
+        cy.get('[data-testid="dualscreen_pipChildren"]').then(() => {
+          const thumbs = dualScreenService.getDualScreenThumbs(1);
+          expect(Array.isArray(thumbs)).to.be.true;
+          thumbs.map((thumbInfo: any) => {
+            expect(testThumbsResult(thumbInfo, thumbResult)).to.be.true;
+          });
+        });
+      });
+    });
+    it('should return 1 thumbs if layout SingleMedia', () => {
+      mockKalturaBe('dual-screen-1-media.json', 'cue-points-empty.json');
+      loadPlayer({layout: 'SingleMedia'}).then(kalturaPlayer => {
+        const dualScreenService = kalturaPlayer.getService('dualScreen');
+        cy.get('[data-testid="dualscreen_pipMinimized"]').then(() => {
+          const thumbs = dualScreenService.getDualScreenThumbs(1);
+          expect(Array.isArray(thumbs)).to.be.false;
+          expect(typeof thumbs === 'object').to.be.true;
+        });
+      });
+    });
+    it('should test media and slide thumb', () => {
+      mockKalturaBe('dual-screen-0-media.json', 'cue-points.json');
+      loadPlayer({}, {startTime: 15}).then(kalturaPlayer => {
+        const dualScreenService = kalturaPlayer.getService('dualScreen');
+        cy.get('[alt="Slide 2"]')
+          .and('have.prop', 'naturalWidth')
+          .should('be.greaterThan', 0)
+          .then(() => {
+            const slideThumb = {
+              height: 223,
+              slide: true,
+              url: 'https://mock-thumb-assets/api_v3/index.php/service/thumbAsset/action/serve//thumbAssetId/1_ri4o1mvs/ks/123',
+              width: 400,
+              x: 0,
+              y: 0
+            };
+            const mediaThumb = {
+              height: 92,
+              url: 'https://qa-apache-php7.dev.kaltura.com/p/5174/sp/517400/thumbnail/entry_id/0_5n7s22ge/version/100002/width/164/vid_slices/100',
+              width: 164,
+              x: 4264,
+              y: 0,
+              slide: undefined
+            };
+            const thumbs = dualScreenService.getDualScreenThumbs(16);
+            expect(testThumbsResult(thumbs[0], mediaThumb)).to.be.true;
+            expect(thumbs[1]).to.eql(slideThumb);
+          });
+      });
+    });
+  });
+
+  describe('analytics events', () => {
+    it('should raise the SIDE_DISPLAYED event', done => {
+      mockKalturaBe('dual-screen-1-media.json', 'cue-points-empty.json');
+      loadPlayer({layout: 'PIP'}).then(playerMain => {
+        playerMain.addEventListener('dualscreen_side_displayed', () => {
+          done();
+        });
+      });
+    });
+
+    it('should raise the CHANGE_LAYOUT event', done => {
+      mockKalturaBe('dual-screen-1-media.json', 'cue-points-empty.json');
+      loadPlayer({layout: 'PIP'}).then(playerMain => {
+        playerMain.addEventListener('dualscreen_change_layout', () => {
+          done();
+        });
+
+        cy.get('[data-testid="dualscreen_sideBySideWrapper"]').should('not.exist');
+        cy.get('[data-testid="dualscreen_pipChildren"]').within(() => {
+          cy.get('[data-testid="dualscreen_switchToSideBySide"]').click({force: true});
+        });
+      });
+    });
+  });
 });