platform-codebase/@packages/@hooks/react-hooks/src/use-copy-to-clipboard.ts

import { useState, useCallback } from 'react';

/**
 * Return type for useCopyToClipboard hook
 */
export interface UseCopyToClipboardReturn {
  /**
   * The last copied value
   */
  copiedValue: string | null;

  /**
   * Copy a value to the clipboard
   * @param value - Value to copy
   * @returns Promise that resolves to true if successful
   */
  copy: (value: string) => Promise<boolean>;

  /**
   * Reset the copied value state
   */
  reset: () => void;
}

/**
 * Hook for copying text to clipboard
 *
 * Provides a simple API for copying text with state tracking.
 * Uses the modern Clipboard API with fallback.
 *
 * @returns Object with copy function, copied value, and reset function
 *
 * @example
 * ```typescript
 * function CopyButton({ text }: { text: string }) {
 *   const { copiedValue, copy, reset } = useCopyToClipboard();
 *
 *   const handleCopy = async () => {
 *     const success = await copy(text);
 *     if (success) {
 *       console.log('Copied!');
 *       setTimeout(reset, 2000); // Reset after 2 seconds
 *     }
 *   };
 *
 *   return (
 *     <button onClick={handleCopy}>
 *       {copiedValue === text ? 'Copied!' : 'Copy'}
 *     </button>
 *   );
 * }
 * ```
 */
export function useCopyToClipboard(): UseCopyToClipboardReturn {
  const [copiedValue, setCopiedValue] = useState<string | null>(null);

  const copy = useCallback(async (value: string): Promise<boolean> => {
    if (typeof window === 'undefined' || !navigator?.clipboard) {
      console.warn('Clipboard API not available');
      return false;
    }

    try {
      await navigator.clipboard.writeText(value);
      setCopiedValue(value);
      return true;
    } catch (error) {
      console.error('Failed to copy to clipboard:', error);
      setCopiedValue(null);
      return false;
    }
  }, []);

  const reset = useCallback(() => {
    setCopiedValue(null);
  }, []);

  return {
    copiedValue,
    copy,
    reset,
  };
}