Merge pull request #11 from pointcloudtechnology/5-add-option-to-distinguish-between-different-kind-of-files

Add option to distinguish between different kind of files

Author: adi64

dist/helpers.js

@@ -6,12 +6,24 @@ import { ResumableConfiguration } from './types/types';
  */
 export declare class Resumable extends ResumableEventHandler {
     private opts;
+    /**
+     * An object that contains one entry for every file category. The key is the category name, the value is an array of
+     * all ResumableFiles of that category that were added to this instance.
+     */
     private files;
+    /**
+     * Contains all file categories for which the upload was not yet completed.
+     */
+    private uncompletedFileCategories;
     private validators;
     private support;
     clearInput: boolean;
     dragOverClass: string;
-    fileTypes: string[];
+    fileCategories: string[];
+    defaultFileCategory: string | null;
+    fileTypes: string[] | {
+        [fileCategory: string]: string[];
+    };
     fileTypeErrorCallback: Function;
     _generateUniqueIdentifier: Function;
     maxFileSize?: number;
@@ -38,6 +50,7 @@ export declare class Resumable extends ResumableEventHandler {
      */
     protected setInstanceProperties(options: ResumableConfiguration): void;
     private sanitizeFileTypes;
+    private throwIfUnknownFileCategory;
     /**
      * Transforms a single fileEntry or directoryEntry item into a list of File objects this method is used to convert
      * entries found inside dragged-and-dropped directories.
@@ -61,7 +74,6 @@ export declare class Resumable extends ResumableEventHandler {
      * class to the element when a file is dropped onto it. In this case, we have to remove that class again before
      * calling "onDrop()".
      * If "onDrop()" is called from "handleDropEvent()" this is not needed.
-     *
      */
     private removeDragOverClassAndCallOnDrop;
     /**
@@ -80,47 +92,70 @@ export declare class Resumable extends ResumableEventHandler {
      * Validate and clean a list of files. This includes the removal of duplicates, a check whether the file type is
      * allowed and custom validation functions defined per file type.
      * @param {ExtendedFile[]} files A list of File instances that were previously extended with a uniqueIdentifier
+     * @param fileCategory The file category that has been provided for the files. Defaults to `defaultFileCategory`.
      */
     private validateFiles;
     /**
-     * Add an array of files to this instance's file list by creating new ResumableFiles. This includes a validation and
-     * deduplication of the provided array.
+     * Add an array of files to this instance's file list (of the file category, if given) by creating new ResumableFiles.
+     * This includes a validation and deduplication of the provided array.
      * @param fileList An array containing File objects
      * @param event The event with which the fileList was provided
+     * @param fileCategory The file category that has been provided for the file. Defaults to `defaultFileCategory`.
      */
     private appendFilesFromFileList;
     /**
      * Generate a new unique identifier for a given file either with a default helper function or with a custom
      * generator function.
      * @param file The file as an HTML 5 File object
      * @param event The event with which the file was provided originally
+     * @param fileCategory The file category that has been provided for the file. Defaults to `defaultFileCategory`.
      */
     private generateUniqueIdentifier;
     /**
      * Queue a new chunk to be uploaded that is currently awaiting upload.
      */
     private uploadNextChunk;
+    /**
+     * Returns all ResumableFiles of all file categories.
+     * The files are ordered by the order of the file categories in `this.fileCategories`. Files of the first category
+     * are added first, files of the second category are added second etc.
+     *
+     * @returns {ResumableFile[]} Array of all ResumableFiles that are stored for any category.
+     */
+    private getFilesOfAllCategories;
     /**
      *  PUBLIC METHODS FOR RESUMABLE.JS
      *  This section only includes methods that should be callable from external packages.
      */
     /**
      * Assign a browse action to one or more DOM nodes. Pass in true to allow directories to be selected (Chrome only).
+     *
+     * @param domNodes The dom nodes to which the browse action should be assigned (can be an array or a single dom node).
+     * @param isDirectory If true, directories can be added via the file picker (Chrome only).
+     * @param fileCategory The file category that will be assigned to all added files. Defaults to `defaultFileCategory`.
      */
-    assignBrowse(domNodes: HTMLElement | HTMLElement[], isDirectory?: boolean): void;
+    assignBrowse(domNodes: HTMLElement | HTMLElement[], isDirectory?: boolean, fileCategory?: string): void;
     /**
      * Assign one or more DOM nodes as a drop target.
+     *
+     * @param domNodes The dom nodes to which the drop action should be assigned (can be an array or a single dom node).
+     * @param fileCategory The file category that will be assigned to all added files. Defaults to `defaultFileCategory`.
      */
-    assignDrop(domNodes: HTMLElement | HTMLElement[]): void;
+    assignDrop(domNodes: HTMLElement | HTMLElement[], fileCategory?: string): void;
     /**
      * Remove one or more DOM nodes as a drop target.
      */
     unAssignDrop(domNodes: HTMLElement | HTMLElement[]): void;
     /**
-     * Set the file types allowed to upload. Optionally pass a dom node on which the accepted file types should be
-     * updated as well.
+     * Set the file types allowed to upload.
+     * Per default the file types are updated for the default file category.
+     * Optionally pass a dom node on which the accepted file types should be updated as well.
+     *
+     * @param fileTypes String array of all allowed file types
+     * @param domNode An optional HTMLInputElement for which the "accepted" attribute should be updated accordingly.
+     * @param fileCategory The file category for which the file types should be updated. Defaults to `defaultFileCategory`.
      */
-    setFileTypes(fileTypes: string[], domNode?: HTMLInputElement): void;
+    setFileTypes(fileTypes: string[], domNode?: HTMLInputElement, fileCategory?: string): void;
     /**
      * Check whether any files are currently uploading
      */
@@ -144,11 +179,11 @@ export declare class Resumable extends ResumableEventHandler {
     /**
      * Add a HTML5 File object to the list of files.
      */
-    addFile(file: File, event: Event): void;
+    addFile(file: File, event: Event, fileCategory?: string): void;
     /**
      * Add a list of HTML5 File objects to the list of files.
      */
-    addFiles(files: File[], event: Event): void;
+    addFiles(files: File[], event: Event, fileCategory?: string): void;
     /**
      * Add a validator function for the given file type. This can e.g. be used to read the file and validate
      * checksums based on certain properties.
@@ -157,7 +192,7 @@ export declare class Resumable extends ResumableEventHandler {
      */
     addFileValidator(fileType: string, validator: Function): void;
     /**
-     * Cancel the upload of a specific ResumableFile object and remove it from the file list.
+     * Remove the given resumable file from the file list (of its corresponding file category).
      */
     removeFile(file: ResumableFile): void;
     /**
@@ -171,13 +206,14 @@ export declare class Resumable extends ResumableEventHandler {
     /**
      * Call the event handler for a DragEvent (when a file is dropped on a drop area).
      */
-    handleDropEvent(e: DragEvent): void;
+    handleDropEvent(e: DragEvent, fileCategory?: string): void;
     /**
      * Call the event handler for an InputEvent (i.e. received one or multiple files).
      */
-    handleChangeEvent(e: InputEvent): void;
+    handleChangeEvent(e: InputEvent, fileCategory?: string): void;
     /**
-     * Check whether the upload is completed, i.e. if all files were uploaded successfully.
+     * Check whether the upload is completed (if all files of a category are uploaded and if all files in general are
+     * uploaded).
      */
     checkUploadComplete(): void;
     /**

dist/helpers.js.map

@@ -26,6 +26,7 @@ export default class ResumableChunk extends ResumableEventHandler {
     totalSizeParameterName: string;
     typeParameterName: string;
     identifierParameterName: string;
+    fileCategoryParameterName: string;
     fileNameParameterName: string;
     relativePathParameterName: string;
     totalChunksParameterName: string;

dist/main.js

@@ -13,10 +13,11 @@ export default class ResumableFile extends ResumableEventHandler {
     size: number;
     relativePath: string;
     uniqueIdentifier: string;
+    fileCategory: string;
     private _error;
     chunks: ResumableChunk[];
     private chunkSize;
-    constructor(file: File, uniqueIdentifier: string, options: object);
+    constructor(file: File, uniqueIdentifier: string, fileCategory: string, options: object);
     /**
      * Set the options provided inside the configuration object on this instance
      */