videojs-rewind 0.1.0 → 0.2.3

package/dist/plugin.d.ts

@@ -18,12 +18,16 @@ declare class RewindPlugin extends RewindPlugin_base {
     dom: PluginDomElements;
     private _tickInterval;
     private _cdns;
-    private _storyboardInfo;
+    private _storyboardEntry;
     private _spriteImages;
     private _qualitySuppressionTimer;
     private _toastTimer;
     private _keydownHandler;
     private _wasPlaying;
+    private _isDisposed;
+    private _dragListenersAttached;
+    private _vhsTech;
+    private _vhsHookEvent;
     /**
      * @param player - The video.js player instance
      * @param options - Partial plugin options (merged with defaults via Zod)
@@ -40,15 +44,12 @@ declare class RewindPlugin extends RewindPlugin_base {
     private _buildDOM;
     /** Remove all injected DOM elements. */
     private _removeDOM;
-    /**
-     * Create a DOM element with attributes and optional text content.
-     */
-    private _createEl;
-    private _responseHook;
+    private _onVhsResponse;
     private _wireVhsHooks;
     private _unwireVhsHooks;
     /**
      * Get the CDN base URL for a given playlist URI.
+     * Prefers an explicit cdnBaseUrl option, falls back to captured values.
      */
     private _getCdnBaseUrl;
     private _wireKeyboardSeek;
@@ -88,13 +89,26 @@ declare class RewindPlugin extends RewindPlugin_base {
      */
     private _startQualitySuppression;
     /**
-     * Load quality preference from localStorage.
+     * Load quality preference. A host-supplied `loadQuality` callback takes
+     * precedence over localStorage. When neither is available, falls back to
+     * in-memory state only.
      */
     private _loadQualityPreference;
     /**
-     * Save quality preference to localStorage.
+     * Save quality preference. A host-supplied `saveQuality` callback takes
+     * precedence over localStorage.
      */
     private _saveQualityPreference;
+    /**
+     * Seek to `time`, running rewind-to-VOD detection when behind the DVR window.
+     * Public so hosts (keyboard shortcuts, programmatic seeks) share the plugin's
+     * seek behavior instead of bypassing it with a raw `player.currentTime()`.
+     */
+    seek(time: number): void;
+    /**
+     * Return to the live source. Public for host keyboard shortcuts / buttons.
+     */
+    goLive(): void;
     /**
      * Set the preferred quality level.
      * @param quality - Quality height (e.g., 1080) or 'auto'
@@ -105,7 +119,8 @@ declare class RewindPlugin extends RewindPlugin_base {
      */
     getQuality(): number | 'auto';
     /**
-     * Fetch storyboard metadata for a VOD and preload sprite images.
+     * Fetch storyboard metadata for a VOD, validate it, select the preferred
+     * entry, and preload sprite images.
      */
     private _fetchStoryboardInfo;
     /**
@@ -125,12 +140,16 @@ declare class RewindPlugin extends RewindPlugin_base {
      */
     private _hideStoryboard;
     /**
-     * Format seconds into HH:MM:SS or MM:SS.
+     * Get the channel name from the host-supplied option.
+     * Falls back to 'unknown' when not provided.
      */
-    _formatTime(seconds: number): string;
+    private _getChannelName;
     /**
-     * Extract channel name from the current source URL.
+     * Best-effort live stream total elapsed seconds (how far into the broadcast
+     * the live edge is). Passed to `resolveVodUrl` so the host can pick the VOD
+     * matching the current broadcast without re-deriving it. Returns 0 when not
+     * on a live source or when the live tracker is unavailable.
      */
-    private _getChannelName;
+    private _getLiveTotalElapsed;
 }
 export default RewindPlugin;

package/dist/schema.d.ts

@@ -5,15 +5,55 @@
  * Provides runtime validation of plugin options with descriptive error messages.
  */
 import { z } from 'zod';
+/** A single storyboard sprite sheet descriptor. */
+export declare const StoryboardEntrySchema: z.ZodObject<{
+    width: z.ZodNumber;
+    height: z.ZodNumber;
+    cols: z.ZodNumber;
+    rows: z.ZodNumber;
+    interval: z.ZodNumber;
+    count: z.ZodDefault<z.ZodNumber>;
+    images: z.ZodArray<z.ZodString>;
+    quality: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+/** Storyboard info may be a single entry or an array of entries. */
+export declare const StoryboardInfoSchema: z.ZodUnion<readonly [z.ZodObject<{
+    width: z.ZodNumber;
+    height: z.ZodNumber;
+    cols: z.ZodNumber;
+    rows: z.ZodNumber;
+    interval: z.ZodNumber;
+    count: z.ZodDefault<z.ZodNumber>;
+    images: z.ZodArray<z.ZodString>;
+    quality: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>, z.ZodArray<z.ZodObject<{
+    width: z.ZodNumber;
+    height: z.ZodNumber;
+    cols: z.ZodNumber;
+    rows: z.ZodNumber;
+    interval: z.ZodNumber;
+    count: z.ZodDefault<z.ZodNumber>;
+    images: z.ZodArray<z.ZodString>;
+    quality: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>>]>;
 /** Full plugin options schema */
 export declare const RewindPluginOptionsSchema: z.ZodObject<{
     customSeekBar: z.ZodDefault<z.ZodBoolean>;
     showTotalTime: z.ZodDefault<z.ZodBoolean>;
     enableRewindToVod: z.ZodDefault<z.ZodBoolean>;
-    resolveVodUrl: z.ZodDefault<z.ZodNullable<z.ZodCustom<(channelName: string, seekTime: number) => Promise<{
+    channelName: z.ZodOptional<z.ZodString>;
+    liveUrl: z.ZodOptional<z.ZodString>;
+    cdnBaseUrl: z.ZodOptional<z.ZodString>;
+    resolveVodUrl: z.ZodDefault<z.ZodNullable<z.ZodCustom<(channelName: string, seekTime: number, context?: {
+        currentVodId?: string;
+        liveTotalElapsed?: number;
+    }) => Promise<{
         vodId: string;
         hlsUrl: string;
-    } | null>, (channelName: string, seekTime: number) => Promise<{
+    } | null>, (channelName: string, seekTime: number, context?: {
+        currentVodId?: string;
+        liveTotalElapsed?: number;
+    }) => Promise<{
         vodId: string;
         hlsUrl: string;
     } | null>>>>;
@@ -21,13 +61,19 @@ export declare const RewindPluginOptionsSchema: z.ZodObject<{
     preferredQuality: z.ZodDefault<z.ZodUnion<readonly [z.ZodNumber, z.ZodLiteral<"auto">]>>;
     persistQuality: z.ZodDefault<z.ZodBoolean>;
     storageKeyPrefix: z.ZodDefault<z.ZodString>;
+    loadQuality: z.ZodDefault<z.ZodNullable<z.ZodCustom<() => number | 'auto' | null, () => number | 'auto' | null>>>;
+    saveQuality: z.ZodDefault<z.ZodNullable<z.ZodCustom<(quality: number | 'auto') => void, (quality: number | 'auto') => void>>>;
     storyboard: z.ZodOptional<z.ZodObject<{
-        fetchInfo: z.ZodOptional<z.ZodCustom<(vodId: string, cdnBaseUrl: string) => Promise<Record<string, unknown> | null>, (vodId: string, cdnBaseUrl: string) => Promise<Record<string, unknown> | null>>>;
+        fetchInfo: z.ZodDefault<z.ZodNullable<z.ZodCustom<(vodId: string, cdnBaseUrl: string) => Promise<unknown>, (vodId: string, cdnBaseUrl: string) => Promise<unknown>>>>;
+        resolveImageUrl: z.ZodDefault<z.ZodNullable<z.ZodCustom<(imageRef: string, entry: z.infer<typeof StoryboardEntrySchema>, cdnBaseUrl: string) => string, (imageRef: string, entry: z.infer<typeof StoryboardEntrySchema>, cdnBaseUrl: string) => string>>>;
+        preferredQuality: z.ZodOptional<z.ZodString>;
         previewWidth: z.ZodDefault<z.ZodNumber>;
         previewHeight: z.ZodDefault<z.ZodNumber>;
     }, z.core.$strict>>;
     dvrWindowThreshold: z.ZodDefault<z.ZodNumber>;
     showToasts: z.ZodDefault<z.ZodBoolean>;
+    enableKeyboardSeek: z.ZodDefault<z.ZodBoolean>;
+    keyboardSeekStep: z.ZodDefault<z.ZodNumber>;
 }, z.core.$strict>;
 /** Type for the resolved options after schema parsing */
 export type ResolvedRewindPluginOptions = z.output<typeof RewindPluginOptionsSchema>;

package/dist/types.d.ts

@@ -2,19 +2,13 @@
  * Type definitions for videojs-rewind.
  */
 import type { z } from 'zod';
-import type { RewindPluginOptionsSchema } from './schema.js';
+import type { RewindPluginOptionsSchema, StoryboardInfoSchema, StoryboardEntrySchema } from './schema.js';
 /** Inferred plugin options type from the Zod schema */
 export type RewindPluginOptions = z.infer<typeof RewindPluginOptionsSchema>;
-/** Storyboard sprite sheet metadata */
-export interface StoryboardInfo {
-    width: number;
-    height: number;
-    cols: number;
-    rows: number;
-    interval: number;
-    count: number;
-    images: string[];
-}
+/** A single storyboard sprite sheet descriptor (validated at runtime by Zod). */
+export type StoryboardEntry = z.infer<typeof StoryboardEntrySchema>;
+/** Storyboard info: a single entry or an array of entries (validated at runtime). */
+export type StoryboardInfo = z.infer<typeof StoryboardInfoSchema>;
 /** Resolved VOD result from the resolveVodUrl callback */
 export interface VodResult {
     vodId: string;

package/dist/utils.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Shared utility functions for videojs-rewind.
+ */
+/**
+ * Format seconds into HH:MM:SS or MM:SS.
+ *
+ * Returns '0:00' for non-finite or negative values.
+ */
+export declare function formatTime(seconds: number): string;

package/dist/videojs-rewind.css

@@ -142,6 +142,12 @@
   display: none;
 }
 
+/* Disable slider/handle transitions during scrubbing for instant feedback */
+.vjs-rewind-active.vjs-scrubbing .vjs-rewind-slider,
+.vjs-rewind-active.vjs-scrubbing .vjs-rewind-handle {
+  transition: none;
+}
+
 /* ---------------------------------------------------------------------------
    Responsive: Hide timer on small players
    --------------------------------------------------------------------------- */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "videojs-rewind",
-  "version": "0.1.0",
+  "version": "0.2.3",
   "type": "module",
   "description": "Full-stream seek bar, rewind-to-VOD, and quality enforcement for live DVR playback in video.js",
   "exports": {