Merge pull request #21 from THEOplayer/fix-yospace-in-conviva-types

Fix error in Conviva type definitions when Yospace is not installed

.changeset/nine-buckets-smoke.md

@@ -0,0 +1,5 @@
+---
+"@theoplayer/conviva-connector-web": patch
+---
+
+Fixed an issue where TypeScript could throw a TS2307 type error on the generated type definitions when the optional `@theoplayer/yospace-connector-web` peer dependency is not installed.

.changeset/proud-bottles-reflect.md

@@ -0,0 +1,5 @@
+---
+"@theoplayer/conviva-connector-web": minor
+---
+
+Changed Conviva SDK to a peer dependency, enabling users to update it independently from the Conviva connector.

conviva/package.json

@@ -33,16 +33,17 @@
     "LICENSE.md",
     "package.json"
   ],
-  "dependencies": {
-    "@convivainc/conviva-js-coresdk": "^4.7.4"
-  },
   "peerDependencies": {
+    "@convivainc/conviva-js-coresdk": "^4.7.4",
     "@theoplayer/yospace-connector-web": "^2.1.1",
     "theoplayer": "^5.0.0 || ^6.0.0 || ^7.0.0"
   },
   "peerDependenciesMeta": {
     "@theoplayer/yospace-connector-web": {
       "optional": true
     }
+  },
+  "devDependencies": {
+    "@convivainc/conviva-js-coresdk": "^4.7.4"
   }
 }

conviva/src/integration/ConvivaConnector.ts

@@ -1,5 +1,6 @@
 import type { ChromelessPlayer } from 'theoplayer';
 import type { ConvivaMetadata } from '@convivainc/conviva-js-coresdk';
+/** @ts-ignore Optional dependency, will become `any` if not installed. */
 import type { YospaceConnector } from '@theoplayer/yospace-connector-web';
 import { ConvivaConfiguration, ConvivaHandler } from './ConvivaHandler';
 

conviva/src/integration/ads/YospaceAdReporter.ts

@@ -99,7 +99,8 @@ export class YospaceAdReporter {
     };
 
     private readonly onYospaceSessionError = (code: SessionErrorCode) => {
-        if (code === SessionErrorCode.TIMEOUT) {
+        const yospaceCode = code as number as YospaceSessionErrorCode;
+        if (yospaceCode === YospaceSessionErrorCode.TIMEOUT) {
             this.convivaVideoAnalytics.reportPlaybackError('The Yospace session has timed out.');
         } else {
             this.convivaVideoAnalytics.reportPlaybackError('The Yospace session has errored.');
@@ -121,3 +122,8 @@ export class YospaceAdReporter {
         this.yospaceConnector.unregisterAnalyticEventObserver(this.observer);
     }
 }
+
+// Keep this in sync with SessionErrorCode from yospace-connector-web
+enum YospaceSessionErrorCode {
+    TIMEOUT = 0
+}

yospace/src/yospace/AnalyticEventObserver.ts

@@ -2,8 +2,9 @@ import { AdBreak, AdVert } from './AdBreak';
 import { TrackingError } from './TrackingError';
 import { YospaceSessionManager } from './YospaceSessionManager';
 
+// Keep this in sync with YospaceSessionErrorCode from conviva-connector-web
 export enum SessionErrorCode {
-    TIMEOUT
+    TIMEOUT = 0
 }
 
 export interface AnalyticEventObserver {