Pular para o conteúdo principal

Tipos TypeScript

Todos os tipos exportados do Dropup.

Importar Tipos​

import type {
  DropupFile,
  DropupState,
  DropupActions,
  DropupError,
  UseDropupOptions,
  UseDropupReturn,
  FileStatus,
  DropupStatus,
  ValidationRule,
  ValidationError,
  UploadConfig,
  CustomUploader,
  UploadOptions,
  UploadResult,
} from '@samithahansaka/dropup';

Tipos Principais​

DropupFile​

Representa um arquivo na fila de upload.

interface DropupFile {
  /** Identificador único */
  id: string;

  /** Objeto File nativo do navegador */
  file: File;

  /** Nome do arquivo */
  name: string;

  /** Tamanho do arquivo em bytes */
  size: number;

  /** Tipo MIME */
  type: string;

  /** Status atual do upload */
  status: FileStatus;

  /** Progresso do upload 0-100 */
  progress: number;

  /** URL de preview para imagens (Object URL) */
  preview?: string;

  /** URL após upload bem-sucedido */
  uploadedUrl?: string;

  /** Resposta bruta do servidor */
  response?: unknown;

  /** Detalhes do erro se falhou */
  error?: DropupError;

  /** Metadados personalizados */
  meta?: Record<string, unknown>;
}

FileStatus​

Valores possíveis de status do arquivo.

type FileStatus = 'idle' | 'uploading' | 'complete' | 'error' | 'paused';

DropupState​

Estado atual da dropzone.

interface DropupState {
  /** Arquivos sendo arrastados sobre */
  isDragging: boolean;

  /** Arquivos arrastados passam na validação */
  isDragAccept: boolean;

  /** Arquivos arrastados falham na validação */
  isDragReject: boolean;

  /** Algum arquivo sendo enviado atualmente */
  isUploading: boolean;

  /** Progresso médio de todos os arquivos (0-100) */
  progress: number;

  /** Status geral */
  status: DropupStatus;
}

DropupStatus​

Status geral do upload.

type DropupStatus = 'idle' | 'uploading' | 'complete' | 'error';

DropupActions​

Ações disponíveis para controlar o uploader.

interface DropupActions {
  /** Iniciar upload de arquivos */
  upload: (fileIds?: string[]) => void;

  /** Cancelar uploads */
  cancel: (fileId?: string) => void;

  /** Remover um arquivo */
  remove: (fileId: string) => void;

  /** Remover todos os arquivos e resetar estado */
  reset: () => void;

  /** Tentar novamente uploads falhos */
  retry: (fileIds?: string[]) => void;

  /** Adicionar arquivos programaticamente */
  addFiles: (files: File[] | FileList) => void;

  /** Atualizar metadados do arquivo */
  updateFileMeta: (fileId: string, meta: Record<string, unknown>) => void;
}

DropupError​

Objeto de erro para uploads falhos.

interface DropupError {
  /** Código do erro */
  code: string;

  /** Mensagem legível */
  message: string;

  /** Erro original se disponível */
  cause?: Error;
}

Tipos de Opções​

UseDropupOptions​

Opções de configuração para o hook.

interface UseDropupOptions {
  // Validação
  accept?: string | string[];
  maxSize?: number;
  minSize?: number;
  maxFiles?: number;
  maxWidth?: number;
  maxHeight?: number;
  minWidth?: number;
  minHeight?: number;
  customRules?: ValidationRule[];

  // Comportamento
  multiple?: boolean;
  disabled?: boolean;
  autoUpload?: boolean;
  generatePreviews?: boolean;

  // Upload
  upload?: UploadConfig | CustomUploader;

  // Callbacks
  onFilesAdded?: (files: DropupFile[]) => void;
  onFileRemoved?: (file: DropupFile) => void;
  onValidationError?: (errors: ValidationError[]) => void;
  onUploadStart?: (file: DropupFile) => void;
  onUploadProgress?: (file: DropupFile, progress: number) => void;
  onUploadComplete?: (file: DropupFile, response: unknown) => void;
  onUploadError?: (file: DropupFile, error: DropupError) => void;
  onAllComplete?: (files: DropupFile[]) => void;
}

UploadConfig​

Configuração de upload baseada em URL.

interface UploadConfig {
  /** URL do endpoint de upload */
  url: string;

  /** Método HTTP */
  method?: 'POST' | 'PUT' | 'PATCH';

  /** Headers da requisição */
  headers?: Record<string, string>;

  /** Nome do campo do formulário para o arquivo */
  fieldName?: string;

  /** Incluir credenciais/cookies */
  withCredentials?: boolean;

  /** Timeout da requisição em milissegundos */
  timeout?: number;

  /** Dados adicionais do formulário */
  data?: Record<string, unknown>;
}

CustomUploader​

Tipo de função de upload personalizada.

type CustomUploader = (
  file: DropupFile,
  options: UploadOptions
) => Promise<UploadResult>;

UploadOptions​

Opções passadas para o uploader personalizado.

interface UploadOptions {
  /** Sinal de abort para cancelamento */
  signal: AbortSignal;

  /** Callback de progresso */
  onProgress: (progress: number) => void;
}

UploadResult​

Resultado retornado do upload.

interface UploadResult {
  /** URL do arquivo enviado */
  url?: string;

  /** Resposta bruta do servidor */
  response?: unknown;
}

Tipos de Validação​

ValidationRule​

Função de validação personalizada.

type ValidationRule = (file: File) =>
  | boolean
  | string
  | Promise<boolean | string>;

Valores de retorno:

  • true - Validação passou
  • false - Validação falhou (erro genérico)
  • string - Validação falhou com mensagem personalizada

ValidationError​

Erro de validação para um arquivo.

interface ValidationError {
  /** O arquivo que falhou na validação */
  file: File;

  /** Array de mensagens de erro */
  errors: string[];
}

Tipos de Retorno​

UseDropupReturn​

Tipo de retorno completo do hook.

interface UseDropupReturn {
  /** Array de arquivos */
  files: DropupFile[];

  /** Estado atual */
  state: DropupState;

  /** Ações disponíveis */
  actions: DropupActions;

  /** Getter de props para zona de drop */
  getDropProps: <E extends HTMLElement = HTMLDivElement>(
    props?: React.HTMLAttributes<E>
  ) => DropZoneProps<E>;

  /** Getter de props para elemento input */
  getInputProps: (
    props?: React.InputHTMLAttributes<HTMLInputElement>
  ) => InputProps;

  /** Abrir diálogo de arquivos programaticamente */
  openFileDialog: () => void;
}

DropZoneProps​

Props retornadas por getDropProps.

interface DropZoneProps<E extends HTMLElement>
  extends React.HTMLAttributes<E> {
  onDragEnter: React.DragEventHandler<E>;
  onDragOver: React.DragEventHandler<E>;
  onDragLeave: React.DragEventHandler<E>;
  onDrop: React.DragEventHandler<E>;
  onClick: React.MouseEventHandler<E>;
  role: string;
  tabIndex: number;
}

InputProps​

Props retornadas por getInputProps.

interface InputProps extends React.InputHTMLAttributes<HTMLInputElement> {
  type: 'file';
  accept?: string;
  multiple?: boolean;
  onChange: React.ChangeEventHandler<HTMLInputElement>;
  style: React.CSSProperties;
}

Tipos de Nuvem​

S3UploaderConfig​

Configuração para uploader S3.

interface S3UploaderConfig {
  getPresignedUrl: (file: DropupFile) => Promise<PresignedUrlResponse>;
}

interface PresignedUrlResponse {
  url: string;
  fields?: Record<string, string>;
}

GCSUploaderConfig​

Configuração para uploader do Google Cloud Storage.

interface GCSUploaderConfig {
  getSignedUrl: (file: DropupFile) => Promise<SignedUrlResponse>;
}

interface SignedUrlResponse {
  url: string;
  headers?: Record<string, string>;
}

AzureUploaderConfig​

Configuração para uploader do Azure Blob Storage.

interface AzureUploaderConfig {
  getSasUrl: (file: DropupFile) => Promise<SasUrlResponse>;
}

interface SasUrlResponse {
  url: string;
  headers?: Record<string, string>;
}

Tipos de Upload em Partes​

ChunkedUploaderConfig​

Configuração para uploads em partes.

interface ChunkedUploaderConfig {
  /** URL do endpoint de upload */
  url: string;

  /** Tamanho da parte em bytes (padrão: 5MB) */
  chunkSize?: number;

  /** Máximo de partes concorrentes */
  concurrency?: number;

  /** Headers da requisição */
  headers?: Record<string, string>;
}

Tipos de Processamento de Imagem​

CompressOptions​

Opções de compressão de imagem.

interface CompressOptions {
  /** Largura máxima */
  maxWidth?: number;

  /** Altura máxima */
  maxHeight?: number;

  /** Qualidade 0-1 (padrão: 0.8) */
  quality?: number;

  /** Formato de saída */
  type?: 'image/jpeg' | 'image/png' | 'image/webp';
}

Utilitários de Tipo​

Tipos Genéricos​

// Extrair status do arquivo
type IdleFile = DropupFile & { status: 'idle' };
type UploadingFile = DropupFile & { status: 'uploading' };
type CompletedFile = DropupFile & { status: 'complete' };
type FailedFile = DropupFile & { status: 'error' };

// Funções de type guard
function isIdle(file: DropupFile): file is IdleFile {
  return file.status === 'idle';
}

function isUploading(file: DropupFile): file is UploadingFile {
  return file.status === 'uploading';
}

function isComplete(file: DropupFile): file is CompletedFile {
  return file.status === 'complete';
}

function isFailed(file: DropupFile): file is FailedFile {
  return file.status === 'error';
}

Uso com Type Guards​

const { files } = useDropup();

// Filtrar com segurança de tipos
const uploadingFiles = files.filter(isUploading);
// uploadingFiles é UploadingFile[]

const completedFiles = files.filter(isComplete);
// completedFiles é CompletedFile[]