@ibanzajoe/uploader 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,208 @@
+import { P as PickerResponse, F as FileResult, h as UploaderClientOptions } from './transform-ybCOCWBG.js';
+export { C as CropParams, O as OutputParams, a as PolicySpec, Q as QualityParams, R as ResizeParams, b as RotateParams, T as TransformChain, c as TransformOp, d as TransformOpName, e as TransformUrlOptions, U as UploadAllOptions, f as UploadOptions, g as UploaderClient, i as crop, j as flip, k as flop, o as output, q as quality, r as resize, l as rotate, t as transformUrl } from './transform-ybCOCWBG.js';
+import * as React from 'react';
+import React__default, { CSSProperties } from 'react';
+
+/**
+ * React picker prop and state types.
+ *
+ * Designed for filestack-parity naming so existing filestack integrations can
+ * migrate with minimal changes. All callback names match filestack's onUploadDone /
+ * onFileUploadFinished / onFileUploadFailed / onCancel surface.
+ */
+
+/** State of a single file entry in the picker queue. */
+type PickerFileState = 'pending' | 'uploading' | 'done' | 'error';
+/** A file in the picker's queue with upload state. */
+type PickerFile = {
+    /** Browser File object. */
+    file: File;
+    /** Stable key for React list rendering. */
+    id: string;
+    /** Current upload state. */
+    state: PickerFileState;
+    /** Upload progress 0–100, or null while pending. */
+    progress: number | null;
+    /** Result after successful upload. */
+    result?: FileResult;
+    /** Error message if upload failed. */
+    error?: string;
+    /** Object URL for image preview; revoked on removal. */
+    previewUrl?: string;
+};
+/** File type/size constraints and source settings for the picker. */
+type PickerOptions = {
+    /**
+     * MIME types or extensions to accept (e.g. ['image/*', '.pdf']).
+     * Maps to the <input accept="..."> attribute.
+     */
+    accept?: string[];
+    /** Maximum number of files selectable in one session. Default: unlimited. */
+    maxFiles?: number;
+    /** Maximum file size in bytes. Files above this are rejected at selection. */
+    maxSize?: number;
+    /**
+     * Upload sources. Currently only 'local_file_system' is supported (MVP).
+     * Extension point for webcam/URL/cloud pickers.
+     */
+    fromSources?: Array<'local_file_system'>;
+};
+/** Props shared by PickerOverlay and DropPane. */
+type SharedPickerProps = {
+    /** Public API key (pk_...). */
+    apikey: string;
+    /** Base URL of the upload API. */
+    apiUrl?: string;
+    /** Optional signed security policy. */
+    security?: {
+        policy: string;
+        signature: string;
+    };
+    /** File constraint and source options. */
+    pickerOptions?: PickerOptions;
+    /** Called when all uploads complete. */
+    onUploadDone?: (response: PickerResponse) => void;
+    /** Called when a single file finishes uploading. */
+    onFileUploadFinished?: (file: FileResult) => void;
+    /** Called when a single file upload fails. */
+    onFileUploadFailed?: (file: File, error: Error) => void;
+    /** Called when the user cancels / closes without uploading. */
+    onCancel?: () => void;
+};
+/** State and actions returned by usePicker. */
+type UsePickerResult = {
+    /** Current file queue. */
+    files: PickerFile[];
+    /** Add files to the queue. Respects maxFiles and maxSize. */
+    addFiles: (incoming: FileList | File[]) => void;
+    /** Remove a file from the queue by id. */
+    removeFile: (id: string) => void;
+    /** Replace a queued file's bytes with an edited version (resets it to pending). */
+    editFile: (id: string, newFile: File) => void;
+    /** Retry a failed file upload. */
+    retryFile: (id: string) => void;
+    /** Start uploading all pending files. */
+    upload: () => Promise<void>;
+    /** Aggregate progress 0–100 across all uploading files. */
+    progress: number;
+    /** True while any file is uploading. */
+    isUploading: boolean;
+    /** True once all files have finished (done or error). */
+    isDone: boolean;
+};
+
+/**
+ * PickerOverlay — modal file picker with drag-and-drop.
+ *
+ * A full-featured modal picker matching filestack's core UX:
+ *   - Drag-and-drop dropzone + "Browse files" button
+ *   - Multi-file queue with thumbnails/preview, per-file progress bars
+ *   - Remove and retry controls per file
+ *   - Aggregate progress bar
+ *   - Upload / Cancel action buttons
+ *   - Keyboard: ESC closes; Tab cycles within the modal (focus trap)
+ *   - ARIA: role="dialog", aria-modal, labelled header, live regions
+ *   - Themeable via CSS variables (--uploader-accent, etc.)
+ *
+ * Opens when `open={true}`. Calls `onClose` when the user dismisses via ESC,
+ * the backdrop click, or the Cancel button. `onUploadDone` fires after all
+ * selected files have been uploaded.
+ */
+
+type PickerOverlayProps = SharedPickerProps & {
+    /** Whether the modal is open. */
+    open: boolean;
+    /** Called when the modal should close (ESC, backdrop, cancel). */
+    onClose: () => void;
+    /** Additional CSS class(es) applied to the modal panel. */
+    className?: string;
+    /** Inline styles applied to the modal panel. */
+    style?: React__default.CSSProperties;
+};
+declare function PickerOverlay({ open, onClose, apikey, apiUrl, security, pickerOptions, onUploadDone, onFileUploadFinished, onFileUploadFailed, onCancel, className, style, }: PickerOverlayProps): React__default.JSX.Element | null;
+
+/**
+ * DropPane — inline drag-and-drop upload zone.
+ *
+ * A non-modal file drop target that renders in-place. Suitable for embedding
+ * directly in a page (e.g. a form upload field) rather than as a modal overlay.
+ *
+ * Uses usePicker() internally; exposes the same filestack-parity callbacks as
+ * PickerOverlay. Renders a file list with progress and remove/retry controls
+ * below the drop zone.
+ */
+
+type DropPaneProps = SharedPickerProps & {
+    /** Additional CSS class(es) applied to the root element. */
+    className?: string;
+    /** Inline styles applied to the root element. */
+    style?: React__default.CSSProperties;
+};
+declare function DropPane({ apikey, apiUrl, security, pickerOptions, onUploadDone, onFileUploadFinished, onFileUploadFailed, onCancel, className, style, }: DropPaneProps): React__default.JSX.Element;
+
+type UsePickerOptions = UploaderClientOptions & {
+    pickerOptions?: PickerOptions;
+    onUploadDone?: (response: PickerResponse) => void;
+    onFileUploadFinished?: (file: FileResult) => void;
+    onFileUploadFailed?: (file: File, error: Error) => void;
+};
+declare function usePicker(opts: UsePickerOptions): UsePickerResult;
+
+type ImageEditorProps = {
+    /** The image File to edit. */
+    file: File;
+    /** Called with the edited File when the user clicks Apply. */
+    onApply: (edited: File) => void;
+    /** Called when the user cancels editing. */
+    onCancel: () => void;
+    /** Output MIME type. Defaults to the source type (when re-encodable) else png. */
+    outputType?: string;
+    /** Quality 0–1 for lossy output. Default 0.92. */
+    quality?: number;
+    /** Default "max longest side" for the resize control. Default 1920. */
+    maxDimensionDefault?: number;
+    className?: string;
+    style?: CSSProperties;
+};
+declare function ImageEditor({ file, onApply, onCancel, outputType, quality, maxDimensionDefault, className, style, }: ImageEditorProps): React.JSX.Element;
+
+/**
+ * editImage — bake pre-upload edits (rotate / flip / crop / resize) into an
+ * image File using a <canvas>, returning a NEW File. Browser-only.
+ *
+ * The crop rectangle is in the pixel space of the rotated+flipped image (the
+ * order is: rotate, then flip, then crop, then resize). ImageEditor bakes
+ * rotation/flip into a working image first and passes a crop with rotation=0, so
+ * the crop coordinates come straight from the on-screen selection.
+ */
+type Flip = {
+    horizontal: boolean;
+    vertical: boolean;
+};
+type CropArea = {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+};
+type EditImageOptions = {
+    /** Clockwise rotation in degrees. */
+    rotation?: number;
+    /** Mirror horizontally / vertically. */
+    flip?: Flip;
+    /** Crop rectangle in the rotated+flipped image's natural pixels. */
+    crop?: CropArea;
+    /** If set, scale the result down so its longest side is at most this many pixels. */
+    maxDimension?: number;
+    /** Mask the result to a circle/ellipse (transparent corners). Forces PNG output. */
+    circle?: boolean;
+    /** Output MIME type. Defaults to the source type when re-encodable, else image/png. */
+    outputType?: string;
+    /** Quality 0–1 for lossy formats (jpeg/webp). Default 0.92. */
+    quality?: number;
+    /** Override the output filename. Defaults to the source name with a matching extension. */
+    fileName?: string;
+};
+declare function editImage(file: File, opts?: EditImageOptions): Promise<File>;
+
+export { type CropArea, DropPane, type DropPaneProps, type EditImageOptions, FileResult, type Flip, ImageEditor, type ImageEditorProps, type PickerFile, type PickerFileState, type PickerOptions, PickerOverlay, type PickerOverlayProps, PickerResponse, type SharedPickerProps, UploaderClientOptions, type UsePickerOptions, type UsePickerResult, editImage, usePicker };