@atlaskit/media-card 80.8.13 → 81.0.0

package/dist/types-ts4.5/utils/ufoExperiences.d.ts

@@ -1,98 +0,0 @@
-import { type CardStatus } from '../types';
-import { type FileAttributes } from '@atlaskit/media-common';
-import { type MediaCardErrorInfo, type SSRStatus } from './analytics';
-import { MediaCardError } from '../errors';
-import { type RequestMetadata } from '@atlaskit/media-client';
-import { type FileStateFlags } from '../types';
-/**
- * Determines if performance events should be sampled for this instance.
- * Approximately 5% of instances will be sampled.
- */
-export declare const shouldPerformanceBeSampled: () => boolean;
-export type SSRPreviewInfo = {
-    /** The srcset of the SSR preview (used to match performance entries) */
-    srcset?: string;
-    /** The full URI of the SSR preview (used to match performance entries) */
-    dataUri?: string;
-    /** Whether SSR was attempted (ssr prop was provided) */
-    wasSSRAttempted: boolean;
-    /** Whether SSR was successful (server or client status is 'success') */
-    wasSSRSuccessful: boolean;
-};
-type SucceedUfoPayload = {
-    fileAttributes: FileAttributes;
-    ssrReliability: SSRStatus;
-    fileStateFlags: FileStateFlags;
-};
-type FailedProcessingPayload = {
-    fileAttributes: FileAttributes;
-    ssrReliability: SSRStatus;
-    failReason: 'failed-processing';
-    fileStateFlags: FileStateFlags;
-};
-type ErrorUfoPayload = {
-    fileAttributes: FileAttributes;
-    ssrReliability: SSRStatus;
-    request: RequestMetadata | undefined;
-    fileStateFlags: FileStateFlags;
-} & MediaCardErrorInfo;
-export interface UseMediaCardUfoExperienceOptions {
-    /** Unique identifier for this experience instance */
-    instanceId: string;
-    /** Whether to enable UFO tracking for this instance */
-    enabled: boolean;
-}
-export interface StartOptions {
-    /**
-     * When true, uses the UFO interaction start time instead of current time.
-     * Use this for SSR non-lazy scenarios where the image loading started at interaction start.
-     */
-    useInteractionTime?: boolean;
-}
-export interface MediaCardUfoExperience {
-    /**
-     * Start the UFO experience. Call when card becomes visible.
-     * @param options - Optional configuration for start behavior
-     */
-    start: (options?: StartOptions) => void;
-    /**
-     * Complete the UFO experience with appropriate timing strategy.
-     * @param status - The final card status
-     * @param fileAttributes - File metadata
-     * @param fileStateFlags - File state flags
-     * @param ssrReliability - SSR reliability status
-     * @param error - Optional error for error status
-     * @param ssrPreviewInfo - SSR preview information for timing lookup
-     */
-    complete: (status: CardStatus, fileAttributes: FileAttributes, fileStateFlags: FileStateFlags, ssrReliability: SSRStatus, error?: MediaCardError, ssrPreviewInfo?: SSRPreviewInfo) => void;
-    /** Abort the UFO experience. Call on unmount if not completed. */
-    abort: (properties?: Partial<SucceedUfoPayload>) => void;
-}
-/**
- * Hook to create a UFO experience tied to a media card component lifecycle.
- *
- * This creates a unique UFOExperience instance per component, allowing:
- * - Unique timing config per instance
- * - Direct control over experience lifecycle
- * - Proper cleanup on unmount
- *
- * @example
- * ```tsx
- * const ufoExperience = useMediaCardUfoExperience({
- *   instanceId: internalOccurrenceKey,
- *   enabled: shouldSendPerformanceEvent,
- * });
- *
- * // On card visible
- * ufoExperience.start();
- *
- * // On card complete/error
- * ufoExperience.complete(status, fileAttributes, fileStateFlags, ssrReliability, error, ssrPreviewInfo);
- * ```
- */
-export declare const useMediaCardUfoExperience: ({ instanceId, enabled, }: UseMediaCardUfoExperienceOptions) => MediaCardUfoExperience;
-export declare const startUfoExperience: (id: string, startTime?: number) => void;
-export declare const completeUfoExperience: (id: string, status: CardStatus, fileAttributes: FileAttributes, fileStateFlags: FileStateFlags, ssrReliability: SSRStatus, error?: MediaCardError, ssrPreviewInfo?: SSRPreviewInfo) => void;
-export declare const abortUfoExperience: (id: string, properties?: Partial<SucceedUfoPayload>) => void;
-export type { FailedProcessingPayload as _FailedProcessingPayload };
-export type { ErrorUfoPayload as _ErrorUfoPayload };

package/dist/types-ts4.5/utils/useCurrentValueRef.d.ts

@@ -1,2 +0,0 @@
-import { type MutableRefObject } from 'react';
-export declare function useCurrentValueRef<T>(value: T): MutableRefObject<T>;

package/dist/types-ts4.5/utils/usePrevious.d.ts

@@ -1 +0,0 @@
-export declare function usePrevious<T>(value: T | undefined): T | undefined;

package/dist/types-ts4.5/utils/videoIsPlayable.d.ts

@@ -1,2 +0,0 @@
-import { type FileState } from '@atlaskit/media-client';
-export declare const videoIsPlayable: (isBannedLocalPreview: boolean, fileState?: FileState, mimeType?: string) => boolean;

package/dist/types-ts4.5/utils/videoSnapshot.d.ts

@@ -1 +0,0 @@
-export declare const takeSnapshot: (blob: Blob) => Promise<string>;

package/dist/types-ts4.5/utils/viewportDetector.d.ts

@@ -1,6 +0,0 @@
-import React, { type PropsWithChildren } from 'react';
-export type ViewportDetectorProps = PropsWithChildren<{
-    cardEl: HTMLElement | null;
-    onVisible: () => void;
-}>;
-export declare const ViewportDetector: ({ cardEl, onVisible, children, }: ViewportDetectorProps) => React.JSX.Element;