@playkit-js/playkit-js-kava 1.16.1 → 1.17.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@playkit-js/playkit-js-kava",
-  "version": "1.16.1",
+  "version": "1.17.0",
   "main": "dist/playkit-kava.js",
   "scripts": {
     "disabled-preinstall": "npx --yes --prefer-online --registry=https://npm.pkg.github.com --package @kaltura/kaltura-tools@latest kaltura-tools check --root=.",

package/src/application-events-model.ts

@@ -51,6 +51,11 @@ export function getApplicationEventsModel(eventObj: KavaEvent, model: KavaModel,
     namedEventModel['pageType'] = eventVar2;
     namedEventModel['pageValue'] = eventVar3;
     namedEventModel['pageInfo'] = eventVar4;
+  } else if (eventModel.eventType === ApplicationEventType.CONTENT_MILESTONE) {
+    namedEventModel['eventName'] = eventVar1;
+    if (typeof eventVar2 !== 'undefined') {
+      namedEventModel['completionThreshold'] = eventVar2;
+    }
   }
 
   return Object.assign(namedEventModel, commonModel);
@@ -1265,5 +1270,22 @@ export const ApplicationEventsModel: { [playerEventName: string]: KavaEvent } =
       eventVar4: '',
       applicationFeature: ApplicationFeature.GENIE
     })
+  },
+  [PluginsEvents.VOD_COMPLETION_VIDEO_STARTED]: {
+    type: 'VOD_COMPLETION_VIDEO_STARTED',
+    getEventModel: (): any => ({
+      eventType: ApplicationEventType.CONTENT_MILESTONE,
+      eventVar1: 'video_started',
+      applicationFeature: ApplicationFeature.VOD_COMPLETION
+    })
+  },
+  [PluginsEvents.VOD_COMPLETION_VIDEO_COMPLETED]: {
+    type: 'VOD_COMPLETION_VIDEO_COMPLETED',
+    getEventModel: ({ completionThreshold }: any): any => ({
+      eventType: ApplicationEventType.CONTENT_MILESTONE,
+      eventVar1: 'video_completed',
+      eventVar2: completionThreshold,
+      applicationFeature: ApplicationFeature.VOD_COMPLETION
+    })
   }
 };

package/src/applications-events.ts

@@ -174,6 +174,11 @@ export const GenieEvents = {
   GENIE_NEW_THREAD: 'genie_new_thread'
 };
 
+export const VodCompletionEvents = {
+  VOD_COMPLETION_VIDEO_STARTED: 'vod_completion_video_started',
+  VOD_COMPLETION_VIDEO_COMPLETED: 'vod_completion_video_completed'
+};
+
 export const PluginsEvents = {
   ...NavigationEvents,
   ...DownloadEvents,
@@ -194,5 +199,6 @@ export const PluginsEvents = {
   ...AudioPlayerEvents,
   ...CpeTrackerEvents,
   ...BannerOverlayEvents,
-  ...GenieEvents
+  ...GenieEvents,
+  ...VodCompletionEvents
 };

package/src/enums/application-event-type.ts

@@ -1,4 +1,5 @@
 export const ApplicationEventType = {
   BUTTON_CLICKED: 10002,
-  PAGE_LOAD: 10003
+  PAGE_LOAD: 10003,
+  CONTENT_MILESTONE: 10004
 };

package/src/enums/application-feature.ts

@@ -23,5 +23,6 @@ export enum ApplicationFeature {
   AUDIO_PLAYER = 'audio_player',
   CPE_TRACKER = 'cpe_tracker',
   BANNER_OVERLAY = 'banner_overlay',
-  GENIE = 'genie'
+  GENIE = 'genie',
+  VOD_COMPLETION = 'vod_completion'
 }

package/src/kava.ts

@@ -982,7 +982,7 @@ class Kava extends BasePlugin {
 
   private _isApplicationEventValid(event: FakeEvent): boolean {
     const model = getApplicationEventsModel(ApplicationEventsModel[event.type], this._model, event.payload);
-    return !!model.buttonName || !!model.pageName;
+    return !!model.buttonName || !!model.pageName || !!model.eventName;
   }
 
   private _logMissingParam(missingParam: string): void {

package/test/e2e/application-events.model.spec.js

@@ -75,6 +75,29 @@ describe('ApplicationEventsModel', () => {
       });
     });
   });
+  describe('Content Milestone parameters', () => {
+    it('Should return the correct Content Milestone params with completionThreshold', () => {
+      eventModel = { eventType: ApplicationEventType.CONTENT_MILESTONE, eventVar1: 'var1', eventVar2: 'var2' };
+
+      getApplicationEventsModel(eventObj, model).should.deep.equal({
+        ...commonModel,
+        eventType: ApplicationEventType.CONTENT_MILESTONE,
+        eventName: 'var1',
+        completionThreshold: 'var2'
+      });
+    });
+    it('Should return the correct Content Milestone params without completionThreshold', () => {
+      eventModel = { eventType: ApplicationEventType.CONTENT_MILESTONE, eventVar1: 'var1' };
+
+      const result = getApplicationEventsModel(eventObj, model);
+      result.should.deep.equal({
+        ...commonModel,
+        eventType: ApplicationEventType.CONTENT_MILESTONE,
+        eventName: 'var1'
+      });
+      result.should.not.have.property('completionThreshold');
+    });
+  });
   describe('Optional parameters', () => {
     it('Should return the correct event type value', () => {
       customModel = { application: 'abc' };