@djangocfg/ui-tools 2.1.404 → 2.1.408

package/src/tools/VideoPlayer/canvas/jsx-augmentation.ts

@@ -0,0 +1,47 @@
+/**
+ * JSX intrinsic-element declarations for the custom-element wrappers
+ * shipped by `youtube-video-element`, `vimeo-video-element`,
+ * `hls-video-element`.
+ *
+ * This is a real module (not an ambient `.d.ts`) so that it is reliably
+ * pulled into the type graph when imported as a side effect. Ambient
+ * `.d.ts` files are only loaded when they fall inside a project's
+ * `include` — consumers (e.g. the Storybook tsconfig) only `include`
+ * their own `stories/`, so a bare `.d.ts` here was silently skipped.
+ *
+ * media-chrome relies on `slot="media"` to attach a media element to
+ * its `<MediaController>`. We declare the bare prop surface we use:
+ * `src`, `slot`, `autoplay`, `muted`, `loop`, `playsinline`,
+ * `crossorigin`, `preload`, `poster`. All three elements are
+ * `HTMLElement` subclasses with `HTMLVideoElement`-shaped APIs, so
+ * their JSX props are typed as a partial of `VideoHTMLAttributes`.
+ */
+
+import type { DetailedHTMLProps, HTMLAttributes, VideoHTMLAttributes } from 'react';
+
+type VideoLikeElement = DetailedHTMLProps<
+  VideoHTMLAttributes<HTMLElement> & HTMLAttributes<HTMLElement>,
+  HTMLElement
+>;
+
+/**
+ * `youtube-video-element` accepts a `config` property — an object merged
+ * into the YouTube IFrame `playerVars` (JSON-serialized into a
+ * `data-config` attribute internally). Used to suppress native chrome.
+ */
+type YouTubeVideoElement = VideoLikeElement & {
+  config?: Record<string, string | number | boolean>;
+};
+
+declare module 'react' {
+  // eslint-disable-next-line @typescript-eslint/no-namespace
+  namespace JSX {
+    interface IntrinsicElements {
+      'youtube-video': YouTubeVideoElement;
+      'vimeo-video': VideoLikeElement;
+      'hls-video': VideoLikeElement;
+    }
+  }
+}
+
+export {};

package/src/tools/VideoPlayer/canvas/native-canvas.tsx

@@ -0,0 +1,38 @@
+'use client';
+
+/**
+ * Native `<video slot="media">` for direct MP4 / WebM / blob / data URLs.
+ */
+
+import { MediaPosterImage } from 'media-chrome/react';
+import type { UrlSource, VideoPlayerSettings } from '../types';
+
+export interface NativeCanvasProps extends VideoPlayerSettings {
+  readonly source: UrlSource;
+}
+
+export function NativeCanvas({
+  source,
+  autoPlay,
+  muted,
+  loop,
+  playsInline = true,
+  crossOrigin = 'anonymous',
+  preload = 'metadata',
+}: NativeCanvasProps) {
+  return (
+    <>
+      <video
+        slot="media"
+        src={source.url}
+        muted={muted}
+        loop={loop}
+        autoPlay={autoPlay}
+        playsInline={playsInline}
+        crossOrigin={crossOrigin}
+        preload={preload}
+      />
+      {source.poster && <MediaPosterImage slot="poster" src={source.poster} />}
+    </>
+  );
+}

package/src/tools/VideoPlayer/canvas/vimeo-canvas.tsx

@@ -0,0 +1,40 @@
+'use client';
+
+/**
+ * `<vimeo-video slot="media">` — Vimeo Player API wrapper as a custom
+ * element via `vimeo-video-element`. Same media-chrome integration story
+ * as the YouTube canvas.
+ */
+
+import 'vimeo-video-element';
+import './jsx-augmentation';
+import { MediaPosterImage } from 'media-chrome/react';
+import type { VimeoSource, VideoPlayerSettings } from '../types';
+
+export interface VimeoCanvasProps extends VideoPlayerSettings {
+  readonly source: VimeoSource;
+}
+
+export function VimeoCanvas({
+  source,
+  autoPlay,
+  muted,
+  loop,
+}: VimeoCanvasProps) {
+  const base = `https://vimeo.com/${source.videoId}`;
+  const src = source.startTime ? `${base}#t=${source.startTime}s` : base;
+
+  return (
+    <>
+      <vimeo-video
+        slot="media"
+        src={src}
+        {...(muted && { muted: true })}
+        {...(autoPlay && { autoplay: true })}
+        {...(loop && { loop: true })}
+        playsInline
+      />
+      {source.poster && <MediaPosterImage slot="poster" src={source.poster} />}
+    </>
+  );
+}

package/src/tools/VideoPlayer/canvas/youtube-canvas.tsx

@@ -0,0 +1,78 @@
+'use client';
+
+/**
+ * `<youtube-video slot="media">` — registers the custom element via
+ * `youtube-video-element` side-effect import. The element wraps the
+ * YouTube IFrame API and exposes an `HTMLVideoElement`-shaped surface
+ * that media-chrome's `<MediaController>` drives.
+ *
+ * `youtube-video-element` already defaults the embed to `controls=0`,
+ * `rel=0`, `iv_load_policy=3`, `modestbranding=1`. We extend that via
+ * the `config` prop (serialized into `data-config`, merged into the
+ * IFrame `playerVars`) to also suppress YouTube's keyboard handling
+ * (`disablekb=1` — our controls own keyboard) and the in-player
+ * close-captions toggle the element turns on by default.
+ *
+ * NOTE: YouTube's ToS forbids fully hiding its branding — a small logo
+ * and the pause-screen overlay remain by design. `modestbranding=1` is
+ * the maximum allowed suppression.
+ */
+
+import 'youtube-video-element';
+import './jsx-augmentation';
+import { MediaPosterImage } from 'media-chrome/react';
+import type { YouTubeSource, VideoPlayerSettings } from '../types';
+
+export interface YouTubeCanvasProps extends VideoPlayerSettings {
+  readonly source: YouTubeSource;
+}
+
+/**
+ * Extra YouTube IFrame `playerVars` merged on top of the element
+ * defaults. Keep keys YouTube-documented:
+ * https://developers.google.com/youtube/player_parameters
+ */
+const YT_PLAYER_VARS = {
+  // We render our own media-chrome control bar — hide YouTube's.
+  controls: 0,
+  // Our keyboard shortcuts own the player; disable YouTube's.
+  disablekb: 1,
+  // Minimise the YouTube logo chrome (max suppression allowed by ToS).
+  modestbranding: 1,
+  // Do not surface "More videos" / related-channel end-screen suggestions.
+  rel: 0,
+  // Hide video annotations.
+  iv_load_policy: 3,
+  // Keep playback inline on iOS instead of forcing native fullscreen.
+  playsinline: 1,
+  // Don't auto-load closed captions.
+  cc_load_policy: 0,
+} as const;
+
+export function YouTubeCanvas({
+  source,
+  autoPlay,
+  muted,
+  loop,
+}: YouTubeCanvasProps) {
+  const params = new URLSearchParams();
+  params.set('v', source.videoId);
+  if (source.startTime) params.set('t', `${source.startTime}s`);
+  if (source.playlistId) params.set('list', source.playlistId);
+  const src = `https://www.youtube.com/watch?${params.toString()}`;
+
+  return (
+    <>
+      <youtube-video
+        slot="media"
+        src={src}
+        config={YT_PLAYER_VARS}
+        {...(muted && { muted: true })}
+        {...(autoPlay && { autoplay: true })}
+        {...(loop && { loop: true })}
+        playsInline
+      />
+      {source.poster && <MediaPosterImage slot="poster" src={source.poster} />}
+    </>
+  );
+}

package/src/tools/VideoPlayer/index.ts

@@ -1,77 +1,63 @@
 /**
- * VideoPlayer - Unified Video Player
- * Supports Vidstack (YouTube, Vimeo, HLS, DASH), Native HTML5, and HTTP Streaming
+ * VideoPlayer — full public surface.
+ *
+ * Prefer importing through the subpath entry:
+ *   `import { VideoPlayer } from '@djangocfg/ui-tools/video-player'`
+ *
+ * which routes through `lazy.tsx`. This `index.ts` is the underlying barrel.
  */
 
-// Main component
-export { VideoPlayer } from './components';
+export { VideoPlayer } from './VideoPlayer';
 
-// Controls (can be used standalone with Vidstack)
-export { VideoControls } from './components';
-
-// Error Fallback
-export {
-  VideoErrorFallback,
-  createVideoErrorFallback,
-} from './components';
 export type {
-  VideoErrorFallbackProps,
-  CreateVideoErrorFallbackOptions,
-} from './components';
+  VideoPlayerProps,
+  VideoPlayerSettings,
+  VideoSource,
+  UrlSource,
+  YouTubeSource,
+  VimeoSource,
+  HlsSource,
+  IframeSource,
+  AspectRatioValue,
+} from './types';
 
-// Providers (for advanced usage)
-export { VidstackProvider, NativeProvider, StreamProvider } from './providers';
+export { parseEmbedUrl } from './utils/parse-embed-url';
+export { extractYouTubeId, parseYouTubeStartTime } from './utils/youtube-id';
+export { extractVimeoId } from './utils/vimeo-id';
 
-// Context (for streaming configuration)
 export {
-  VideoPlayerProvider,
-  useVideoPlayerContext,
-} from './context';
-
-// Hooks
-export { useVideoPositionCache } from './hooks';
+  CanvasDispatcher,
+  NativeCanvas,
+  YouTubeCanvas,
+  VimeoCanvas,
+  HlsCanvas,
+  IframeCanvas,
+} from './canvas';
 export type {
-  UseVideoPositionCacheOptions,
-  UseVideoPositionCacheReturn,
-} from './hooks';
+  CanvasDispatcherProps,
+  NativeCanvasProps,
+  YouTubeCanvasProps,
+  VimeoCanvasProps,
+  HlsCanvasProps,
+  IframeCanvasProps,
+} from './canvas';
 
-// Utils
 export {
-  resolvePlayerMode,
-  resolveFileSource,
-  isSimpleStreamSource,
-  resolveStreamSource,
-} from './utils';
-
-// Types
+  PlayButton,
+  SeekBar,
+  Volume,
+  Fullscreen,
+  Pip,
+  PlaybackRate,
+  ControlsBar,
+  Poster,
+} from './parts';
 export type {
-  // Source types
-  VideoSourceUnion,
-  UrlSource,
-  YouTubeSource,
-  VimeoSource,
-  HLSSource,
-  DASHSource,
-  StreamSource,
-  BlobSource,
-  DataUrlSource,
-  // Player types
-  PlayerMode,
-  AspectRatioValue,
-  VideoPlayerProps,
-  VideoPlayerRef,
-  ErrorFallbackProps,
-  // Provider props (internal)
-  VidstackProviderProps,
-  NativeProviderProps,
-  StreamProviderProps,
-  // Common types
-  CommonPlayerSettings,
-  CommonPlayerEvents,
-  // File source helper types
-  ResolveFileSourceOptions,
-  // Context types
-  VideoPlayerContextValue,
-  VideoPlayerProviderProps,
-  SimpleStreamSource,
-} from './types';
+  PlayButtonProps,
+  SeekBarProps,
+  VolumeProps,
+  FullscreenProps,
+  PipProps,
+  PlaybackRateProps,
+  ControlsBarProps,
+} from './parts';

package/src/tools/VideoPlayer/lazy.tsx

@@ -1,63 +1,20 @@
 'use client';
 
 /**
- * Lazy-loaded VideoPlayer Component
+ * Subpath entry: `@djangocfg/ui-tools/video-player`.
  *
- * Heavy Vidstack (~150KB) is loaded only when component is rendered.
- * Use this for automatic code-splitting with Suspense fallback.
+ * Built on `media-chrome` web components — the React layer is ~3 KB of
+ * thin wrappers, and provider engines (`youtube-video-element`,
+ * `vimeo-video-element`, `hls-video-element`) are imported only by the
+ * matching canvas file, so unused engines are tree-shaken.
  *
- * For direct imports without lazy loading, use:
- * import { VideoPlayer } from '@djangocfg/ui-tools/video'
+ * `LazyVideoPlayer` is preserved as a synchronous alias for back-compat
+ * with existing consumers (e.g. cmdop desktop's document-preview).
  */
 
-import { createLazyComponent, LoadingFallback } from '../../components';
-import type { VideoPlayerProps } from './types';
+export * from './index';
 
-// ============================================================================
-// Re-export types
-// ============================================================================
+import { VideoPlayer } from './VideoPlayer';
 
-export type { VideoPlayerProps };
-
-// ============================================================================
-// Video Loading Fallback
-// ============================================================================
-
-function VideoLoadingFallback() {
-  return (
-    <div className="flex items-center justify-center bg-black/90 rounded-lg aspect-video">
-      <div className="flex flex-col items-center gap-2">
-        <div className="relative">
-          <div className="h-10 w-10 animate-spin rounded-full border-4 border-white/20 border-t-white" />
-          <div className="absolute inset-0 flex items-center justify-center">
-            <svg
-              className="h-5 w-5 text-white/60"
-              fill="currentColor"
-              viewBox="0 0 24 24"
-            >
-              <path d="M8 5v14l11-7z" />
-            </svg>
-          </div>
-        </div>
-        <span className="text-sm text-white/60">Loading video player...</span>
-      </div>
-    </div>
-  );
-}
-
-// ============================================================================
-// Lazy Component
-// ============================================================================
-
-/**
- * LazyVideoPlayer - Lazy-loaded professional video player
- *
- * Automatically shows loading state while Vidstack loads (~150KB)
- */
-export const LazyVideoPlayer = createLazyComponent<VideoPlayerProps>(
-  () => import('./components').then((mod) => ({ default: mod.VideoPlayer })),
-  {
-    displayName: 'LazyVideoPlayer',
-    fallback: <VideoLoadingFallback />,
-  }
-);
+/** @deprecated Use `VideoPlayer` directly — no lazy boundary is needed. */
+export const LazyVideoPlayer = VideoPlayer;

package/src/tools/VideoPlayer/parts/controls-bar.tsx

@@ -0,0 +1,35 @@
+'use client';
+
+import { MediaControlBar } from 'media-chrome/react';
+import { cn } from '@djangocfg/ui-core/lib';
+import type { ComponentProps } from 'react';
+
+export type ControlsBarProps = ComponentProps<typeof MediaControlBar>;
+
+/**
+ * Control bar pinned to the bottom over a bottom-up black scrim so the
+ * controls stay legible on any video frame. Colours read on-black
+ * regardless of theme — the video canvas is always a black surface.
+ *
+ * The bar participates in media-chrome's `autohide`: when the
+ * `<MediaController>` adds the `mediacontrolshidden` user-inactive
+ * state, we fade the whole bar (controls + scrim) out together.
+ */
+export function ControlsBar({ className, children, ...props }: ControlsBarProps) {
+  return (
+    <MediaControlBar
+      {...props}
+      className={cn(
+        // Layout — extra top padding gives the scrim room to fade in.
+        'video-player__control-bar',
+        'absolute inset-x-0 bottom-0 flex items-center gap-1 px-2 pb-1.5 pt-8',
+        // Bottom-up scrim so controls read over any frame.
+        'bg-gradient-to-t from-black/75 via-black/40 to-transparent',
+        'text-foreground',
+        className,
+      )}
+    >
+      {children}
+    </MediaControlBar>
+  );
+}

package/src/tools/VideoPlayer/parts/fullscreen.tsx

@@ -0,0 +1,19 @@
+'use client';
+
+import { MediaFullscreenButton } from 'media-chrome/react';
+import { cn } from '@djangocfg/ui-core/lib';
+import type { ComponentProps } from 'react';
+
+export type FullscreenProps = ComponentProps<typeof MediaFullscreenButton>;
+
+export function Fullscreen({ className, ...props }: FullscreenProps) {
+  return (
+    <MediaFullscreenButton
+      {...props}
+      className={cn(
+        'media-control-square video-player__control h-8 w-8',
+        className,
+      )}
+    />
+  );
+}

package/src/tools/VideoPlayer/parts/index.ts

@@ -0,0 +1,15 @@
+export { PlayButton } from './play-button';
+export type { PlayButtonProps } from './play-button';
+export { SeekBar } from './seek-bar';
+export type { SeekBarProps } from './seek-bar';
+export { Volume } from './volume';
+export type { VolumeProps } from './volume';
+export { Fullscreen } from './fullscreen';
+export type { FullscreenProps } from './fullscreen';
+export { Pip } from './pip';
+export type { PipProps } from './pip';
+export { PlaybackRate } from './playback-rate';
+export type { PlaybackRateProps } from './playback-rate';
+export { ControlsBar } from './controls-bar';
+export type { ControlsBarProps } from './controls-bar';
+export { Poster } from './poster';

package/src/tools/VideoPlayer/parts/pip.tsx

@@ -0,0 +1,19 @@
+'use client';
+
+import { MediaPipButton } from 'media-chrome/react';
+import { cn } from '@djangocfg/ui-core/lib';
+import type { ComponentProps } from 'react';
+
+export type PipProps = ComponentProps<typeof MediaPipButton>;
+
+export function Pip({ className, ...props }: PipProps) {
+  return (
+    <MediaPipButton
+      {...props}
+      className={cn(
+        'media-control-square video-player__control h-8 w-8',
+        className,
+      )}
+    />
+  );
+}

package/src/tools/VideoPlayer/parts/play-button.tsx

@@ -0,0 +1,19 @@
+'use client';
+
+import { MediaPlayButton } from 'media-chrome/react';
+import { cn } from '@djangocfg/ui-core/lib';
+import type { ComponentProps } from 'react';
+
+export type PlayButtonProps = ComponentProps<typeof MediaPlayButton>;
+
+export function PlayButton({ className, ...props }: PlayButtonProps) {
+  return (
+    <MediaPlayButton
+      {...props}
+      className={cn(
+        'media-control-square video-player__control h-8 w-8',
+        className,
+      )}
+    />
+  );
+}

package/src/tools/VideoPlayer/parts/playback-rate.tsx

@@ -0,0 +1,31 @@
+'use client';
+
+import { MediaPlaybackRateButton } from 'media-chrome/react';
+import { cn } from '@djangocfg/ui-core/lib';
+import type { ComponentProps } from 'react';
+
+export type PlaybackRateProps = Omit<
+  ComponentProps<typeof MediaPlaybackRateButton>,
+  'rates'
+> & {
+  /** Space-separated list, e.g. `'0.5 1 1.5 2'`, or an array of numbers. */
+  readonly rates?: string | readonly number[];
+};
+
+const DEFAULT_RATES: readonly number[] = [0.5, 0.75, 1, 1.25, 1.5, 1.75, 2];
+
+export function PlaybackRate({ className, rates, ...props }: PlaybackRateProps) {
+  const value = rates ?? DEFAULT_RATES;
+  return (
+    <MediaPlaybackRateButton
+      {...props}
+      // media-chrome's setter accepts `string | ArrayLike<number>` — the
+      // React typing pulls from the getter only, which is narrower.
+      rates={value as unknown as ArrayLike<number>}
+      className={cn(
+        'video-player__control h-8 px-2 text-xs tabular-nums',
+        className,
+      )}
+    />
+  );
+}

package/src/tools/VideoPlayer/parts/poster.tsx

@@ -0,0 +1,3 @@
+'use client';
+
+export { MediaPosterImage as Poster } from 'media-chrome/react';

package/src/tools/VideoPlayer/parts/seek-bar.tsx

@@ -0,0 +1,26 @@
+'use client';
+
+import { MediaTimeRange, MediaTimeDisplay } from 'media-chrome/react';
+import { cn } from '@djangocfg/ui-core/lib';
+import type { ComponentProps } from 'react';
+
+export type SeekBarProps = ComponentProps<typeof MediaTimeRange> & {
+  readonly showTime?: boolean;
+};
+
+export function SeekBar({ className, showTime = true, ...props }: SeekBarProps) {
+  return (
+    <>
+      <MediaTimeRange
+        {...props}
+        className={cn('h-8 flex-1', className)}
+      />
+      {showTime && (
+        <MediaTimeDisplay
+          showDuration
+          className="video-player__time px-2 text-xs tabular-nums"
+        />
+      )}
+    </>
+  );
+}

package/src/tools/VideoPlayer/parts/volume.tsx

@@ -0,0 +1,32 @@
+'use client';
+
+import { MediaMuteButton, MediaVolumeRange } from 'media-chrome/react';
+import { cn } from '@djangocfg/ui-core/lib';
+import type { ComponentProps } from 'react';
+
+export interface VolumeProps {
+  readonly className?: string;
+  readonly iconOnly?: boolean;
+  readonly muteProps?: ComponentProps<typeof MediaMuteButton>;
+  readonly rangeProps?: ComponentProps<typeof MediaVolumeRange>;
+}
+
+export function Volume({ className, iconOnly, muteProps, rangeProps }: VolumeProps) {
+  return (
+    <div className={cn('flex items-center', className)}>
+      <MediaMuteButton
+        {...muteProps}
+        className={cn(
+          'media-control-square video-player__control h-8 w-8',
+          muteProps?.className,
+        )}
+      />
+      {!iconOnly && (
+        <MediaVolumeRange
+          {...rangeProps}
+          className={cn('h-8 w-20', rangeProps?.className)}
+        />
+      )}
+    </div>
+  );
+}