@latest-thinking/lt-player 3.0.0-beta.2 → 3.0.0-beta.3

package/dist/index.d.ts

@@ -1 +1,274 @@
+declare const CONTEXT_PANEL_VIEWS: readonly ["knowledge", "underlyingPublication", "relatedVideos"];
+
+declare type ContextPanelView = (typeof CONTEXT_PANEL_VIEWS)[number];
+
+export declare function createPlayer(host: HTMLElement, config: PlayerConfig): PlayerHandle;
+
+declare const LT_PLAYBACK_STATES: readonly ["idle", "buffering", "playing", "paused", "ended", "error"];
+
+declare type LtPlaybackState = (typeof LT_PLAYBACK_STATES)[number];
+
+export declare interface PlayerCapabilities {
+    chapters?: boolean;
+    captions?: boolean;
+    speed?: boolean | PlayerSpeedOptions;
+    share?: boolean | PlayerShareOptions;
+    contextPanel?: boolean;
+}
+
+export declare interface PlayerCaptionsState {
+    enabled: boolean;
+    language?: string;
+}
+
+export declare interface PlayerChapter {
+    name: string;
+    start: number;
+}
+
+export declare interface PlayerConfig {
+    version?: 3;
+    layout: PlayerLayout;
+    language?: PlayerLanguage;
+    content: PlayerContent;
+    controls?: PlayerControls;
+    capabilities?: PlayerCapabilities;
+    strings?: PlayerStrings;
+}
+
+export declare interface PlayerContent {
+    title?: string;
+    author?: string;
+    description?: string;
+    poster?: string;
+    duration?: number;
+    sources: PlayerSource[];
+    tracks?: PlayerTrack[];
+    chapters?: PlayerChapter[];
+    metadata?: PlayerMetadata;
+}
+
+export declare interface PlayerControls {
+    cover?: boolean | PlayerCoverOptions;
+    playPause?: PlayerControlSwitch;
+    timeline?: boolean | PlayerTimelineOptions;
+    time?: PlayerControlSwitch;
+    volume?: PlayerControlSwitch;
+    fullscreen?: PlayerControlSwitch;
+    pip?: PlayerControlSwitch;
+    buffering?: PlayerControlSwitch;
+    inputFeedback?: PlayerControlSwitch;
+    logo?: PlayerControlSwitch;
+    gestures?: PlayerControlSwitch;
+    hotkeys?: PlayerControlSwitch;
+}
+
+export declare type PlayerControlSwitch = boolean | PlayerEmptyOptions;
+
+export declare interface PlayerCoverButtonOptions {
+    label?: string;
+}
+
+export declare interface PlayerCoverOptions {
+    image?: boolean;
+    title?: boolean;
+    author?: boolean;
+    button?: boolean | PlayerCoverButtonOptions;
+}
+
+export declare type PlayerEmptyOptions = Record<string, never>;
+
+declare interface PlayerEventBase {
+    currentTime: number;
+}
+
+export declare type PlayerEventHandler<Event extends PlayerEventName> = (payload: PlayerEventMap[Event]) => void;
+
+export declare interface PlayerEventMap {
+    ready: PlayerEventBase & {
+        duration: number;
+    };
+    play: PlayerEventBase;
+    pause: PlayerEventBase;
+    ended: PlayerEventBase;
+    seeked: PlayerEventBase;
+    buffering: PlayerEventBase & {
+        buffering: boolean;
+    };
+    error: PlayerEventBase & {
+        kind: 'configuration' | 'startup' | 'mid-playback';
+    };
+    timeUpdate: PlayerEventBase;
+    chapterChange: PlayerEventBase & {
+        chapter: PlayerChapter | null;
+    };
+    volumeChange: PlayerEventBase & {
+        volume: number;
+        muted: boolean;
+    };
+    rateChange: PlayerEventBase & {
+        rate: number;
+    };
+    captionsChange: PlayerEventBase & {
+        captions: PlayerCaptionsState;
+    };
+    pipChange: PlayerEventBase & {
+        pip: boolean;
+    };
+    shareOpen: PlayerEventBase & {
+        source: 'player' | 'page';
+    };
+    panelOpen: PlayerEventBase & {
+        view: PlayerPanelView;
+    };
+    panelClose: PlayerEventBase;
+    videoChange: PlayerEventBase;
+}
+
+export declare type PlayerEventName = keyof PlayerEventMap;
+
+export declare type PlayerEventUnsubscribe = () => void;
+
+export declare interface PlayerHandle {
+    update(config: PlayerConfig): void;
+    destroy(): void;
+    getState(): PlayerStateSnapshot;
+    play(): void;
+    pause(): void;
+    seek(seconds: number): void;
+    setVolume(volume: number): void;
+    setMuted(muted: boolean): void;
+    setRate(rate: number): void;
+    setCaptions(captions: PlayerCaptionsState): void;
+    openShare(): void;
+    openPanel(view: PlayerPanelView): void;
+    closePanel(): void;
+    on<Event extends PlayerEventName>(event: Event, handler: PlayerEventHandler<Event>): PlayerEventUnsubscribe;
+}
+
+export declare interface PlayerInANutshellMetadata {
+    generatedByAi?: boolean;
+    keyTakeaway?: string;
+    summary?: string;
+}
+
+export declare interface PlayerKeyConcept {
+    label: string;
+    description: string;
+    start?: number;
+}
+
+export declare interface PlayerKeyConceptsMetadata {
+    generatedByAi?: boolean;
+    items?: PlayerKeyConcept[];
+}
+
+export declare type PlayerLanguage = string | string[];
+
+export declare type PlayerLayout = 'landscape' | 'portrait';
+
+export declare interface PlayerMetadata {
+    inANutshell?: PlayerInANutshellMetadata;
+    keyConcepts?: PlayerKeyConceptsMetadata;
+    researchField?: PlayerResearchFieldMetadata;
+    transcript?: PlayerTranscriptMetadata;
+    underlyingPublication?: PlayerUnderlyingPublicationMetadata;
+    relatedVideos?: PlayerRelatedVideosMetadata;
+}
+
+export declare type PlayerPanelView = ContextPanelView;
+
+export declare interface PlayerPublication {
+    title: string;
+    authors: string[];
+    journal: string;
+    abstract: string;
+    url: string;
+}
+
+export declare interface PlayerRelatedVideo {
+    title: string;
+    poster: string;
+    url: string;
+}
+
+export declare interface PlayerRelatedVideosMetadata {
+    generatedByAi?: boolean;
+    related?: PlayerRelatedVideo[];
+    forYou?: PlayerRelatedVideo[];
+}
+
+export declare interface PlayerResearchFieldMetadata {
+    generatedByAi?: boolean;
+    sections?: PlayerResearchFieldSection[];
+}
+
+export declare interface PlayerResearchFieldSection {
+    title: string;
+    description: string;
+}
+
+export declare interface PlayerShareOptions {
+    canonicalUrl?: string;
+    embedUrl?: string;
+    targets?: PlayerShareTarget[];
+    templates?: PlayerShareTemplates;
+}
+
+export declare type PlayerShareTarget = 'link' | 'embed' | 'facebook' | 'x' | 'linkedin' | 'whatsapp' | 'more';
+
+export declare interface PlayerShareTemplates {
+    message?: string;
+}
+
+export declare interface PlayerSource {
+    src: string;
+    type?: string;
+}
+
+export declare interface PlayerSpeedOptions {
+    options?: number[];
+}
+
+export declare interface PlayerStateSnapshot {
+    playback: LtPlaybackState;
+    currentTime: number;
+    duration: number;
+    volume: number;
+    muted: boolean;
+    rate: number;
+    captions: PlayerCaptionsState;
+    pip: boolean;
+    layout: PlayerLayout;
+}
+
+export declare type PlayerStrings = Record<string, string>;
+
+export declare interface PlayerTimelineOptions {
+    seekStep?: number;
+}
+
+export declare interface PlayerTrack {
+    src: string;
+    kind?: string;
+    label?: string;
+    srclang?: string;
+    default?: boolean;
+}
+
+export declare interface PlayerTranscriptEntry {
+    start: number;
+    text: string;
+}
+
+export declare interface PlayerTranscriptMetadata {
+    generatedByAi?: boolean;
+    entries?: PlayerTranscriptEntry[];
+}
+
+export declare interface PlayerUnderlyingPublicationMetadata {
+    generatedByAi?: boolean;
+    items?: PlayerPublication[];
+}
+
 export { }