@bitbybit-dev/base 0.19.6 → 0.19.8

package/lib/api/services/{lists.js → lists.ts}

@@ -1,4 +1,5 @@
 import * as Inputs from "../inputs";
+
 /**
  * Contains various list methods.
  * <div>
@@ -14,19 +15,20 @@ export class Lists {
      * @shortname item by index
      * @drawable false
      */
-    getItem(inputs) {
+    getItem<T>(inputs: Inputs.Lists.ListItemDto<T>): T {
         if (inputs.index < 0 || inputs.index >= inputs.list.length) {
             throw new Error("Index out of bounds");
         }
         let result;
         if (inputs.clone) {
             result = structuredClone(inputs.list[inputs.index]);
-        }
-        else {
+        } else {
             result = inputs.list[inputs.index];
         }
         return result;
     }
+
+
     /**
      * Gets items randomly by using a threshold
      * @param inputs a list and a threshold for randomization of items to remove
@@ -35,7 +37,7 @@ export class Lists {
      * @shortname random get threshold
      * @drawable false
      */
-    randomGetThreshold(inputs) {
+    randomGetThreshold<T>(inputs: Inputs.Lists.RandomThresholdDto<T>): T[] {
         let res = inputs.list;
         if (inputs.clone) {
             res = structuredClone(inputs.list);
@@ -48,6 +50,7 @@ export class Lists {
         }
         return newList;
     }
+
     /**
        * Gets a sub list between start and end indexes
        * @param inputs a list and start and end indexes
@@ -56,16 +59,16 @@ export class Lists {
        * @shortname sublist
        * @drawable false
        */
-    getSubList(inputs) {
+    getSubList<T>(inputs: Inputs.Lists.SubListDto<T>): T[] {
         let result;
         if (inputs.clone) {
             result = structuredClone(inputs.list.slice(inputs.indexStart, inputs.indexEnd));
-        }
-        else {
+        } else {
             result = inputs.list.slice(inputs.indexStart, inputs.indexEnd);
         }
         return result;
     }
+
     /**
      * Gets nth item in the list
      * @param inputs a list and index
@@ -74,7 +77,7 @@ export class Lists {
      * @shortname every n-th
      * @drawable false
      */
-    getNthItem(inputs) {
+    getNthItem<T>(inputs: Inputs.Lists.GetNthItemDto<T>): T[] {
         let cloned = inputs.list;
         if (inputs.clone) {
             cloned = structuredClone(inputs.list);
@@ -95,7 +98,7 @@ export class Lists {
      * @shortname by pattern
      * @drawable false
      */
-    getByPattern(inputs) {
+    getByPattern<T>(inputs: Inputs.Lists.GetByPatternDto<T>): T[] {
         const { list, pattern } = inputs;
         if (!pattern || pattern.length === 0) {
             throw new Error("Pattern is empty or does not exist");
@@ -124,6 +127,7 @@ export class Lists {
         }
         return result;
     }
+
     /**
      * Merge elements of lists on a given level and flatten output if needed
      * @param inputs lists, level and flatten data
@@ -132,9 +136,10 @@ export class Lists {
      * @shortname merge levels
      * @drawable false
      */
-    mergeElementsOfLists(inputs) {
+    mergeElementsOfLists<T>(inputs: Inputs.Lists.MergeElementsOfLists<T[]>): T[] {
         const lists = inputs.lists;
         const level = inputs.level;
+
         const elToMerge = [];
         const result = [];
         lists.forEach(list => {
@@ -142,6 +147,7 @@ export class Lists {
             const elementsToMerge = list.flat(level);
             elToMerge.push(elementsToMerge);
         });
+
         const lengthMerge = this.getLongestListLength({ lists: elToMerge });
         for (let i = 0; i < lengthMerge; i++) {
             const temp = [];
@@ -155,25 +161,24 @@ export class Lists {
                 result.push(temp);
             }
         }
+
         let final = [];
         if (level > 0) {
             for (let i = 0; i < level; i++) {
                 if (i === level - 1 && i !== 0) {
                     final[i - 1].push(result);
-                }
-                else if (i === level - 1) {
+                } else if (i === level - 1) {
                     final.push(result);
-                }
-                else {
+                } else {
                     final.push([]);
                 }
             }
-        }
-        else {
+        } else {
             final = result;
         }
         return final;
     }
+
     /**
      * Gets the longest list length from the list of lists
      * @param inputs a list of lists
@@ -182,20 +187,21 @@ export class Lists {
      * @shortname longest list length
      * @drawable false
      */
-    getLongestListLength(inputs) {
+    getLongestListLength<T>(inputs: Inputs.Lists.GetLongestListLength<T[]>): number {
         let longestSoFar = 0;
         if (inputs.lists) {
+
             inputs.lists.forEach(l => {
                 if (l.length > longestSoFar) {
                     longestSoFar = l.length;
                 }
             });
             return longestSoFar;
-        }
-        else {
+        } else {
             return undefined;
         }
     }
+
     /**
      * Reverse the list
      * @param inputs a list and an index
@@ -204,13 +210,14 @@ export class Lists {
      * @shortname reverse
      * @drawable false
      */
-    reverse(inputs) {
+    reverse<T>(inputs: Inputs.Lists.ListCloneDto<T>): T[] {
         let res = inputs.list;
         if (inputs.clone) {
             res = structuredClone(inputs.list);
         }
         return res.reverse();
     }
+
     /**
      * Flip 2d lists - every nth element of each list will form a separate list
      * @param inputs a list of lists to flip
@@ -219,7 +226,7 @@ export class Lists {
      * @shortname flip lists
      * @drawable false
      */
-    flipLists(inputs) {
+    flipLists<T>(inputs: Inputs.Lists.ListCloneDto<T[]>): T[][] {
         if (inputs.list.length > 0) {
             const lengthOfFirstList = inputs.list[0].length;
             let allListsSameLength = true;
@@ -238,15 +245,14 @@ export class Lists {
                     result.push(newList);
                 }
                 return result;
-            }
-            else {
+            } else {
                 throw new Error("Lists are not of the same length");
             }
-        }
-        else {
+        } else {
             throw new Error("List is empty");
         }
     }
+
     /**
      * Group in lists of n elements
      * @param inputs a list
@@ -255,8 +261,8 @@ export class Lists {
      * @shortname group elements
      * @drawable false
      */
-    groupNth(inputs) {
-        const groupElements = (inputs) => {
+    groupNth<T>(inputs: Inputs.Lists.GroupListDto<T>): T[] {
+        const groupElements = (inputs: Inputs.Lists.GroupListDto<T>) => {
             const { nrElements, list, keepRemainder } = inputs;
             const nrElementsInGroup = nrElements;
             const result = [];
@@ -276,6 +282,7 @@ export class Lists {
         // TODO make this work on any level
         return groupElements(inputs);
     }
+
     /**
      * Get the depth of the list
      * @param inputs a list
@@ -284,7 +291,7 @@ export class Lists {
      * @shortname max list depth
      * @drawable false
      */
-    getListDepth(inputs) {
+    getListDepth(inputs: Inputs.Lists.ListCloneDto<[]>): number {
         let levels = 0;
         let deeperLevelsExist = true;
         let flatRes = inputs.list;
@@ -298,14 +305,14 @@ export class Lists {
             flatRes = flatRes.flat();
             if (foundArray) {
                 levels++;
-            }
-            else {
+            } else {
                 levels++;
                 deeperLevelsExist = false;
             }
         }
         return levels;
     }
+
     /**
      * Gets the length of the list
      * @param inputs a length list
@@ -314,9 +321,10 @@ export class Lists {
      * @shortname list length
      * @drawable false
      */
-    listLength(inputs) {
+    listLength<T>(inputs: Inputs.Lists.ListCloneDto<T>): number {
         return inputs.list.length;
     }
+
     /**
      * Add item to the list
      * @param inputs a list, item and an index
@@ -325,7 +333,7 @@ export class Lists {
      * @shortname add item
      * @drawable false
      */
-    addItemAtIndex(inputs) {
+    addItemAtIndex<T>(inputs: Inputs.Lists.AddItemAtIndexDto<T>): T[] {
         let res = inputs.list;
         if (inputs.clone) {
             res = structuredClone(inputs.list);
@@ -335,6 +343,7 @@ export class Lists {
         }
         return res;
     }
+
     /**
      * Adds item to the list of provided indexes
      * @param inputs a list, item and an indexes
@@ -343,7 +352,7 @@ export class Lists {
      * @shortname add item at indexes
      * @drawable false
      */
-    addItemAtIndexes(inputs) {
+    addItemAtIndexes<T>(inputs: Inputs.Lists.AddItemAtIndexesDto<T>): T[] {
         let cloned = inputs.list;
         if (inputs.clone) {
             cloned = structuredClone(inputs.list);
@@ -355,9 +364,11 @@ export class Lists {
             if (index >= 0 && index + i <= cloned.length) {
                 cloned.splice(index + i, 0, inputs.item);
             }
-        });
+        }
+        );
         return cloned;
     }
+
     /**
      * Adds items to the list of provided indexes matching 1:1, first item will go to first index provided, etc.
      * @param inputs a list, items and an indexes
@@ -366,7 +377,7 @@ export class Lists {
      * @shortname add items
      * @drawable false
      */
-    addItemsAtIndexes(inputs) {
+    addItemsAtIndexes<T>(inputs: Inputs.Lists.AddItemsAtIndexesDto<T>): T[] {
         if (inputs.items.length !== inputs.indexes.length) {
             throw new Error("Items and indexes must have the same length");
         }
@@ -390,6 +401,7 @@ export class Lists {
         });
         return cloned;
     }
+
     /**
      * Remove item from the list
      * @param inputs a list and index
@@ -398,7 +410,7 @@ export class Lists {
      * @shortname remove item
      * @drawable false
      */
-    removeItemAtIndex(inputs) {
+    removeItemAtIndex<T>(inputs: Inputs.Lists.RemoveItemAtIndexDto<T>): T[] {
         let res = inputs.list;
         if (inputs.clone) {
             res = structuredClone(inputs.list);
@@ -408,6 +420,7 @@ export class Lists {
         }
         return res;
     }
+
     /**
      * Remove items from the list of provided indexes
      * @param inputs a list and indexes
@@ -416,7 +429,7 @@ export class Lists {
      * @shortname remove items
      * @drawable false
      */
-    removeItemsAtIndexes(inputs) {
+    removeItemsAtIndexes<T>(inputs: Inputs.Lists.RemoveItemsAtIndexesDto<T>): T[] {
         let res = inputs.list;
         if (inputs.clone) {
             res = structuredClone(inputs.list);
@@ -430,6 +443,7 @@ export class Lists {
         });
         return res;
     }
+
     /**
      * Remove all items from the list
      * @param inputs a list
@@ -438,10 +452,11 @@ export class Lists {
      * @shortname remove all items
      * @drawable false
      */
-    removeAllItems(inputs) {
+    removeAllItems<T>(inputs: Inputs.Lists.ListDto<T>): T[] {
         inputs.list.length = 0;
         return inputs.list;
     }
+
     /**
      * Remove item from the list
      * @param inputs a list and index
@@ -450,7 +465,7 @@ export class Lists {
      * @shortname every n-th
      * @drawable false
      */
-    removeNthItem(inputs) {
+    removeNthItem<T>(inputs: Inputs.Lists.RemoveNthItemDto<T>): T[] {
         let res = inputs.list;
         if (inputs.clone) {
             res = structuredClone(inputs.list);
@@ -463,6 +478,7 @@ export class Lists {
         }
         return result;
     }
+
     /**
      * Removes items randomly by using a threshold
      * @param inputs a list and a threshold for randomization of items to remove
@@ -471,7 +487,7 @@ export class Lists {
      * @shortname random remove threshold
      * @drawable false
      */
-    randomRemoveThreshold(inputs) {
+    randomRemoveThreshold<T>(inputs: Inputs.Lists.RandomThresholdDto<T>): T[] {
         let res = inputs.list;
         if (inputs.clone) {
             res = structuredClone(inputs.list);
@@ -484,6 +500,7 @@ export class Lists {
         }
         return newList;
     }
+
     /**
      * remove duplicate numbers from the list
      * @param inputs a list of numbers
@@ -492,13 +509,14 @@ export class Lists {
      * @shortname remove duplicates
      * @drawable false
      */
-    removeDuplicateNumbers(inputs) {
+    removeDuplicateNumbers(inputs: Inputs.Lists.RemoveDuplicatesDto<number>): number[] {
         let res = inputs.list;
         if (inputs.clone) {
             res = structuredClone(inputs.list);
         }
         return res.filter((value, index, self) => self.indexOf(value) === index);
     }
+
     /**
      * remove duplicate numbers from the list with tolerance
      * @param inputs a list of numbers and the tolerance
@@ -507,13 +525,14 @@ export class Lists {
      * @shortname remove duplicates tol
      * @drawable false
      */
-    removeDuplicateNumbersTolerance(inputs) {
+    removeDuplicateNumbersTolerance(inputs: Inputs.Lists.RemoveDuplicatesToleranceDto<number>): number[] {
         let res = inputs.list;
         if (inputs.clone) {
             res = structuredClone(inputs.list);
         }
         return res.filter((value, index, self) => self.findIndex(s => Math.abs(s - value) < inputs.tolerance) === index);
     }
+
     /**
      * Add item to the end of the list
      * @param inputs a list and an item
@@ -522,7 +541,7 @@ export class Lists {
      * @shortname add item to list
      * @drawable false
      */
-    addItem(inputs) {
+    addItem<T>(inputs: Inputs.Lists.AddItemDto<T>): T[] {
         let res = inputs.list;
         if (inputs.clone) {
             res = structuredClone(inputs.list);
@@ -530,6 +549,7 @@ export class Lists {
         res.push(inputs.item);
         return res;
     }
+
     /**
      * Add item to the beginning of the list
      * @param inputs a list and an item
@@ -538,7 +558,7 @@ export class Lists {
      * @shortname prepend item to list
      * @drawable false
      */
-    prependItem(inputs) {
+    prependItem<T>(inputs: Inputs.Lists.AddItemDto<T>): T[] {
         let res = inputs.list;
         if (inputs.clone) {
             res = structuredClone(inputs.list);
@@ -546,6 +566,7 @@ export class Lists {
         res.unshift(inputs.item);
         return res;
     }
+
     /**
      * Add item to the beginning or the end of the list
      * @param inputs a list, item and an option for first or last position
@@ -554,19 +575,19 @@ export class Lists {
      * @shortname item at first or last
      * @drawable false
      */
-    addItemFirstLast(inputs) {
+    addItemFirstLast<T>(inputs: Inputs.Lists.AddItemFirstLastDto<T>): T[] {
         let res = inputs.list;
         if (inputs.clone) {
             res = structuredClone(inputs.list);
         }
         if (inputs.position === Inputs.Lists.firstLastEnum.first) {
             res.unshift(inputs.item);
-        }
-        else {
+        } else {
             res.push(inputs.item);
         }
         return res;
     }
+
     /**
      * Creates an empty list
      * @returns an empty array list
@@ -574,9 +595,10 @@ export class Lists {
      * @shortname empty list
      * @drawable false
      */
-    createEmptyList() {
+    createEmptyList(): [] {
         return [];
     }
+
     /**
      * Repeat the item and add it in the new list
      * @param inputs an item to multiply
@@ -585,13 +607,14 @@ export class Lists {
      * @shortname repeat
      * @drawable false
      */
-    repeat(inputs) {
+    repeat<T>(inputs: Inputs.Lists.MultiplyItemDto<T>): T[] {
         const result = [];
         for (let i = 0; i < inputs.times; i++) {
             result.push(inputs.item);
         }
         return result;
     }
+
     /**
      * Repeat the list items by adding them in the new list till the certain length of the list is reached
      * @param inputs a list to multiply and a length limit
@@ -600,7 +623,7 @@ export class Lists {
      * @shortname repeat in pattern
      * @drawable false
      */
-    repeatInPattern(inputs) {
+    repeatInPattern<T>(inputs: Inputs.Lists.RepeatInPatternDto<T>): T[] {
         // will repeat the items provided in the patten till the certain length of the list is reached
         let inpList = inputs.list;
         if (inputs.clone) {
@@ -619,6 +642,7 @@ export class Lists {
         }
         return res;
     }
+
     /**
      * Sort the list of numbers in ascending or descending order
      * @param inputs a list of numbers to sort and an option for ascending or descending order
@@ -627,18 +651,18 @@ export class Lists {
      * @shortname sort numbers
      * @drawable false
      */
-    sortNumber(inputs) {
+    sortNumber(inputs: Inputs.Lists.SortDto<number>): number[] {
         let res = inputs.list;
         if (inputs.clone) {
             res = structuredClone(inputs.list);
         }
         if (inputs.orderAsc) {
             return res.sort((a, b) => a - b);
-        }
-        else {
+        } else {
             return res.sort((a, b) => b - a);
         }
     }
+
     /**
      * Sort the list of texts in ascending or descending order alphabetically
      * @param inputs a list of texts to sort and an option for ascending or descending order
@@ -647,18 +671,18 @@ export class Lists {
      * @shortname sort texts
      * @drawable false
      */
-    sortTexts(inputs) {
+    sortTexts(inputs: Inputs.Lists.SortDto<string>): string[] {
         let res = inputs.list;
         if (inputs.clone) {
             res = structuredClone(inputs.list);
         }
         if (inputs.orderAsc) {
             return res.sort();
-        }
-        else {
+        } else {
             return res.sort().reverse();
         }
     }
+
     /**
      * Sort by numeric JSON property value
      * @param inputs a list to sort, a property to sort by and an option for ascending or descending order
@@ -667,16 +691,16 @@ export class Lists {
      * @shortname sort json objects
      * @drawable false
      */
-    sortByPropValue(inputs) {
+    sortByPropValue(inputs: Inputs.Lists.SortJsonDto<any>): any[] {
         let res = inputs.list;
         if (inputs.clone) {
             res = structuredClone(inputs.list);
         }
         if (inputs.orderAsc) {
             return res.sort((a, b) => a[inputs.property] - b[inputs.property]);
-        }
-        else {
+        } else {
             return res.sort((a, b) => b[inputs.property] - a[inputs.property]);
         }
     }
+
 }