@energycap/components 0.39.21-ECAP-25650-file-upload-validation-support.20240806-0942 → 0.39.21-ECAP-25650-file-upload-validation-support.20240806-1534

package/lib/controls/file-upload/file-upload.component.d.ts

@@ -23,7 +23,16 @@ export type FileValidatorCallback = (file: File | null | undefined, base64: stri
 export declare class FileUploadComponent extends FormControlBase implements OnInit, OnChanges {
     protected validationMessageService: ValidationMessageService;
     protected formGroupHelper: FormGroupHelper;
-    static getFormModel(validators: ValidatorFn[], disabled?: boolean, fileValidators?: AsyncValidatorFn | AsyncValidatorFn[]): FormGroup<FileUploadFormGroup>;
+    static getFormModel(validators: ValidatorFn[], disabled?: boolean, 
+    /** Any validators required to make sure the selected file is valid. It is recommended that you use `FileUploadComponent.getFileValidator` to help construct the validator(s). NOTE: This currently only works when multiSelect is false. */
+    fileValidators?: AsyncValidatorFn | AsyncValidatorFn[]): FormGroup<FileUploadFormGroup>;
+    /**
+     * Helper function that returns an async validator to be used with the file upload control.
+     * This is useful for when the file needs to be validated before it can be uploaded.
+     *
+     * @param callback The callback function that will be called to validate the file. Parameters for the callback are the file and the base64 string for the file.
+     * base64 is null if the fileOutput input on the FileUploadComponent is set to raw. Using fileOutput set to base64 is recommended for images.
+     */
     static getFileValidator(callback: FileValidatorCallback): AsyncValidatorFn;
     formModel: FormGroup<FileUploadFormGroup>;
     /**
@@ -91,19 +100,13 @@ export declare class FileUploadComponent extends FormControlBase implements OnIn
      * @param base64FileString Optional: Will have a value provided if the fileOutput is set to base64
      */
     private processFile;
+    /** Patches the form with the selected file in order to trigger control validation */
+    private validateFile;
     /**
      * Based on the fileOutput return whether this component is expected to deliver a base64 output
      * @returns
      */
     private isBase64FileOutput;
-    /**
-     * When the file was selected and processed patch the file information that the hosting form will
-     * be looking for.
-     * @param file
-     * @param base64FileString
-     * @param onFileSelectedResult
-     */
-    private patchProcessedFile;
     /** Maps the files to an array of File objects and sends them along
      * to the derived onMultipleFileSelected method in the hosting component
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@energycap/components",
-  "version": "0.39.21-ECAP-25650-file-upload-validation-support.20240806-0942",
+  "version": "0.39.21-ECAP-25650-file-upload-validation-support.20240806-1534",
   "dependencies": {
     "tslib": "^2.0.0"
   },