Frontend refactor

frontend/src/utils.ts

@@ -1,8 +1,24 @@
+import { IMessage } from "./interfaces"
+
+/**
+ * Validate an ip v4 via regex
+ * @param {string} ipAddr 
+ * @returns ip validity test
+ */
 export function validateIP(ipAddr: string): boolean {
     let ipRegex = /^(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)(?:\.(?:25[0-5]|2[0-4]\d|1\d\d|[1-9]\d|\d)){3}$/gm
     return ipRegex.test(ipAddr)
 }
 
+/**
+ * Validate a domain via regex.  
+ * The validation pass if the domain respects the following formats:  
+ * - localhost
+ * - domain.tld
+ * - dir.domain.tld
+ * @param domainName 
+ * @returns domain validity test
+ */
 export function validateDomain(domainName: string): boolean {
     let domainRegex = /[^@ \t\r\n]+.[^@ \t\r\n]+\.[^@ \t\r\n]+/
     return domainRegex.test(domainName) || domainName === 'localhost'
@@ -15,6 +31,11 @@ export function ellipsis(str: string, lim: number): string {
     return ''
 }
 
+/**
+ * Parse the downlaod speed sent by server and converts it to KiB/s
+ * @param str the downlaod speed, ex. format: 5 MiB/s => 5000 | 50 KiB/s => 50
+ * @returns download speed in KiB/s
+ */
 export function detectSpeed(str: string): number {
     let effective = str.match(/[\d,]+(\.\d+)?/)[0]
     const unit = str.replace(effective, '')
@@ -28,6 +49,14 @@ export function detectSpeed(str: string): number {
     }
 }
 
+/**
+ * Update a map stored in React State, in this specific impl. all maps have integer keys
+ * @param {num} k Map key
+ * @param {*} v Map value
+ * @param {Map<number, any>} target The target map saved in-state
+ * @param {Function} callback calls React's StateAction function with the newly created Map
+ * @param {boolean} remove -optional- is it an update or a deletion operation?
+ */
 export const updateInStateMap = (k: number, v: any, target: Map<number, any>, callback: Function, remove: boolean = false) => {
     if (remove) {
         target.delete(k)
@@ -36,3 +65,12 @@ export const updateInStateMap = (k: number, v: any, target: Map<number, any>, ca
     }
     callback(new Map(target.set(k, v)));
 }
+
+/**
+ * Pre like function
+ * @param data 
+ * @returns 
+ */
+export function buildMessage(data: IMessage) {
+    return `operation: ${data.status || '...'} \nprogress: ${data.progress || '?'} \nsize: ${data.size || '?'} \nspeed: ${data.dlSpeed || '?'}`;
+}