chore: adding comments part 2

client/src/app/editor/components/edit-record/edit-record.component.ts

@@ -59,6 +59,12 @@ export class EditRecordComponent implements OnInit {
 
   ngOnInit(): void {}
 
+  /**
+   * Runs native HOT validator against cell value
+   * @param cellValidation column rules
+   * @param cellValue value in the cell that is beign validated
+   * @returns Promise boolean - wether valid or invalid
+   */
   async validateRecordCol(
     cellValidation: any,
     cellValue: any
@@ -74,6 +80,12 @@ export class EditRecordComponent implements OnInit {
     })
   }
 
+  /**
+   * Fired when date field in the record change
+   * Function will parse date and format to string
+   * @param date picker value
+   * @param colKey column name (key)
+   */
   recordDateChange(date: Date, colKey: string) {
     let cellValidation = this.currentRecordValidator?.getRule(colKey)
     let format = cellValidation ? cellValidation.dateFormat : ''
@@ -82,24 +94,38 @@ export class EditRecordComponent implements OnInit {
       this.currentRecord[colKey] = moment(date).format(format)
   }
 
-  isRecordModalInvalid(): boolean {
-    return this.currentRecordInvalidCols.length > 0
-  }
-
+  /**
+   * Close edit record modal and apply changes by emitting output event
+   */
   confirmRecordEdit() {
     if (this.currentRecordInvalidCols.length < 1) {
       this.onRecordChange.emit(this.currentRecord)
     }
   }
 
+  /**
+   * Close edit record modal without applying the changes
+   */
   closeRecordEdit() {
     this.onRecordEditClose.emit()
   }
 
+  /**
+   * Emitting output event when dropdown (autocomplete) input in any col change
+   * @param colName column name (key)
+   * @param col column index
+   */
   onRecordDropdownChange(colName: string, col: number) {
     this.onRecordDropdownChanged.emit({ colName, col })
   }
 
+  /**
+   * Emitting output event when input is focused (clicked on) so we can run a `dynamic cell validation`
+   * Since that bit must be run from the parent component (editor.component)
+   * Result is then applied in the `cellValidation` variable and automatically updated in this component.
+   * @param event input event
+   * @param colName column name (key)
+   */
   onRecordInputFocus(event: any, colName: number) {
     this.onRecordInputFocused.emit({ event, colName })
   }

client/src/app/editor/editor.component.ts

@@ -15,7 +15,15 @@ import { Subject, Subscription } from 'rxjs'
 import { SasStoreService } from '../services/sas-store.service'
 
 import * as XLSX from '@sheet/crypto'
+
+/**
+ * Used in combination with buffer
+ */
 const iconv = require('iconv-lite')
+/**
+ * In combination with `iconv` is used for encoding json data captured with sheet js from excel file into a file again
+ * Which will be send to backend
+ */
 const Buffer = require('buffer/').Buffer
 type AOA = any[][]
 

client/src/app/editor/models/EditRecordModal.ts

@@ -1,5 +1,10 @@
 import { DcValidation } from 'src/app/shared/dc-validator/models/dc-validation.model'
 
+/**
+ * Wrapper for DC Validation because we need `noLinkOption` property
+ * to be used as a flag to show/hide button that generates link for the
+ * edit record modal
+ */
 export interface EditRecordModal extends DcValidation {
   noLinkOption: boolean
   [key: string]: any

client/src/app/editor/models/cellValidation.ts

@@ -1,3 +1,6 @@
+/**
+ * FIXME: Remove
+ */
 export interface CellValidation {
   data: string
   length: number