feat: add AdEvent enum to have an exhaustive list of all possible AdE…

…vent values (#3374)

* feat: add AdEvent enum to have an exhaustive list of all possible values

src/VideoNativeComponent.ts

@@ -7,7 +7,7 @@ import {NativeModules, requireNativeComponent} from 'react-native';
 import type ResizeMode from './types/ResizeMode';
 import type FilterType from './types/FilterType';
 import type Orientation from './types/Orientation';
-import type {OnTextTracksTypeData} from './types';
+import type {AdEvent, OnTextTracksTypeData} from './types';
 
 // -------- There are types for native component (future codegen) --------
 // if you are looking for types for react component, see src/types/video.ts
@@ -237,7 +237,7 @@ export type OnPictureInPictureStatusChangedData = Readonly<{
 }>;
 
 export type OnReceiveAdEventData = Readonly<{
-  event: string;
+  event: AdEvent;
 }>;
 
 export type OnVideoErrorData = Readonly<{

src/types/Ads.ts

@@ -0,0 +1,150 @@
+export enum AdEvent {
+  /**
+   * iOS only: Fired the first time each ad break ends. Applications must reenable seeking when this occurs (only used for dynamic ad insertion).
+   */
+  AD_BREAK_ENDED = 'AD_BREAK_ENDED',
+  /**
+   * Fires when an ad rule or a VMAP ad break would have played if autoPlayAdBreaks is false.
+   */
+  AD_BREAK_READY = 'AD_BREAK_READY',
+  /**
+   * iOS only: Fired first time each ad break begins playback. If an ad break is watched subsequent times this will not be fired. Applications must disable seeking when this occurs (only used for dynamic ad insertion).
+   */
+  AD_BREAK_STARTED = 'AD_BREAK_STARTED',
+  /**
+   * Android only: Fires when the ad has stalled playback to buffer.
+   */
+  AD_BUFFERING = 'AD_BUFFERING',
+  /**
+   * Android only: Fires when the ad is ready to play without buffering, either at the beginning of the ad or after buffering completes.
+   */
+  AD_CAN_PLAY = 'AD_CAN_PLAY',
+  /**
+   * Android only: Fires when an ads list is loaded.
+   */
+  AD_METADATA = 'AD_METADATA',
+  /**
+   * iOS only: Fired every time the stream switches from advertising or slate to content. This will be fired even when an ad is played a second time or when seeking into an ad (only used for dynamic ad insertion).
+   */
+  AD_PERIOD_ENDED = 'AD_PERIOD_ENDED',
+  /**
+   * iOS only: Fired every time the stream switches from content to advertising or slate. This will be fired even when an ad is played a second time or when seeking into an ad (only used for dynamic ad insertion).
+   */
+  AD_PERIOD_STARTED = 'AD_PERIOD_STARTED',
+  /**
+   * Android only: Fires when the ad's current time value changes. Calling getAdData() on this event will return an AdProgressData object.
+   */
+  AD_PROGRESS = 'AD_PROGRESS',
+  /**
+   * Fires when the ads manager is done playing all the valid ads in the ads response, or when the response doesn't return any valid ads.
+   */
+  ALL_ADS_COMPLETED = 'ALL_ADS_COMPLETED',
+  /**
+   * Fires when the ad is clicked.
+   */
+  CLICK = 'CLICK',
+  /**
+   * Fires when the ad completes playing.
+   */
+  COMPLETED = 'COMPLETED',
+  /**
+   * Android only: Fires when content should be paused. This usually happens right before an ad is about to cover the content.
+   */
+  CONTENT_PAUSE_REQUESTED = 'CONTENT_PAUSE_REQUESTED',
+  /**
+   * Android only: Fires when content should be resumed. This usually happens when an ad finishes or collapses.
+   */
+  CONTENT_RESUME_REQUESTED = 'CONTENT_RESUME_REQUESTED',
+  /**
+   * iOS only: Cuepoints changed for VOD stream (only used for dynamic ad insertion).
+   */
+  CUEPOINTS_CHANGED = 'CUEPOINTS_CHANGED',
+  /**
+   * Android only: Fires when the ad's duration changes.
+   */
+  DURATION_CHANGE = 'DURATION_CHANGE',
+  /**
+   * Fires when the ad playhead crosses first quartile.
+   */
+  FIRST_QUARTILE = 'FIRST_QUARTILE',
+  /**
+   * Android only: Fires when the impression URL has been pinged.
+   */
+  IMPRESSION = 'IMPRESSION',
+  /**
+   * Android only: Fires when an ad triggers the interaction callback. Ad interactions contain an interaction ID string in the ad data.
+   */
+  INTERACTION = 'INTERACTION',
+  /**
+   * Android only: Fires when the displayed ad changes from linear to nonlinear, or the reverse.
+   */
+  LINEAR_CHANGED = 'LINEAR_CHANGED',
+  /**
+   * Fires when ad data is available.
+   */
+  LOADED = 'LOADED',
+  /**
+   * Fires when a non-fatal error is encountered. The user need not take any action since the SDK will continue with the same or next ad playback depending on the error situation.
+   */
+  LOG = 'LOG',
+  /**
+   * Fires when the ad playhead crosses midpoint.
+   */
+  MIDPOINT = 'MIDPOINT',
+  /**
+   * Fires when the ad is paused.
+   */
+  PAUSED = 'PAUSED',
+  /**
+   * Fires when the ad is resumed.
+   */
+  RESUMED = 'RESUMED',
+  /**
+   * Android only: Fires when the displayed ads skippable state is changed.
+   */
+  SKIPPABLE_STATE_CHANGED = 'SKIPPABLE_STATE_CHANGED',
+  /**
+   * Fires when the ad is skipped by the user.
+   */
+  SKIPPED = 'SKIPPED',
+  /**
+   * Fires when the ad starts playing.
+   */
+  STARTED = 'STARTED',
+  /**
+   * iOS only: Stream request has loaded (only used for dynamic ad insertion).
+   */
+  STREAM_LOADED = 'STREAM_LOADED',
+  /**
+   * iOS only: Fires when the ad is tapped.
+   */
+  TAPPED = 'TAPPED',
+  /**
+   * Fires when the ad playhead crosses third quartile.
+   */
+  THIRD_QUARTILE = 'THIRD_QUARTILE',
+  /**
+   * iOS only: An unknown event has fired
+   */
+  UNKNOWN = 'UNKNOWN',
+  /**
+   * Android only: Fires when the ad is closed by the user.
+   */
+  USER_CLOSE = 'USER_CLOSE',
+  /**
+   * Android only: Fires when the non-clickthrough portion of a video ad is clicked.
+   */
+  VIDEO_CLICKED = 'VIDEO_CLICKED',
+  /**
+   * Android only: Fires when a user clicks a video icon.
+   */
+  VIDEO_ICON_CLICKED = 'VIDEO_ICON_CLICKED',
+  /**
+   * Android only: Fires when the ad volume has changed.
+   */
+  VOLUME_CHANGED = 'VOLUME_CHANGED',
+  /**
+   * Android only: Fires when the ad volume has been muted.
+   */
+  VOLUME_MUTED = 'VOLUME_MUTED',
+}

src/types/events.ts

@@ -1,4 +1,5 @@
 import type Orientation from './Orientation';
+import type {AdEvent} from './Ads';
 
 export type OnLoadData = Readonly<{
   currentTime: number;
@@ -114,7 +115,7 @@ export type OnPictureInPictureStatusChangedData = Readonly<{
 }>;
 
 export type OnReceiveAdEventData = Readonly<{
-  event: string;
+  event: AdEvent;
 }>;
 
 export type OnVideoErrorData = Readonly<{

src/types/index.ts

@@ -1,3 +1,4 @@
+export * from './Ads';
 export * from './events';
 export {default as FilterType} from './FilterType';
 export * from './language';