@jaaq/jaaq-sdk-js 1.0.1 → 1.1.0

package/dist/ui/react/index.d.ts

@@ -0,0 +1,182 @@
+import * as React from 'react';
+
+type VideoDTO = {
+    id: string;
+    videoId: string;
+    question: string;
+    status: number;
+    transcription: string;
+    subtitle: string;
+    createdAt: string;
+    videoUrl: string;
+    published: boolean;
+    tags: string[];
+    severity: number | null;
+    duration: number;
+    description: string;
+};
+
+type CollectionDTO = {
+    id: string;
+    name: string;
+    description: string;
+    imageUrl: string;
+    createdAt: string;
+    videos: VideoDTO[];
+};
+
+type FetchLike = typeof globalThis.fetch;
+type RequestOptions = Parameters<typeof globalThis.fetch>[1];
+interface HttpClient {
+    get<T>(_path: string, _init?: RequestOptions): Promise<T>;
+    post<T>(_path: string, _body?: unknown, _init?: RequestOptions): Promise<T>;
+    put<T>(_path: string, _body?: unknown, _init?: RequestOptions): Promise<T>;
+    patch<T>(_path: string, _body?: unknown, _init?: RequestOptions): Promise<T>;
+    delete<T>(_path: string, _init?: RequestOptions): Promise<T>;
+}
+
+type VideosResource = {
+    getById(_id: string): Promise<VideoDTO>;
+};
+
+type CollectionsResource = {
+    list(): Promise<CollectionDTO[]>;
+    getById(_id: string): Promise<CollectionDTO>;
+};
+
+interface SDKConfig {
+    baseUrl?: string;
+    apiKey: string;
+    clientId: string;
+    fetch?: FetchLike;
+    timeoutMs?: number;
+}
+declare class JaaqClient {
+    readonly videos: VideosResource;
+    readonly collections: CollectionsResource;
+    private constructor();
+    /**
+     * Public "friend" constructor that remains inside the class boundary.
+     * This method is callable from the module-level build function
+     * without exposing `new JaaqClient(...)` to consumers.
+     */
+    static fromHttp(http: HttpClient): JaaqClient;
+    /**
+     * OO-friendly static initializer.
+     * Delegates to the single source of truth: `buildClient`.
+     */
+    static init(config: SDKConfig): JaaqClient;
+}
+
+/**
+ * Configuration options for video player components
+ */
+type PlayerConfig = {
+    /** Video ID to load */
+    videoId: string;
+    /** API key for authentication (required if no client provided) */
+    apiKey?: string;
+    /** Client ID for authentication (required if no client provided) */
+    clientId?: string;
+    /** Existing JaaqClient instance to use instead of creating a new one */
+    client?: JaaqClient;
+    /** Custom API base URL */
+    baseUrl?: string;
+    /** Whether to automatically start playback when video loads */
+    autoplay?: boolean;
+    /** Whether to show player controls */
+    controls?: boolean;
+    /** CSS width of the player container */
+    width?: string;
+    /** CSS height of the player container */
+    height?: string;
+    /** Additional CSS class name(s) to apply to the player */
+    className?: string;
+    /** Whether to show the JAAQ logo */
+    showLogo?: boolean;
+    /** Whether to show the video title */
+    showTitle?: boolean;
+    /** Whether to show the author name */
+    showAuthor?: boolean;
+    /** Whether to show the description */
+    showDescription?: boolean;
+    /** Whether to show captions button */
+    showCaptions?: boolean;
+};
+/**
+ * Current state of the video player
+ */
+type PlayerState = {
+    /** Whether the video is currently playing */
+    isPlaying: boolean;
+    /** Current playback time in seconds */
+    currentTime: number;
+    /** Total video duration in seconds */
+    duration: number;
+    /** Current volume level (0-1) */
+    volume: number;
+    /** Whether the audio is muted */
+    isMuted: boolean;
+    /** Whether the player is in fullscreen mode */
+    isFullscreen: boolean;
+    /** Whether the video is currently loading */
+    isLoading: boolean;
+    /** Error message if an error occurred, null otherwise */
+    error: string | null;
+    /** Loaded video data, null if not yet loaded */
+    videoData: VideoDTO | null;
+    /** Whether captions are currently enabled */
+    captionsEnabled: boolean;
+};
+
+type VideoPlayerHandle = {
+    play: () => void;
+    pause: () => void;
+    setVolume: (_volume: number) => void;
+    toggleMute: () => void;
+    seek: (_time: number) => void;
+    getState: () => PlayerState | null;
+    destroy: () => void;
+};
+declare const VideoPlayer: React.ForwardRefExoticComponent<PlayerConfig & {
+    onPlay?: () => void;
+    onPause?: () => void;
+    onError?: (_error: Error) => void;
+    onLoaded?: (_video: VideoDTO) => void;
+    onTimeUpdate?: (_time: number) => void;
+    onVolumeChange?: (_volume: number) => void;
+    onEnded?: () => void;
+    onFullscreenChange?: (_isFullscreen: boolean) => void;
+    showInfo?: boolean;
+} & React.RefAttributes<VideoPlayerHandle>>;
+
+type CollectionPlayerProps = {
+    collectionId: string;
+    apiKey?: string;
+    clientId?: string;
+    subscriptionId?: string;
+    client?: JaaqClient;
+    baseUrl?: string;
+    autoplay?: boolean;
+    showArrows?: boolean;
+    showDots?: boolean;
+    className?: string;
+    onLoaded?: (_collection: CollectionDTO) => void;
+    onError?: (_error: Error) => void;
+    onSlideChange?: (_data: {
+        index: number;
+        video: CollectionDTO['videos'][0];
+    }) => void;
+};
+type CollectionPlayerHandle = {
+    refresh: () => void;
+    next: () => void;
+    prev: () => void;
+    go: (_index: number) => void;
+    destroy: () => void;
+    getCollection: () => CollectionDTO | null;
+};
+declare const CollectionPlayer: React.ForwardRefExoticComponent<CollectionPlayerProps & React.RefAttributes<CollectionPlayerHandle>>;
+
+export { CollectionPlayer, VideoPlayer };
+export type { PlayerConfig, PlayerState };