[BUILD]: build version 5.0.0

Author: JinSSJ3

.npmignore

@@ -1,6 +1,6 @@
 .github
 .storybook
-example
+examples
 node_modules
 storybook-static
 src

build/components/dropzone/components/Dropzone/DropzoneProps.d.ts

@@ -1,13 +1,13 @@
 import { OverridableProps } from "@unlimited-react-components/kernel";
 import { Localization } from "../../../../localization/localization";
 import { FileItemContainerProps } from "../../../file-item/components/FileItemContainer/FileItemContainerProps";
-import { FileValidated } from "../utils/validation.utils";
+import { FileDuiResponse } from "../utils/dropzone-ui.upload.utils";
+import { CustomValidateFileResponse, FileValidated } from "../utils/validation.utils";
 export interface DropzoneProps extends OverridableProps {
     /**
-     * What to do when Drop event is triggered
-     * In most cases is to retrieve the list of files validated
+     * This event is triggered when files are dropped or selected. Returns as first parameter the list of FileValidate files dropped or selected.
      */
-    onDrop?: Function;
+    onDrop?: (filesDropped: FileValidated[]) => void;
     /**
      * Upload Url or endpoint
      */
@@ -76,7 +76,7 @@ export interface DropzoneProps extends OverridableProps {
      * must be a function that recieves as first parameter a File Object
      * and must return a boolean value
      */
-    validator?: (f: File) => boolean;
+    validator?: (f: File) => CustomValidateFileResponse;
     /**
      * The current number of valid files
      */
@@ -115,16 +115,39 @@ export interface DropzoneProps extends OverridableProps {
      */
     value?: FileValidated[];
     /**
-     * In both cases of uploading (onDropUpload, or with clicking upload button)
-     * This event is the result one by one of the uploading process
+     * This event is triggered when upload process starts
+     * also returns the list of files that will be uploaded,
+     * Unlike Onchange, onUploadStart will only return a list of files thta are candidates to be uploaded,
+     * in case they are valid or upload status is "error"
      */
-    onUploading?: (files: FileValidated[]) => void;
+    onUploadStart?: (files: FileValidated[]) => void;
+    /**
+    * This event returns as first aparameter the list of responses for each file following the structure:
+    * responses = [
+    *  {id: <the file id>, serverResponse: the server response}
+    * ]
+    */
+    onUploadFinish?: (responses: FileDuiResponse[]) => void;
     /**
      * A message to show in the footer when the uploading process happens
      */
     uploadingMessage?: string;
     /**
-     * The onChange Event occurs when the value is changed
+     * Probably one of the most important methods.
+     * Onchange returns as first parameter the list of validated files,
+     * following the structure:
+     * file =
+     *  {
+     *      file: File;
+     *      valid: boolean;
+     *      id: number | string | undefined;
+     *      errors?: string[];
+     *      uploadMessage?: string;
+     *      uploadStatus?: undefined | "uploading", success, error;
+     *  }
+     *
+     * This event is also triggered when upload starts and when upload
+     * finishes for each file in order to update the props on very FIleItem
      */
     onChange?: (files: FileValidated[]) => void;
     /**
@@ -143,7 +166,7 @@ export interface DropzoneProps extends OverridableProps {
     /**
     * language to be used
     * for now
-    * only English, French and Spanish are supported
+    * only English, French , Portuguese and Spanish are supported
     */
     localization?: Localization;
 }

build/components/dropzone/components/utils/dropzone-ui.upload.utils.d.ts

@@ -1,6 +1,19 @@
 import { DropzoneProps } from "../Dropzone/DropzoneProps";
 import { FileValidated } from "./validation.utils";
-export declare const uploadPromiseAxios: (file: FileValidated, url: string, method: DropzoneProps["method"], config: any) => Promise<FileValidated>;
+export declare const uploadPromiseAxios: (file: FileValidated, url: string, method: DropzoneProps["method"], config: any) => Promise<UploadPromiseAxiosResponse>;
+export interface UploadPromiseAxiosResponse {
+    serverResponse: FileDuiResponse;
+    uploadedFile: FileValidated;
+}
+export interface FileDuiResponse {
+    id: number | string | undefined;
+    serverResponse: DropzoneUIResponse | {};
+}
+export interface DropzoneUIResponse {
+    status: boolean;
+    message: string;
+    payload: any;
+}
 /**
  * In construction
  */

build/components/dropzone/components/utils/errors.utils.d.ts

@@ -1,10 +1,16 @@
+import { LocalLabels } from "../../../../localization/localization";
+export declare enum UPLOADSTATUS {
+    uploading = "uploading",
+    success = "success",
+    error = "error"
+}
 export interface FileValidated {
     file: File;
     valid: boolean;
-    id: number;
+    id: number | string | undefined;
     errors?: string[];
     uploadMessage?: string;
-    uploadStatus?: undefined | "uploading" | "success" | "error";
+    uploadStatus?: undefined | UPLOADSTATUS;
 }
 export interface FileValidator {
     maxFileSize?: number;
@@ -30,16 +36,37 @@ export declare const validateAccept: (accept: string[], file: File) => boolean;
  * @param validator the validator object
  * @returns a FileValidated object
  */
-export declare const validateFile: (file: File, validator: FileValidator) => FileValidated;
+export declare const validateFile: (file: File, validator: FileValidator, localErrors: LocalLabels) => FileValidated;
+export interface CustomValidateFileResponse {
+    valid: boolean;
+    errors?: string[];
+}
 /**
  * Function that validate whether  afile is valid or not
  * according to the Filevalidator properties
  * @param file
  * @param validator
  * @returns
  */
-export declare const customValidateFile: (file: File, validator: (f: File) => boolean) => FileValidated;
+export declare const customValidateFile: (file: File, validator: (f: File) => CustomValidateFileResponse) => FileValidated;
+/**
+ * An id generaor
+ */
 export declare abstract class FileIdGenerator {
     static nextId: number;
+    /**
+     * INcreases the id conter and returns the next id available.
+     * @returns the next integer id available
+     */
     static getNextId(): number;
 }
+/**
+ * Make a validated file that is ready to use on FileItem component,
+ * if valid is not set, a random operation will decide whether the file is valid or not
+ * @param file The file
+ * @param valid true if it is a valid file, otherwise is false
+ * @param uploadStatus the current upload status. If not given a random upload status will be set
+ * @param uploadMessage the upload message after uploading
+ * @returns a Vaidated File object
+ */
+export declare const makeSynthticFileValidate: (file: File, valid?: boolean, uploadStatus?: UPLOADSTATUS, uploadMessage?: string) => FileValidated;

build/components/dropzone/components/utils/validation.utils.d.ts

@@ -30,14 +30,15 @@ export interface FileItemProps extends PaperProps {
     /**
      * A function of what to do when close button is pressed or clicked
      */
-    onDelete?: Function;
+    onDelete?: (imageUrl: number | string | undefined) => void;
     /**
      * A function of what to do when "see" button is pressed or clicked
      */
-    onSee?: Function;
+    onSee?: (imageUrl: string) => void;
     /**
      * Whether to see as grid or inline (horizontal list)
      */
+    errors?: string[];
     /**
      * individual validator for each file
      */
@@ -59,8 +60,8 @@ export interface FileItemProps extends PaperProps {
     */
     valid?: boolean;
     /**
-    * This feature is hidden, it is not present on documentation
-    * because is experimental. If you found this prop, you can test it
+    * This feature is hidden, it is not present on the documentation
+    * because it's experimental. If you found this prop, you can test it
     * and comment us if any issue is found. Thanks in advance.
     *
     * Make file name, info layer, size and "valid message"
@@ -73,6 +74,12 @@ export interface FileItemProps extends PaperProps {
      * Only works when given a image file
      */
     info?: boolean;
+    /**
+     * A string representation or web url of the image
+     * that will be set to the "src" prop of an <img/> tag
+     * <img src={`${url}`} />
+     */
+    imageUrl?: string;
     /**
      * The message from server
      */

build/components/file-item/components/FileItem/FileItemProps.d.ts

@@ -17,4 +17,5 @@ export interface FileItemFullInfoLayerProps {
      * only English and Spanish is supported
      */
     localization?: Localization;
+    errors?: string[];
 }

build/components/file-item/components/FileItemFullInfoLayer/FileItemFullInfoLayer.d.ts

@@ -31,4 +31,4 @@ export declare const getExt: (fileName: string) => string;
  * @param word
  * @returns
  */
-export declare const shrinkWord: (word: string) => string;
+export declare const shrinkWord: (word?: string) => string;

build/components/file-item/utils/utils.files.d.ts

@@ -1,4 +1,6 @@
 import { MaterialButtonProps } from "@unlimited-react-components/material-button";
+import { Localization } from "../../localization/localization";
+import { CustomValidateFileResponse } from "../dropzone/components/utils/validation.utils";
 export interface InputButtonProps extends MaterialButtonProps {
     /**
      * the id of the component
@@ -28,14 +30,20 @@ export interface InputButtonProps extends MaterialButtonProps {
    * must be a function that recieves as first parameter a File Object
    * and must return a boolean value
    */
-    validator?: (f: File) => boolean;
+    validator?: (f: File) => CustomValidateFileResponse;
     /**
      * Max number of files to be accepted.
      */
     /**
      * max file size allowed in bytes
      */
     maxFileSize?: number;
+    /**
+  * language to be used
+  * for now
+  * only English, French , Portuguese and Spanish are supported
+  */
+    localization?: Localization;
 }
 /**
  * The default props when not given

build/components/input-button/InputButtonProps.d.ts

@@ -1,5 +1,12 @@
-import { createPDF, createWord } from "./utils/files.utils";
-export { createPDF, createWord };
+import { createPDF, createWord, createListOfMultiTypeFile } from "./utils/files.utils";
+import { makeSynthticFileValidate } from "./components/dropzone/components/utils/validation.utils";
+import { UploadPromiseAxiosResponse, FileDuiResponse, DropzoneUIResponse } from "./components/dropzone/components/utils/dropzone-ui.upload.utils";
+import { FileValidated, UPLOADSTATUS } from "./components/dropzone/components/utils/validation.utils";
+export declare type UploadPromiseAxiosResponseType = UploadPromiseAxiosResponse;
+export declare type FileDuiResponseType = FileDuiResponse;
+export declare type DropzoneUIResponseType = DropzoneUIResponse;
+export declare type FileValidatedType = FileValidated;
+export { createPDF, createWord, createListOfMultiTypeFile, makeSynthticFileValidate, UPLOADSTATUS };
 export { default as Dropzone } from "./components/dropzone/components/Dropzone/Dropzone";
 export * from "./components/dropzone/components/Dropzone/Dropzone";
 export { default as DropzoneLabel } from "./components/dropzone/components/DropzoneLabel/DropzoneLabel";