@devix-technologies/react-gjirafa-vp-player 1.0.29 → 1.0.31-beta.0

package/dist/interfaces/props.d.ts

@@ -1,77 +0,0 @@
-import { VPPlayerConfig } from './config';
-import { CurrentVideoData, PlaylistItem, PlayerEventCallbacks, PlayerTrackingMetadata } from '../../../../../../../src/types';
-/**
- * Interface defining the parameters for configuring the VP Player instance.
- *
- * @interface
- */
-export interface PlayerParams {
-    playerId: string;
-    config?: Partial<VPPlayerConfig>;
-    videoId?: string;
-    projectId?: string;
-    videoUrl?: string;
-    playlistId?: string;
-    scriptUrl?: string;
-    version?: string | null;
-    thumbnailUrl?: string;
-    isReels?: boolean;
-    hiddenClasses?: string[];
-    className?: string;
-    onPlaylistData?: (videos: PlaylistItem[]) => void;
-}
-/**
- * Interface for the VP Player context, providing methods and state for controlling the player.
- *
- * @interface
- */
-export interface VPPlayerContextType {
-    showPlayer: (params: PlayerParams) => void;
-    hidePlayer: () => void;
-    isPlayerVisible: boolean;
-    playerParams: PlayerParams | null;
-}
-/**
- * Interface defining the properties for the VP Player component.
- *
- * @interface
- */
-export interface VPPlayerProps {
-    playerId: string;
-    config?: Partial<VPPlayerConfig>;
-    videoId?: string;
-    projectId?: string;
-    videoUrl?: string;
-    playlistId?: string;
-    scriptUrl?: string;
-    version?: string | null;
-    isReels?: boolean;
-    thumbnailUrl?: string;
-    onClose?: () => void;
-    hiddenClasses?: string[];
-    isPlayerVisible?: boolean;
-    className?: string;
-    onPlaylistData?: (videos: PlaylistItem[]) => void;
-    onVideoStarted?: (videoData: CurrentVideoData) => void;
-    /**
-     * Video metadata for tracking/analytics callbacks
-     */
-    trackingMetadata?: PlayerTrackingMetadata;
-    onPlayerStart?: PlayerEventCallbacks["onPlayerStart"];
-    onPlayerPlay?: PlayerEventCallbacks["onPlayerPlay"];
-    onPlayerPause?: PlayerEventCallbacks["onPlayerPause"];
-    onPlayerResume?: PlayerEventCallbacks["onPlayerResume"];
-    onPlayerEnd?: PlayerEventCallbacks["onPlayerEnd"];
-    onPlayerProgressEvery10Seconds?: PlayerEventCallbacks["onPlayerProgressEvery10Seconds"];
-    onPlayerProgressAt20Seconds?: PlayerEventCallbacks["onPlayerProgressAt20Seconds"];
-    onPlayerQuartile25?: PlayerEventCallbacks["onPlayerQuartile25"];
-    onPlayerQuartile50?: PlayerEventCallbacks["onPlayerQuartile50"];
-    onPlayerQuartile75?: PlayerEventCallbacks["onPlayerQuartile75"];
-    onPlayerNext?: PlayerEventCallbacks["onPlayerNext"];
-    onPlayerPrevious?: PlayerEventCallbacks["onPlayerPrevious"];
-    /**
-     * Universal callback for all events - called in addition to specific callbacks
-     * this gives us all event in one callback
-     */
-    onPlayerEvent?: PlayerEventCallbacks["onPlayerEvent"];
-}

package/dist/types/api.types.d.ts

@@ -1,81 +0,0 @@
-/**
- * API response types for VP Player.
- *
- * @interface VideoApiItem
- * Represents an individual video item in the API response.
- */
-export interface VideoApiItem {
-    mediaId: string;
-    playbackUrl: string;
-}
-/**
- * API response structure for fetching video data.
- *
- * @interface VideoApiResponse
- */
-export interface VideoApiResponse {
-    result: {
-        items: VideoApiItem[];
-    };
-}
-/**
- * Represents an item in a video playlist.
- *
- * @interface PlaylistItem
- */
-export interface PlaylistItem {
-    mediaId: string;
-    videoId?: string;
-    title: string;
-    description?: string;
-    hlsUrl: string;
-    playbackUrl?: string;
-    file?: string;
-    thumbnailUrl: string;
-    duration: number;
-    durationString?: string;
-    isBackupPlaylist?: boolean;
-}
-/**
- * API response structure for fetching playlist data.
- *
- * @interface PlaylistApiResponse
- */
-export interface PlaylistApiResponse {
-    result: PlaylistItem[];
-}
-/**
- * Result structure returned by the video data fetching logic.
- *
- * @interface VideoDataResult
- */
-export interface VideoDataResult {
-    fetchedPlaybackUrl: string | null;
-    fetchedPlaylist: PlaylistItem[] | null;
-    isLoading: boolean;
-    error: string | null;
-}
-/**
- * Represents data about the currently playing video.
- * Used in onVideoStarted callback.
- *
- * @interface CurrentVideoData
- */
-export interface CurrentVideoData {
-    title?: string;
-    file?: string;
-    hlsUrl?: string;
-    thumbnailUrl?: string;
-    duration?: number;
-    videoIndex?: number;
-    playlistVideoIndex?: number;
-    isBackupPlaylist?: boolean;
-    videoId?: string;
-    mediaId?: string;
-    publishDate?: string;
-    projectId?: string;
-    premium?: boolean;
-    author?: string;
-    tags?: string[];
-    description?: string;
-}

package/dist/types/index.d.ts

@@ -1,2 +0,0 @@
-export * from './api.types';
-export * from './playerEvents.types';

package/dist/types/playerEvents.types.d.ts

@@ -1,67 +0,0 @@
-/**
- * Player event types that can be tracked
- */
-export type PlayerEventType = "player_start" | "player_play" | "player_pause" | "player_resume" | "player_end" | "player_progress_every_10_seconds" | "player_progress_at_20_seconds" | "player_quartile_25" | "player_quartile_50" | "player_quartile_75" | "player_next" | "player_previous";
-/**
- * Player event data structure
- */
-export interface PlayerEventData {
-    event: PlayerEventType;
-    player: PlayerObject;
-    _clear?: boolean;
-}
-/**
- * Player object structure for analytics
- */
-export interface PlayerObject {
-    videoId?: string;
-    title?: string;
-    categoryName?: string;
-    publishedDate?: string;
-    isPremium?: boolean;
-    tags?: string[];
-    isReels?: boolean;
-    currentPosition?: number;
-    duration?: number;
-    progress?: number;
-}
-/**
- * Callback function type for player events
- * Accepts event name (PlayerEventType) and optionally currentPosition for progress events
- */
-export type PlayerEventCallback = (event: PlayerEventType, currentPosition?: number) => void;
-/**
- * Tracking metadata for analytics (available in v1.0.23+)
- */
-export interface PlayerTrackingMetadata {
-    videoId: string;
-    title: string;
-    categoryName?: string;
-    publishedDate?: string;
-    isPremium?: boolean;
-    tags?: string[];
-    isReels?: boolean;
-}
-/**
- * Individual event callbacks
- * Each callback accepts only the event name (PlayerEventType)
- */
-export interface PlayerEventCallbacks {
-    onPlayerStart?: (event: PlayerEventType) => void;
-    onPlayerPlay?: (event: PlayerEventType) => void;
-    onPlayerPause?: (event: PlayerEventType) => void;
-    onPlayerResume?: (event: PlayerEventType) => void;
-    onPlayerEnd?: (event: PlayerEventType) => void;
-    onPlayerProgressEvery10Seconds?: (event: PlayerEventType, currentPosition: number) => void;
-    onPlayerProgressAt20Seconds?: (event: PlayerEventType, currentPosition: number) => void;
-    onPlayerQuartile25?: (event: PlayerEventType, currentPosition: number) => void;
-    onPlayerQuartile50?: (event: PlayerEventType, currentPosition: number) => void;
-    onPlayerQuartile75?: (event: PlayerEventType, currentPosition: number) => void;
-    onPlayerNext?: (event: PlayerEventType) => void;
-    onPlayerPrevious?: (event: PlayerEventType) => void;
-    /**
-     * Universal callback for all events - called in addition to specific callbacks
-     * Accepts event name (PlayerEventType) and optionally currentPosition for progress events
-     */
-    onPlayerEvent?: PlayerEventCallback;
-}

package/dist/utils/index.d.ts

@@ -1,2 +0,0 @@
-export * from './vpPlayerConfigBuilder';
-export * from './vpPlayerUtils';

package/dist/utils/vpPlayerConfigBuilder.d.ts

@@ -1,30 +0,0 @@
-import { VPPlayerConfig } from '../../../../../../../src/interfaces';
-import { PlaylistItem } from '../../../../../../../src/types';
-/**
- * Interface for options used in building the VP Player configuration.
- *
- * @interface ConfigBuilderOptions
- */
-interface ConfigBuilderOptions {
-    videoUrl?: string;
-    fetchedPlaybackUrl?: string;
-    fetchedPlaylist?: PlaylistItem[];
-    projectId?: string;
-    config?: Partial<VPPlayerConfig>;
-    isVerticalPlayer?: boolean;
-}
-/**
- * Builds the final VP Player configuration based on available data.
- * Handles different data sources in priority order:
- * 1. Direct video URL
- * 2. Single video from API
- * 3. Playlist from API
- * 4. Playlist from config
- *
- * @function
- * @param {ConfigBuilderOptions} options - Options for building the configuration
- * @returns {VPPlayerConfig} - The final configuration object for the player
- * @throws {Error} - Throws error if no valid video source is found
- */
-export declare const buildVPPlayerConfig: ({ videoUrl, fetchedPlaybackUrl, fetchedPlaylist, projectId, config, isVerticalPlayer, }: ConfigBuilderOptions) => VPPlayerConfig;
-export {};

package/dist/utils/vpPlayerUtils.d.ts

@@ -1,8 +0,0 @@
-/**
- * Extracts the video ID from a given VP Player script URL.
- *
- * @function
- * @param {string} [scriptUrl] - The script URL containing the video ID.
- * @returns {string | undefined} The extracted video ID, or `undefined` if not found.
- */
-export declare const extractVideoId: (scriptUrl?: string) => string | undefined;