@ieeesa-npm/presentation 0.13.5 → 0.13.7

package/lib/services/file-upload.service.d.ts

@@ -0,0 +1,365 @@
+import { HttpBackend, HttpClient, HttpEvent } from '@angular/common/http';
+import { OnDestroy } from '@angular/core';
+import { AlertsService, HttpService, LoaderNotificationService } from '@ieeesa-npm/utility';
+import { FileUploadPresignedUrl } from '../models/file-upload-presigned-url-res.model';
+import { Observable, Subject } from 'rxjs';
+import * as i0 from "@angular/core";
+/**
+ * This service interacts with the server to obtain pre-signed URLs for file upload and uploads files to Amazon S3.
+ * @class FileUploadService
+ */
+export declare class FileUploadService implements OnDestroy {
+    httpService: HttpService;
+    alertService: AlertsService;
+    loaderNotificationService: LoaderNotificationService;
+    destroy$: Subject<boolean>;
+    constants: {
+        ariaLabel: {
+            clear: string;
+            warning: string;
+            previousMonth: string;
+            nextMonth: string;
+            menuIcon: string;
+            close: string;
+            search: string;
+            addFormGroup: string;
+        };
+        button: {
+            cancel: string;
+            ok: string;
+            add: string;
+        };
+        modalConfig: {
+            ariaLabel: string;
+            autoFocus: string;
+            width: string;
+        };
+        chips: {
+            noOfDefaultVisibleChips: number;
+            label: {
+                viewAll: string; /**
+                 * This service interacts with the server to obtain pre-signed URLs for file upload and uploads files to Amazon S3.
+                 * @class FileUploadService
+                 */
+                viewLess: string;
+            };
+            ariaLabel: {
+                chipsList: string;
+            };
+            icons: {
+                arrow: {
+                    id: number;
+                    iconURL: string;
+                    toolTip: string;
+                    ariaLabel: string;
+                };
+                remove: {
+                    id: number;
+                    iconURL: string;
+                    toolTip: string;
+                    ariaLabel: string;
+                };
+            };
+        };
+        dataTable: {
+            label: {
+                clearAll: string;
+            };
+            message: {
+                noRecordFound: string;
+            };
+            ariaLabel: {
+                search: string;
+                selectAll: string;
+                select: string;
+                link: string;
+                pagination: string;
+            };
+            buttons: {
+                id: number; /**
+                 * Sets the base URL for API requests.
+                 * @param {string} apiBaseUrl -API base URL.
+                 * @memberof FileUploadService
+                 */
+                iconURL: string;
+                toolTip: string;
+                ariaLabel: string;
+            }[];
+        };
+        datePicker: {
+            selectDateLabel: string;
+            dateFormatLabel: string;
+            startDateLabel: string;
+            endDateLabel: string;
+        };
+        dropdown: {
+            placeholderText: string;
+        };
+        filter: {
+            label: {
+                filterBy: string;
+                applyButton: string;
+                clearAll: string;
+            };
+            buttons: {
+                id: number;
+                iconURL: string;
+                toolTip: string;
+                ariaLabel: string;
+            }[];
+        };
+        textarea: {
+            maxLengthDefault: number;
+            leftCharacters: string;
+        };
+        autocomplete: {
+            /**
+             * Gets file upload progress.
+             * @param {*} message
+             * @memberof FileUploadService
+             */
+            minCharToSearch: number;
+            debounceTime: number;
+        };
+        header: {
+            alt: {
+                logo: string;
+            };
+            ariaLabel: {
+                helpLink: string;
+                hamburgerMenu: string;
+            };
+            label: {
+                signOut: string;
+            };
+            buttons: {
+                id: number; /**
+                 * Return distinct message for sent, upload progress, & response events.
+                 * @param {HttpEvent<any>} event
+                 * @param {(File | FileList)} file
+                 * @return {*}
+                 * @memberof FileUploadService
+                 */
+                iconURL: string;
+                toolTip: string;
+                ariaLabel: string;
+            }[];
+            userProfileMenuOptions: {
+                id: number;
+                iconURL: string;
+                label: string;
+                ariaLabel: string;
+                toolTip: string;
+                isToolTipNeeded: boolean;
+            }[];
+        };
+        footer: {
+            alt: {
+                logo: string;
+            };
+            links: {
+                label: string;
+                ariaLabel: string;
+                redirectUrl: string;
+            }[];
+            ieeeLogo: string;
+            copyright: {
+                link: string;
+                textPart1: string;
+                textPart2: string;
+                hyperLinkPart3: string;
+                textPart4: string;
+            };
+        };
+        welcome: {
+            buttons: {
+                label: string;
+                ariaLabel: string;
+                url: string; /**
+                 * Retrieves presigned URL for downloading files to Amazon S3 bucket.
+                 * @param {(File | FileList)} file
+                 * @return {Observable<string>}
+                 * @memberof FileUploadService
+                 */
+            }[];
+        };
+        breadcrumb: {
+            label: {
+                dashboard: string;
+            };
+        };
+        loader: {
+            ariaLabel: {
+                spinner: string;
+            };
+        };
+        defaultWelcomeBgColor: string;
+        timePicker: {
+            defaultTimeFormat: number;
+        };
+        colorPicker: {
+            selectLabel: string;
+            cancelLabel: string;
+            defaultColor: string;
+            ariaLabel: string;
+            ariaDescription: string;
+            ariaDescribedById: string;
+        };
+        fileUpload: {
+            label: {
+                fileUpload: string;
+                allowedFileSize1: string;
+                allowedFileSize2: string;
+                allowedFileFormat: string;
+                browseFiles: string;
+                uploadProgress: string;
+            };
+            ariaLabel: {
+                fileUpload: string;
+                browseFiles: string;
+                fileUploadIcon: string;
+                removeFileIcon: string;
+                deleteFileIcon: string;
+                fileDownload: string;
+                fileUploadInput: string;
+            };
+            iconUrl: {
+                fileUploadIcon: string;
+                fileRemoveIcon: string;
+                deleteIcon: string;
+            };
+            buttons: {
+                id: number;
+                ariaLabel: string;
+                iconURL: string;
+                toolTip: string;
+                disabled: boolean;
+            }[]; /**
+             * Validates the file types of the uploaded files.
+             * @param {(File | FileList)} files
+             * @param {string[]} allowedFileTypes
+             * @param {boolean} isMultiFileUpload
+             * @return {boolean} -Returns true if all files have valid extensions, otherwise false.
+             * @memberof FileUploadService
+             */
+            message: {
+                error: {
+                    errorReadingFile: string;
+                    invalidFileFormat: string;
+                    invalidFileSize: string;
+                    "2025": string;
+                    "2026": string;
+                };
+            };
+        };
+    };
+    apiBaseUrl: string;
+    fileByteArray: Uint8Array | undefined;
+    httpClient: HttpClient;
+    isFileUploading: boolean;
+    constructor(httpService: HttpService, handler: HttpBackend, alertService: AlertsService, loaderNotificationService: LoaderNotificationService);
+    /**
+     * Sets the base URL for API requests.
+     * @param {string} apiBaseUrl -API base URL.
+     * @memberof FileUploadService
+     */
+    setApiBaseUrl(apiBaseUrl: string): void;
+    /**
+     * Retrieves presigned URL for uploading files to Amazon S3 bucket.
+     * @param {(File | FileList)} file
+     * @return {Observable<FileUploadPresignedUrl>}
+     * @memberof FileUploadService
+     */
+    getFileUploadPresignedUrl(file: File | FileList): Observable<FileUploadPresignedUrl>;
+    /**
+     * Uploads file to AWS S3 using a presigned URL.
+     * @param {string} presignedUrl
+     * @param {(File | FileList)} file
+     * @return {Observable<any>} -Returns an observable that emits the response after uploading the file to S3.
+     * @memberof FileUploadService
+     */
+    uploadFileToS3(presignedUrl: string, file: File | FileList): Observable<any>;
+    /**
+     * Gets file upload progress.
+     * @param {*} message
+     * @memberof FileUploadService
+     */
+    showProgress(message: any): void;
+    /**
+     * Return distinct message for sent, upload progress, & response events.
+     * @param {HttpEvent<any>} event
+     * @param {(File | FileList)} file
+     * @return {*}
+     * @memberof FileUploadService
+     */
+    getEventMessage(event: HttpEvent<any>, file: File | FileList): string | true;
+    /**
+     * Converts file to byte array.
+     * @param {File} file
+     * @memberof FileUploadService
+     */
+    convertFileToByteArray(file: File): void;
+    /**
+     * Resets file byte array format to undefined.
+     * @memberof FileUploadService
+     */
+    clearFileByteArray(): void;
+    /**
+     * Sets file upload status.
+     * @param {boolean} status
+     * @memberof FileUploadService
+     */
+    setFileUploadStatus(status: boolean): void;
+    /**
+     * Returns file upload status.
+     * @return {boolean}
+     * @memberof FileUploadService
+     */
+    getFileUploadStatus(): boolean;
+    /**
+     * Retrieves presigned URL for downloading files to Amazon S3 bucket.
+     * @param {(File | FileList)} file
+     * @return {Observable<string>}
+     * @memberof FileUploadService
+     */
+    getFileDownloadPresignedUrls(file: File | FileList): Observable<string>;
+    /**
+     * Downloads file to AWS S3 using a presigned URL.
+     * @return {Observable<any>}
+     * @memberof FileUploadService
+     */
+    downloadFile(fileDownloadPresignedUrl: string): Observable<any>;
+    /**
+     * Validates the total size of the files uploaded.
+     * @param {(File | FileList)} files -The files to be validated.
+     * @param {number} maxFileSize
+     * @param {boolean} isMultiFileUpload
+     * @return {boolean} -Returns true if the total size of files is within the specified limit, otherwise false.
+     * @memberof FileUploadService
+     */
+    validateFileSize(files: File | FileList, maxFileSize: number, isMultiFileUpload: boolean): boolean;
+    /**
+     * Validates the file types of the uploaded files.
+     * @param {(File | FileList)} files
+     * @param {string[]} allowedFileTypes
+     * @param {boolean} isMultiFileUpload
+     * @return {boolean} -Returns true if all files have valid extensions, otherwise false.
+     * @memberof FileUploadService
+     */
+    validateFileTypes(files: File | FileList, allowedFileTypes: string[], isMultiFileUpload: boolean): boolean;
+    /**
+     * Extracts and returns the extension of a file from its name.
+     * @private
+     * @param {string} fileName
+     * @return {string} -The file extension in lowercase.
+     * @memberof FileUploadService
+     */
+    private getFileExtension;
+    /**
+     * Implementation of ngOnDestroy lifecycle hook method to unsubscribe the open observable subscriptions.
+     * @memberof FileUploadService
+     */
+    ngOnDestroy(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<FileUploadService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<FileUploadService>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ieeesa-npm/presentation",
-  "version": "0.13.5",
+  "version": "0.13.7",
   "peerDependencies": {
     "@angular/common": "^16.1.0",
     "@angular/core": "^16.1.0",

package/public-api.d.ts

@@ -32,10 +32,13 @@ export * from './lib/components/tabs/tabs.component';
 export * from './lib/components/slide-toggle/slide-toggle.component';
 export * from './lib/components/card/card.component';
 export * from './lib/components/color-picker/color-picker.component';
+export * from './lib/components/file-upload/file-upload.component';
+export * from './lib/components/accordion/accordion.component';
 export * from './lib/directives/dynamic-form-field/dynamic-form-field.directive';
 export * from './lib/directives/focus-invalid-form-field/focus-invalid-form-field.directive';
 export * from './lib/directives/set-background/set-background.directive';
 export * from './lib/directives/text-truncated/text-truncated.directive';
+export * from './lib/directives/file-upload/file-upload.directive';
 export * from './lib/models/align-type.model';
 export * from './lib/models/app-config-info.model';
 export * from './lib/models/autocomplete-option.model';
@@ -77,6 +80,10 @@ export * from './lib/models/button-type.model';
 export * from './lib/models/card-button.model';
 export * from './lib/models/card-info.model';
 export * from './lib/models/color-format.model';
+export * from './lib/models/allowed-file-types.model';
+export * from './lib/models/file-upload-presigned-url-res.model';
+export * from './lib/models/accordion-info.model';
 export * from './lib/services/datepicker.service';
 export * from './lib/services/form-utility.service';
+export * from './lib/services/file-upload.service';
 export * from './lib/presentation.module';

package/src/lib/assets/constants.json

@@ -252,5 +252,47 @@
     "ariaLabel": "Color Picker",
     "ariaDescription": "Choose background color.",
     "ariaDescribedById": "ariaColorPicker"
+  },
+  "fileUpload": {
+    "label": {
+      "fileUpload": "Drag and Drop your files here or Click 'Browse Files'.",
+      "allowedFileSize1": "Allowed File size up to",
+      "allowedFileSize2": "mb only;",
+      "allowedFileFormat": "Allowed file format(s): ",
+      "browseFiles": "Browse Files",
+      "uploadProgress": "Uploading... please wait"
+    },
+    "ariaLabel": {
+      "fileUpload": "Drag and Drop your files here or Click 'Browse Files'.",
+      "browseFiles": "Browse Files",
+      "fileUploadIcon": "File upload icon",
+      "removeFileIcon": "Remove file icon",
+      "deleteFileIcon": "Delete file icon",
+      "fileDownload": "File download",
+      "fileUploadInput": "File upload"
+    },
+    "iconUrl": {
+      "fileUploadIcon": "assets/images/sprites/sprites.svg#icon-file-upload",
+      "fileRemoveIcon": "assets/images/sprites/sprites.svg#icon-file-remove",
+      "deleteIcon": "assets/images/sprites/sprites.svg#icon-file-delete-upload"
+    },
+    "buttons": [
+      {
+        "id": 1,
+        "ariaLabel": "File upload icon.",
+        "iconURL": "assets/images/sprites/sprites.svg#icon-file-upload",
+        "toolTip": "",
+        "disabled": true
+      }
+    ],
+    "message": {
+      "error": {
+        "errorReadingFile": "File is damaged or unreadable.",
+        "invalidFileFormat": "Invalid file format. Please upload SVG, PNG and JPG file format only.",
+        "invalidFileSize": "File size exceeds the maximum limit.",
+        "2025": "Unable to establish connection. Please try again later.",
+        "2026": "Invalid file format. Please upload SVG, PNG and JPG file format only."
+      }
+    }
   }
 }