react-native-theoplayer 8.6.0 → 8.8.0

package/lib/typescript/internal/version/Version.web.d.ts

@@ -0,0 +1,3 @@
+import { SdkVersions } from 'react-native-theoplayer';
+export declare const sdkVersions: () => Promise<SdkVersions>;
+//# sourceMappingURL=Version.web.d.ts.map

package/lib/typescript/internal/version/Version.web.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Version.web.d.ts","sourceRoot":"","sources":["../../../../src/internal/version/Version.web.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAItD,eAAO,MAAM,WAAW,QAAa,QAAQ,WAAW,CAMvD,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-theoplayer",
-  "version": "8.6.0",
+  "version": "8.8.0",
   "description": "A THEOplayer video component for react-native.",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
@@ -29,7 +29,8 @@
     "prettier:fix": "prettier --write \"(src|example|e2e)/**/*.{js,jsx,ts,tsx}\"",
     "lint": "eslint \"**/*.{ts,tsx}\"",
     "lint:fix": "npm run lint -- --fix",
-    "prepare": "bob build && husky",
+    "manifest": "node manifest.js > src/manifest.json",
+    "prepare": "npm run manifest && bob build && husky",
     "pods": "cd example && pod-install --quiet",
     "docs": "typedoc --treatWarningsAsErrors"
   },

package/react-native-theoplayer.podspec

@@ -25,7 +25,7 @@ Pod::Spec.new do |s|
   s.platforms    = { :ios => "13.4", :tvos => "13.4" }
   s.source       = { :git => "https://www.theoplayer.com/.git", :tag => "#{s.version}" }
 
-  s.source_files = 'ios/*.{h,m,swift}', 'ios/ads/*.swift', 'ios/casting/*.swift', 'ios/contentprotection/*.swift', 'ios/pip/*.swift', 'ios/backgroundAudio/*.swift', 'ios/cache/*.swift', 'ios/sideloadedMetadata/*.swift', 'ios/eventBroadcasting/*.swift' , 'ios/ui/*.swift', 'ios/presentationMode/*.swift'
+  s.source_files = 'ios/*.{h,m,swift}', 'ios/ads/*.swift', 'ios/casting/*.swift', 'ios/contentprotection/*.swift', 'ios/pip/*.swift', 'ios/backgroundAudio/*.swift', 'ios/cache/*.swift', 'ios/sideloadedMetadata/*.swift', 'ios/eventBroadcasting/*.swift' , 'ios/ui/*.swift', 'ios/presentationMode/*.swift', 'ios/viewController/*.swift'
   s.resources = ['ios/*.css']
 
   # ReactNative Dependency

package/src/api/ads/AdsAPI.ts

@@ -5,6 +5,7 @@ import type { AdDescription } from "../source/ads/Ads";
 import type { AdBreak } from "./AdBreak";
 import type { Ad } from "./Ad";
 import type { GoogleDAI } from "./GoogleDai";
+import { Omid } from './Omid';
 
 export interface AdsAPI {
   /**
@@ -50,4 +51,11 @@ export interface AdsAPI {
    * <br/> - Only available when the feature or extension `'google-dai'` is enabled.
    */
   readonly dai?: GoogleDAI;
+
+  /**
+   * The Omid API, which can be used to add as well as remove friendly video controls overlay obstructions.
+   *
+   * @since React Native THEOplayer SDK v8.7.0.
+   */
+  readonly omid?: Omid;
 }

package/src/api/ads/Omid.ts

@@ -0,0 +1,58 @@
+import React from 'react';
+import { View } from 'react-native';
+
+export enum OmidFriendlyObstructionPurpose {
+  /**
+   * The video overlay is one of the video player's control button.
+   */
+  VIDEO_CONTROLS = 'videoControls',
+
+  /**
+   * The video overlay is for the purpose of closing the advertisement.
+   */
+  CLOSE_AD = 'closeAd',
+
+  /**
+   * The video overlay is transparent and will not affect viewability.
+   */
+  NOT_VISIBLE = 'notVisible',
+
+  /**
+   * The video overlay is meant for other purposes.
+   */
+  OTHER = 'other',
+}
+
+export interface OmidFriendlyObstruction {
+  /**
+   * The View of the friendly obstruction.
+   */
+  view: React.RefObject<View>;
+
+  /**
+   * The {@link OmidFriendlyObstructionPurpose} of the friendly obstruction.
+   */
+  purpose: OmidFriendlyObstructionPurpose;
+
+  /**
+   * The optional reason for the friendly obstruction.
+   */
+  reason?: string;
+}
+
+/**
+ * The Omid API, which can be used to add as well as remove friendly video controls overlay obstructions.
+ */
+export interface Omid {
+
+  /**
+   * Adds an {@link OmidFriendlyObstruction}.
+   * @param obstruction
+   */
+  addFriendlyObstruction(obstruction: OmidFriendlyObstruction): void;
+
+  /**
+   * Removes all {@link OmidFriendlyObstruction}s.
+   */
+  removeAllFriendlyObstructions(): void;
+}

package/src/api/ads/barrel.ts

@@ -6,3 +6,4 @@ export * from './CompanionAd';
 export * from './GoogleDai';
 export * from './GoogleImaAd';
 export * from './GoogleImaConfiguration';
+export * from './Omid';

package/src/api/barrel.ts

@@ -21,3 +21,4 @@ export * from './THEOplayerView';
 export * from './playback/barrel';
 export * from './player/barrel';
 export * from './presentation/barrel';
+export * from './version/barrel';

package/src/api/player/THEOplayer.ts

@@ -235,6 +235,8 @@ export interface THEOplayer extends EventDispatcher<PlayerEventMap> {
 
   /**
    * The player version.
+   *
+   * @deprecated use {@link sdkVersions} instead.
    */
   readonly version: PlayerVersion;
 

package/src/api/version/barrel.ts

@@ -0,0 +1 @@
+export * from './SdkVersions';

package/src/index.tsx

@@ -3,3 +3,4 @@ export { THEOplayerView } from './internal/THEOplayerView';
 export { ContentProtectionRegistry } from './internal/drm/ContentProtectionRegistry';
 export { MediaCache } from './internal/cache/MediaCache';
 export { PlaybackSettings } from './internal/playback/PlaybackSettings';
+export { sdkVersions } from './internal/version/Version';

package/src/internal/adapter/ads/THEOplayerNativeAdsAdapter.ts

@@ -1,14 +1,18 @@
 import type { Ad, AdBreak, AdDescription, AdsAPI, GoogleDAI, THEOplayerView } from 'react-native-theoplayer';
 import { NativeModules } from 'react-native';
 import { THEOplayerNativeGoogleDAI } from './THEOplayerNativeGoogleDAI';
+import { THEOplayerNativeOmid } from './THEOplayerNativeOmid';
+import { Omid } from '../../../api/ads/Omid';
 
 const NativeAdsModule = NativeModules.THEORCTAdsModule;
 
 export class THEOplayerNativeAdsAdapter implements AdsAPI {
   private readonly _dai: GoogleDAI;
+  private readonly _omid: Omid;
 
   constructor(private _player: THEOplayerView) {
     this._dai = new THEOplayerNativeGoogleDAI(this._player);
+    this._omid = new THEOplayerNativeOmid(this._player);
   }
 
   playing(): Promise<boolean> {
@@ -38,4 +42,8 @@ export class THEOplayerNativeAdsAdapter implements AdsAPI {
   get dai(): GoogleDAI | undefined {
     return this._dai;
   }
+
+  get omid(): Omid | undefined {
+    return this._omid;
+  }
 }

package/src/internal/adapter/ads/THEOplayerNativeOmid.ts

@@ -0,0 +1,21 @@
+import type { THEOplayerView } from 'react-native-theoplayer';
+import { findNodeHandle, NativeModules } from 'react-native';
+import { Omid, OmidFriendlyObstruction } from '../../../api/ads/Omid';
+
+const NativeAdsModule = NativeModules.THEORCTAdsModule;
+
+export class THEOplayerNativeOmid implements Omid {
+  public constructor(private readonly _player: THEOplayerView) {}
+
+  addFriendlyObstruction(obstruction: OmidFriendlyObstruction): void {
+    NativeAdsModule.addFriendlyObstruction(this._player.nativeHandle, {
+      view: findNodeHandle(obstruction.view.current),
+      purpose: obstruction.purpose,
+      reason: obstruction.reason,
+    });
+  }
+
+  removeAllFriendlyObstructions(): void {
+    NativeAdsModule.removeAllFriendlyObstructions(this._player.nativeHandle);
+  }
+}

package/src/internal/adapter/ads/THEOplayerWebAdsAdapter.ts

@@ -1,6 +1,7 @@
 import type { Ad, AdBreak, AdDescription, AdsAPI, GoogleDAI } from 'react-native-theoplayer';
 import { THEOplayerWebGoogleDAI } from './THEOplayerWebGoogleDAI';
 import type { ChromelessPlayer } from 'theoplayer';
+import { Omid } from '../../../api/ads/Omid';
 
 export class THEOplayerWebAdsAdapter implements AdsAPI {
   private readonly _player: ChromelessPlayer;
@@ -48,4 +49,10 @@ export class THEOplayerWebAdsAdapter implements AdsAPI {
     }
     return this._dai;
   }
+
+  get omid(): Omid | undefined {
+    // NYI
+    console.warn('The Omid API is not yet implemented for Web platforms.');
+    return undefined;
+  }
 }

package/src/internal/version/Version.ts

@@ -0,0 +1,12 @@
+import { NativeModules } from 'react-native';
+import type { SdkVersions } from 'react-native-theoplayer';
+import * as manifest from '../../manifest.json';
+
+export const sdkVersions = async (): Promise<SdkVersions> => {
+  const rnVersionString = manifest.version ?? '';
+  const nativeVersionString = await NativeModules.THEORCTPlayerModule.version();
+  return {
+    rn: rnVersionString,
+    native: nativeVersionString,
+  };
+};

package/src/internal/version/Version.web.ts

@@ -0,0 +1,11 @@
+import { SdkVersions } from 'react-native-theoplayer';
+import { version as nativeVersionString } from 'theoplayer';
+import manifest from '../../manifest.json';
+
+export const sdkVersions = async (): Promise<SdkVersions> => {
+  const rnVersionString = manifest.version ?? '';
+  return {
+    rn: rnVersionString,
+    native: nativeVersionString,
+  };
+};

package/src/manifest.json

@@ -0,0 +1 @@
+{"version":"8.8.0","buildDate":"2024-11-19T15:05:29.967Z"}