@vplayer/core 0.1.0

package/dist/types.d.ts

@@ -0,0 +1,178 @@
+import type { Store } from '@tanstack/store';
+import type { EventBus } from './event-bus';
+import type { HotkeyRegistry } from './hotkey-registry';
+import type { I18n } from './i18n';
+import type { MediaCapabilitiesSnapshot } from './media-capabilities';
+import type { DashMediaEngineOptions, HlsMediaEngineOptions, MediaEngine } from './media-engine';
+import type { PlayerPlugin } from './plugin-api';
+import type { AspectRatioState, FlipState } from './plugin-api';
+import type { PlayerSource } from './source-resolver';
+import type { PlaybackStatus } from './state/slices';
+import type { MediaState } from './state/slices';
+import type { Storage } from './storage';
+import type { SubtitleTrack } from './subtitle-parser';
+export type { MediaState };
+/** Iconify icon identifier, e.g. "lucide:play" or "mdi:play" */
+export type SvgIcon = string;
+export interface PlayerIcons {
+    play: SvgIcon;
+    pause: SvgIcon;
+    replay: SvgIcon;
+    skipBack: SvgIcon;
+    skipForward: SvgIcon;
+    volumeHigh: SvgIcon;
+    volumeLow: SvgIcon;
+    volumeOff: SvgIcon;
+    settings: SvgIcon;
+    pip: SvgIcon;
+    miniPlayer: SvgIcon;
+    close: SvgIcon;
+    fullscreen: SvgIcon;
+    fullscreenExit: SvgIcon;
+    chevronLeft: SvgIcon;
+    check: SvgIcon;
+    spinner: SvgIcon;
+    screenshot: SvgIcon;
+    flip: SvgIcon;
+    aspectRatio: SvgIcon;
+    info: SvgIcon;
+    loop: SvgIcon;
+}
+export interface PlayerOptions {
+    src: string;
+    /** MIME/content type hint used by source provider selection. */
+    type?: string;
+    poster?: string;
+    subtitles?: SubtitleTrack[];
+    qualities?: string[];
+    autoPlay?: boolean;
+    thumbnails?: string;
+    lang?: string;
+    translations?: Record<string, string>;
+    plugins?: PlayerPlugin[];
+    persistPreferences?: boolean;
+    defaultHotkeys?: boolean;
+    reconnectMax?: number;
+    reconnectSleep?: number;
+    /** Optional hls.js config passed when an .m3u8 source needs Media Source Extensions. */
+    hlsConfig?: HlsMediaEngineOptions['hlsConfig'];
+    /** Optional dash.js config passed when an .mpd source is used. */
+    dashConfig?: DashMediaEngineOptions['dashConfig'];
+    onTimeUpdate?: (time: number) => void;
+    onEnded?: () => void;
+    onError?: (message: string) => void;
+    /**
+     * Custom media engine or factory.
+     *
+     * - `MediaEngine` instance — used directly (must already be bound to a
+     *   `<video>` element).
+     * - `(video: HTMLVideoElement) => MediaEngine` — factory called at mount
+     *   time with the player's `<video>` element.
+     *
+     * When omitted, a NativeVideoEngine is created automatically.
+     *
+     * @example
+     * ```ts
+     * // HLS via factory (recommended)
+     * createPlayer({
+     *   engine: (video) => new HlsMediaEngine(video, { src: '...' }),
+     * })
+     *
+     * // Pre-configured instance
+     * createPlayer({
+     *   engine: new HlsMediaEngine(videoEl, { src: '...' }),
+     * })
+     * ```
+     */
+    engine?: MediaEngine | ((video: HTMLVideoElement) => MediaEngine);
+}
+export type { PlaybackStatus };
+export type { MediaCapabilitiesSnapshot, PlayerSource };
+export interface PlayerError {
+    message: string;
+    reconnectAttempt: number;
+    isReconnecting: boolean;
+}
+export interface MediaRemote {
+    play: () => void;
+    pause: () => void;
+    togglePlay: () => void;
+    seek: (time: number) => void;
+    skip: (seconds: number) => void;
+    setVolume: (v: number) => void;
+    toggleMute: () => void;
+    setPlaybackRate: (rate: number) => void;
+    toggleFullscreen: () => void;
+    togglePiP: () => void;
+    setActiveSubtitle: (track: SubtitleTrack | null) => void;
+    setActiveQuality: (q: string) => void;
+    takeScreenshot: () => void;
+    setFlip: (flip: FlipState) => void;
+    setAspectRatio: (ratio: AspectRatioState) => void;
+    cycleAspectRatio: () => void;
+    toggleLoop: () => void;
+    toggleInfoPanel: () => void;
+}
+export interface PlayerLabels {
+    play: string;
+    pause: string;
+    replay: string;
+    mute: string;
+    unmute: string;
+    settings: string;
+    pip: string;
+    pipExit: string;
+    miniPlayer: string;
+    exitMiniPlayer: string;
+    fullscreen: string;
+    fullscreenExit: string;
+    speed: string;
+    quality: string;
+    subtitles: string;
+    off: string;
+    endedTitle: string;
+    screenshot: string;
+    flip: string;
+    flipNormal: string;
+    flipHorizontal: string;
+    flipVertical: string;
+    aspectRatio: string;
+    aspectRatioDefault: string;
+    aspectRatio16: string;
+    aspectRatio4: string;
+    aspectRatioFill: string;
+    aspectRatioCover: string;
+    aspectRatio21: string;
+    continue: string;
+    continuePlay: string;
+    continueStartOver: string;
+    error: string;
+    retry: string;
+    contextMenuPlay: string;
+    contextMenuPause: string;
+    contextMenuLoop: string;
+    infoPanel: string;
+    loop: string;
+}
+export interface PlayerSystems {
+    events: EventBus;
+    storage: Storage;
+    i18n: I18n;
+    hotkeys: HotkeyRegistry;
+}
+export interface PlayerInstance {
+    store: Store<MediaState>;
+    remote: MediaRemote;
+    events: EventBus;
+    storage: Storage;
+    i18n: I18n;
+    hotkeys: HotkeyRegistry;
+    /** The active media engine. Null before mount and after unmount. */
+    engine: MediaEngine | null;
+    updateOptions(opts: Partial<Pick<PlayerOptions, 'src' | 'type' | 'poster' | 'autoPlay' | 'subtitles' | 'qualities' | 'thumbnails'>>): void;
+    setThumbnails(url?: string): void;
+    initPlugins(plugins: PlayerPlugin[]): () => void;
+    mount(videoEl: HTMLVideoElement, containerEl: HTMLDivElement): void;
+    unmount(): void;
+    destroy(): void;
+}

package/dist/utils.d.ts

@@ -0,0 +1 @@
+export declare function formatTime(seconds: number): string;

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@vplayer/core",
+  "version": "0.1.0",
+  "private": false,
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/divyam234/vplayer.git",
+    "directory": "packages/core"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "scripts": {
+    "build": "vite build && tsc -p tsconfig.build.json",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage"
+  },
+  "dependencies": {
+    "@tanstack/store": "^0.8.0",
+    "dashjs": "^5.1.1",
+    "hls.js": "^1.6.16"
+  },
+  "devDependencies": {
+    "typescript": "^6.0.2",
+    "vite": "^8.0.0"
+  }
+}