index.d.ts

declare module '@appfolio/react-native-upload' {
  import type { EventSubscription } from 'react-native';

  export interface EventData {
    id: string;
  }

  export interface ProgressData extends EventData {
    progress: number;
  }

  export interface ErrorData extends EventData {
    error: string;
  }

  export interface CompletedData extends EventData {
    responseCode: number;
    responseBody: string;
  }
  export type FileInfo = {
    name: string;
    exists: boolean;
    size?: number;
    extension?: string;
    mimeType?: string;
  };

  export type NotificationOptions = {
    /**
     * Enable or diasable notifications. Works only on Android version < 8.0 Oreo. On Android versions >= 8.0 Oreo is required by Google's policy to display a notification when a background service run  { enabled: true }
     */
    enabled: boolean;
    /**
     * Autoclear notification on complete  { autoclear: true }
     */
    autoClear: boolean;
    /**
     * Sets android notificaion channel  { notificationChannel: "My-Upload-Service" }
     */
    notificationChannel: string;
    /**
     * Sets whether or not to enable the notification sound when the upload gets completed with success or error   { enableRingTone: true }
     */
    enableRingTone: boolean;
    /**
     * Sets notification progress title  { onProgressTitle: "Uploading" }
     */
    onProgressTitle: string;
    /**
     * Sets notification progress message  { onProgressMessage: "Uploading new video" }
     */
    onProgressMessage: string;
    /**
     * Sets notification complete title  { onCompleteTitle: "Upload finished" }
     */
    onCompleteTitle: string;
    /**
     * Sets notification complete message  { onCompleteMessage: "Your video has been uploaded" }
     */
    onCompleteMessage: string;
    /**
     * Sets notification error title   { onErrorTitle: "Upload error" }
     */
    onErrorTitle: string;
    /**
     * Sets notification error message   { onErrorMessage: "An error occured while uploading a video" }
     */
    onErrorMessage: string;
    /**
     * Sets notification cancelled title   { onCancelledTitle: "Upload cancelled" }
     */
    onCancelledTitle: string;
    /**
     * Sets notification cancelled message   { onCancelledMessage: "Video upload was cancelled" }
     */
    onCancelledMessage: string;
  };

  export interface UploadOptions {
    url: string;
    path: string;
    type?: 'raw' | 'multipart';
    method?: 'POST' | 'GET' | 'PUT' | 'PATCH' | 'DELETE';
    customUploadId?: string;
    headers?: {
      [index: string]: string;
    };
    // Android notification settings
    notification?: Partial<NotificationOptions>;
    /**
     * AppGroup defined in XCode for extensions. Necessary when trying to upload things via this library
     * in the context of ShareExtension.
     */
    appGroup?: string;
    // Necessary only for multipart type upload
    field?: string;
  }

  export interface MultipartUploadOptions extends UploadOptions {
    type: 'multipart';
    field: string;
    parameters?: {
      [index: string]: string;
    };
  }

  type uploadId = string;

  export type UploadListenerEvent =
    | 'progress'
    | 'error'
    | 'completed'
    | 'cancelled';

  export enum UploadState {
    Cancelled = 'cancelled',
    Completed = 'completed',
    Pending = 'pending',
    Running = 'running',
  }

  export type SystemUploadStates = Array<{ id: string, state: UploadState }>;

  export default class Upload {
    static startUpload(
      options: UploadOptions | MultipartUploadOptions,
    ): Promise<uploadId>;
    static addListener(
      event: 'progress',
      uploadId: uploadId | null,
      callback: (data: ProgressData) => void,
    ): EventSubscription;
    static addListener(
      event: 'error',
      uploadId: uploadId | null,
      callback: (data: ErrorData) => void,
    ): EventSubscription;
    static addListener(
      event: 'completed',
      uploadId: uploadId | null,
      callback: (data: CompletedData) => void,
    ): EventSubscription;
    static addListener(
      event: 'cancelled',
      uploadId: uploadId | null,
      callback: (data: EventData) => void,
    ): EventSubscription;
    static getFileInfo(path: string): Promise<FileInfo>;
    static cancelUpload(uploadId: uploadId): Promise<boolean>;
    static canSuspendIfBackground(): void;
    static shouldLimitNetwork(limit: boolean): void;
    static getAllUploads(): Promise<SystemUploadStates>;
  }
}