@aneuhold/core-ts-db-lib 2.0.1 → 2.0.2

package/lib/schemas/validators/ValidateUtil.d.ts

@@ -18,15 +18,70 @@ export default class Validate {
     private errorsArray;
     parentObject: IndexableObject;
     constructor(parentObject: object, errorsArray: string[]);
+    /**
+     * Validates if the field is an optional string.
+     *
+     * @param fieldName - The name of the field to validate.
+     */
     optionalString(fieldName: string): void;
+    /**
+     * Validates if the field is an optional number.
+     *
+     * @param fieldName - The name of the field to validate.
+     */
     optionalNumber(fieldName: string): void;
+    /**
+     * Validates if the field is an optional boolean.
+     *
+     * @param fieldName - The name of the field to validate.
+     */
     optionalBoolean(fieldName: string): void;
+    /**
+     * Validates if the field is an optional array.
+     *
+     * @param fieldName - The name of the field to validate.
+     */
     optionalArray(fieldName: string): void;
+    /**
+     * Validates if the field is an optional object.
+     *
+     * @param fieldName - The name of the field to validate.
+     */
     optionalObject(fieldName: string): void;
+    /**
+     * Validates if the field is a string.
+     *
+     * @param fieldName - The name of the field to validate.
+     * @param defaultValue - The default value to set if validation fails.
+     */
     string(fieldName: string, defaultValue: string): void;
+    /**
+     * Validates if the field is an object.
+     *
+     * @param fieldName - The name of the field to validate.
+     * @param defaultValue - The default value to set if validation fails.
+     */
     object(fieldName: string, defaultValue: object): void;
+    /**
+     * Validates if the field is a number.
+     *
+     * @param fieldName - The name of the field to validate.
+     * @param defaultValue - The default value to set if validation fails.
+     */
     number(fieldName: string, defaultValue: number): void;
+    /**
+     * Validates if the field is a boolean.
+     *
+     * @param fieldName - The name of the field to validate.
+     * @param defaultValue - The default value to set if validation fails.
+     */
     boolean(fieldName: string, defaultValue: boolean): void;
+    /**
+     * Validates if the field is an array.
+     *
+     * @param fieldName - The name of the field to validate.
+     * @param defaultValue - The default value to set if validation fails.
+     */
     array(fieldName: string, defaultValue: unknown[]): void;
     /**
      * Checks if the provided field path is valid. In other words, if the
@@ -37,10 +92,30 @@ export default class Validate {
      * The idea is that if the field path is invalid, then this class will
      * not report an error, because it is assumed that the parent of the field
      * path will report the error.
+     *
+     * @param fieldName - The name of the field to check.
+     * @returns boolean - True if the field path is valid, false otherwise.
      */
     private fieldPathIsValid;
+    /**
+     * Updates the field with the provided default value.
+     *
+     * @param fieldName - The name of the field to update.
+     * @param defaultValue - The default value to set.
+     */
     private updateField;
+    /**
+     * Retrieves the value of the field.
+     *
+     * @param fieldName - The name of the field to retrieve.
+     * @returns unknown - The value of the field.
+     */
     private getField;
+    /**
+     * Deletes the field from the parent object.
+     *
+     * @param fieldName - The name of the field to delete.
+     */
     private deleteField;
 }
 export {};

package/lib/schemas/validators/ValidateUtil.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ValidateUtil.d.ts","sourceRoot":"./src/","sources":["schemas/validators/ValidateUtil.ts"],"names":[],"mappings":"AAQA,KAAK,eAAe,GAAG;IAAE,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC;AAEtD;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,OAAO,OAAO,QAAQ;IAKzB,OAAO,CAAC,WAAW;IAJrB,YAAY,EAAE,eAAe,CAAC;gBAG5B,YAAY,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,EAAE;IAK/B,cAAc,CAAC,SAAS,EAAE,MAAM;IAUhC,cAAc,CAAC,SAAS,EAAE,MAAM;IAUhC,eAAe,CAAC,SAAS,EAAE,MAAM;IAUjC,aAAa,CAAC,SAAS,EAAE,MAAM;IAU/B,cAAc,CAAC,SAAS,EAAE,MAAM;IAUhC,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAU9C,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAW9C,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAU9C,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO;IAUhD,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE;IAUhD;;;;;;;;;OASG;IACH,OAAO,CAAC,gBAAgB;IAexB,OAAO,CAAC,WAAW;IAYnB,OAAO,CAAC,QAAQ;IAShB,OAAO,CAAC,WAAW;CAYpB"}
+{"version":3,"file":"ValidateUtil.d.ts","sourceRoot":"./src/","sources":["schemas/validators/ValidateUtil.ts"],"names":[],"mappings":"AAQA,KAAK,eAAe,GAAG;IAAE,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAA;CAAE,CAAC;AAEtD;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,OAAO,OAAO,QAAQ;IAKzB,OAAO,CAAC,WAAW;IAJrB,YAAY,EAAE,eAAe,CAAC;gBAG5B,YAAY,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,EAAE;IAK/B;;;;OAIG;IACH,cAAc,CAAC,SAAS,EAAE,MAAM;IAUhC;;;;OAIG;IACH,cAAc,CAAC,SAAS,EAAE,MAAM;IAUhC;;;;OAIG;IACH,eAAe,CAAC,SAAS,EAAE,MAAM;IAUjC;;;;OAIG;IACH,aAAa,CAAC,SAAS,EAAE,MAAM;IAU/B;;;;OAIG;IACH,cAAc,CAAC,SAAS,EAAE,MAAM;IAUhC;;;;;OAKG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAU9C;;;;;OAKG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAW9C;;;;;OAKG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAU9C;;;;;OAKG;IACH,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO;IAUhD;;;;;OAKG;IACH,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,OAAO,EAAE;IAUhD;;;;;;;;;;;;OAYG;IACH,OAAO,CAAC,gBAAgB;IAexB;;;;;OAKG;IACH,OAAO,CAAC,WAAW;IAYnB;;;;;OAKG;IACH,OAAO,CAAC,QAAQ;IAShB;;;;OAIG;IACH,OAAO,CAAC,WAAW;CAYpB"}

package/lib/schemas/validators/ValidateUtil.js

@@ -19,6 +19,11 @@ export default class Validate {
         this.errorsArray = errorsArray;
         this.parentObject = parentObject;
     }
+    /**
+     * Validates if the field is an optional string.
+     *
+     * @param fieldName - The name of the field to validate.
+     */
     optionalString(fieldName) {
         if (this.fieldPathIsValid(fieldName) &&
             !isOptionalString(this.getField(fieldName))) {
@@ -26,6 +31,11 @@ export default class Validate {
             this.deleteField(fieldName);
         }
     }
+    /**
+     * Validates if the field is an optional number.
+     *
+     * @param fieldName - The name of the field to validate.
+     */
     optionalNumber(fieldName) {
         if (this.fieldPathIsValid(fieldName) &&
             !isOptionalNumber(this.getField(fieldName))) {
@@ -33,6 +43,11 @@ export default class Validate {
             this.deleteField(fieldName);
         }
     }
+    /**
+     * Validates if the field is an optional boolean.
+     *
+     * @param fieldName - The name of the field to validate.
+     */
     optionalBoolean(fieldName) {
         if (this.fieldPathIsValid(fieldName) &&
             !isOptionalBoolean(this.getField(fieldName))) {
@@ -40,6 +55,11 @@ export default class Validate {
             this.deleteField(fieldName);
         }
     }
+    /**
+     * Validates if the field is an optional array.
+     *
+     * @param fieldName - The name of the field to validate.
+     */
     optionalArray(fieldName) {
         if (this.fieldPathIsValid(fieldName) &&
             !isOptionalArray(this.getField(fieldName))) {
@@ -47,6 +67,11 @@ export default class Validate {
             this.deleteField(fieldName);
         }
     }
+    /**
+     * Validates if the field is an optional object.
+     *
+     * @param fieldName - The name of the field to validate.
+     */
     optionalObject(fieldName) {
         if (this.fieldPathIsValid(fieldName) &&
             !isOptionalObject(this.getField(fieldName))) {
@@ -54,6 +79,12 @@ export default class Validate {
             this.deleteField(fieldName);
         }
     }
+    /**
+     * Validates if the field is a string.
+     *
+     * @param fieldName - The name of the field to validate.
+     * @param defaultValue - The default value to set if validation fails.
+     */
     string(fieldName, defaultValue) {
         if (this.fieldPathIsValid(fieldName) &&
             typeof this.getField(fieldName) !== 'string') {
@@ -61,6 +92,12 @@ export default class Validate {
             this.updateField(fieldName, defaultValue);
         }
     }
+    /**
+     * Validates if the field is an object.
+     *
+     * @param fieldName - The name of the field to validate.
+     * @param defaultValue - The default value to set if validation fails.
+     */
     object(fieldName, defaultValue) {
         if (this.fieldPathIsValid(fieldName) &&
             (Array.isArray(this.getField(fieldName)) ||
@@ -69,6 +106,12 @@ export default class Validate {
             this.updateField(fieldName, defaultValue);
         }
     }
+    /**
+     * Validates if the field is a number.
+     *
+     * @param fieldName - The name of the field to validate.
+     * @param defaultValue - The default value to set if validation fails.
+     */
     number(fieldName, defaultValue) {
         if (this.fieldPathIsValid(fieldName) &&
             typeof this.getField(fieldName) !== 'number') {
@@ -76,6 +119,12 @@ export default class Validate {
             this.updateField(fieldName, defaultValue);
         }
     }
+    /**
+     * Validates if the field is a boolean.
+     *
+     * @param fieldName - The name of the field to validate.
+     * @param defaultValue - The default value to set if validation fails.
+     */
     boolean(fieldName, defaultValue) {
         if (this.fieldPathIsValid(fieldName) &&
             typeof this.getField(fieldName) !== 'boolean') {
@@ -83,6 +132,12 @@ export default class Validate {
             this.updateField(fieldName, defaultValue);
         }
     }
+    /**
+     * Validates if the field is an array.
+     *
+     * @param fieldName - The name of the field to validate.
+     * @param defaultValue - The default value to set if validation fails.
+     */
     array(fieldName, defaultValue) {
         if (this.fieldPathIsValid(fieldName) &&
             !Array.isArray(this.getField(fieldName))) {
@@ -99,6 +154,9 @@ export default class Validate {
      * The idea is that if the field path is invalid, then this class will
      * not report an error, because it is assumed that the parent of the field
      * path will report the error.
+     *
+     * @param fieldName - The name of the field to check.
+     * @returns boolean - True if the field path is valid, false otherwise.
      */
     fieldPathIsValid(fieldName) {
         const fieldPath = fieldName.split('.');
@@ -114,6 +172,12 @@ export default class Validate {
         }
         return true;
     }
+    /**
+     * Updates the field with the provided default value.
+     *
+     * @param fieldName - The name of the field to update.
+     * @param defaultValue - The default value to set.
+     */
     updateField(fieldName, defaultValue) {
         const fieldPath = fieldName.split('.');
         let currentObject = this.parentObject;
@@ -126,6 +190,12 @@ export default class Validate {
             }
         });
     }
+    /**
+     * Retrieves the value of the field.
+     *
+     * @param fieldName - The name of the field to retrieve.
+     * @returns unknown - The value of the field.
+     */
     getField(fieldName) {
         const fieldPath = fieldName.split('.');
         let currentObject = this.parentObject;
@@ -134,6 +204,11 @@ export default class Validate {
         });
         return currentObject;
     }
+    /**
+     * Deletes the field from the parent object.
+     *
+     * @param fieldName - The name of the field to delete.
+     */
     deleteField(fieldName) {
         const fieldPath = fieldName.split('.');
         let currentObject = this.parentObject;

package/lib/schemas/validators/ValidateUtil.js.map

@@ -1 +1 @@
-{"version":3,"file":"ValidateUtil.js","sourceRoot":"./src/","sources":["schemas/validators/ValidateUtil.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,iBAAiB,EACjB,gBAAgB,EAChB,gBAAgB,EAChB,gBAAgB,EACjB,MAAM,oCAAoC,CAAC;AAI5C;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,OAAO,OAAO,QAAQ;IAKjB;IAJV,YAAY,CAAkB;IAE9B,YACE,YAAoB,EACZ,WAAqB;QAArB,gBAAW,GAAX,WAAW,CAAU;QAE7B,IAAI,CAAC,YAAY,GAAG,YAA+B,CAAC;IACtD,CAAC;IAED,cAAc,CAAC,SAAiB;QAC9B,IACE,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;YAChC,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,EAC3C,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,SAAS,gCAAgC,CAAC,CAAC;YACpE,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAED,cAAc,CAAC,SAAiB;QAC9B,IACE,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;YAChC,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,EAC3C,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,SAAS,gCAAgC,CAAC,CAAC;YACpE,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAED,eAAe,CAAC,SAAiB;QAC/B,IACE,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;YAChC,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,EAC5C,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,SAAS,iCAAiC,CAAC,CAAC;YACrE,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAED,aAAa,CAAC,SAAiB;QAC7B,IACE,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;YAChC,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,EAC1C,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,SAAS,gCAAgC,CAAC,CAAC;YACpE,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAED,cAAc,CAAC,SAAiB;QAC9B,IACE,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;YAChC,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,EAC3C,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,SAAS,iCAAiC,CAAC,CAAC;YACrE,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAED,MAAM,CAAC,SAAiB,EAAE,YAAoB;QAC5C,IACE,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;YAChC,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,QAAQ,EAC5C,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,SAAS,mBAAmB,CAAC,CAAC;YACvD,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAED,MAAM,CAAC,SAAiB,EAAE,YAAoB;QAC5C,IACE,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;YAChC,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;gBACtC,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,QAAQ,CAAC,EAC/C,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,SAAS,oBAAoB,CAAC,CAAC;YACxD,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAED,MAAM,CAAC,SAAiB,EAAE,YAAoB;QAC5C,IACE,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;YAChC,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,QAAQ,EAC5C,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,SAAS,mBAAmB,CAAC,CAAC;YACvD,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAED,OAAO,CAAC,SAAiB,EAAE,YAAqB;QAC9C,IACE,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;YAChC,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,SAAS,EAC7C,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,SAAS,oBAAoB,CAAC,CAAC;YACxD,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAED,KAAK,CAAC,SAAiB,EAAE,YAAuB;QAC9C,IACE,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;YAChC,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,EACxC,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,SAAS,mBAAmB,CAAC,CAAC;YACvD,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAED;;;;;;;;;OASG;IACK,gBAAgB,CAAC,SAAiB;QACxC,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACvC,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3B,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,aAAa,GAAG,IAAI,CAAC,YAAY,CAAC;QACtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YACjD,IAAI,OAAO,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;gBACpD,OAAO,KAAK,CAAC;YACf,CAAC;YACD,aAAa,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAoB,CAAC;QACjE,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,WAAW,CAAC,SAAiB,EAAE,YAAqB;QAC1D,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACvC,IAAI,aAAa,GAAG,IAAI,CAAC,YAAY,CAAC;QACtC,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YACjC,IAAI,KAAK,KAAK,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACnC,aAAa,CAAC,KAAK,CAAC,GAAG,YAAY,CAAC;YACtC,CAAC;iBAAM,CAAC;gBACN,aAAa,GAAG,aAAa,CAAC,KAAK,CAAoB,CAAC;YAC1D,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,QAAQ,CAAC,SAAiB;QAChC,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACvC,IAAI,aAAa,GAAG,IAAI,CAAC,YAAY,CAAC;QACtC,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC1B,aAAa,GAAG,aAAa,CAAC,KAAK,CAAoB,CAAC;QAC1D,CAAC,CAAC,CAAC;QACH,OAAO,aAAa,CAAC;IACvB,CAAC;IAEO,WAAW,CAAC,SAAiB;QACnC,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACvC,IAAI,aAAa,GAAG,IAAI,CAAC,YAAY,CAAC;QACtC,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YACjC,IAAI,KAAK,KAAK,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACnC,gEAAgE;gBAChE,OAAO,aAAa,CAAC,KAAK,CAAC,CAAC;YAC9B,CAAC;iBAAM,CAAC;gBACN,aAAa,GAAG,aAAa,CAAC,KAAK,CAAoB,CAAC;YAC1D,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF"}
+{"version":3,"file":"ValidateUtil.js","sourceRoot":"./src/","sources":["schemas/validators/ValidateUtil.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,iBAAiB,EACjB,gBAAgB,EAChB,gBAAgB,EAChB,gBAAgB,EACjB,MAAM,oCAAoC,CAAC;AAI5C;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,OAAO,OAAO,QAAQ;IAKjB;IAJV,YAAY,CAAkB;IAE9B,YACE,YAAoB,EACZ,WAAqB;QAArB,gBAAW,GAAX,WAAW,CAAU;QAE7B,IAAI,CAAC,YAAY,GAAG,YAA+B,CAAC;IACtD,CAAC;IAED;;;;OAIG;IACH,cAAc,CAAC,SAAiB;QAC9B,IACE,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;YAChC,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,EAC3C,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,SAAS,gCAAgC,CAAC,CAAC;YACpE,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,cAAc,CAAC,SAAiB;QAC9B,IACE,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;YAChC,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,EAC3C,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,SAAS,gCAAgC,CAAC,CAAC;YACpE,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,eAAe,CAAC,SAAiB;QAC/B,IACE,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;YAChC,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,EAC5C,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,SAAS,iCAAiC,CAAC,CAAC;YACrE,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAC,SAAiB;QAC7B,IACE,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;YAChC,CAAC,eAAe,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,EAC1C,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,SAAS,gCAAgC,CAAC,CAAC;YACpE,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,cAAc,CAAC,SAAiB;QAC9B,IACE,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;YAChC,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,EAC3C,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,SAAS,iCAAiC,CAAC,CAAC;YACrE,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,SAAiB,EAAE,YAAoB;QAC5C,IACE,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;YAChC,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,QAAQ,EAC5C,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,SAAS,mBAAmB,CAAC,CAAC;YACvD,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,SAAiB,EAAE,YAAoB;QAC5C,IACE,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;YAChC,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;gBACtC,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,QAAQ,CAAC,EAC/C,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,SAAS,oBAAoB,CAAC,CAAC;YACxD,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,SAAiB,EAAE,YAAoB;QAC5C,IACE,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;YAChC,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,QAAQ,EAC5C,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,SAAS,mBAAmB,CAAC,CAAC;YACvD,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,OAAO,CAAC,SAAiB,EAAE,YAAqB;QAC9C,IACE,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;YAChC,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,KAAK,SAAS,EAC7C,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,SAAS,oBAAoB,CAAC,CAAC;YACxD,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,SAAiB,EAAE,YAAuB;QAC9C,IACE,IAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC;YAChC,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC,EACxC,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,SAAS,mBAAmB,CAAC,CAAC;YACvD,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;OAYG;IACK,gBAAgB,CAAC,SAAiB;QACxC,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACvC,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC3B,OAAO,IAAI,CAAC;QACd,CAAC;QACD,IAAI,aAAa,GAAG,IAAI,CAAC,YAAY,CAAC;QACtC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;YACjD,IAAI,OAAO,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;gBACpD,OAAO,KAAK,CAAC;YACf,CAAC;YACD,aAAa,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC,CAAC,CAAoB,CAAC;QACjE,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACK,WAAW,CAAC,SAAiB,EAAE,YAAqB;QAC1D,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACvC,IAAI,aAAa,GAAG,IAAI,CAAC,YAAY,CAAC;QACtC,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YACjC,IAAI,KAAK,KAAK,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACnC,aAAa,CAAC,KAAK,CAAC,GAAG,YAAY,CAAC;YACtC,CAAC;iBAAM,CAAC;gBACN,aAAa,GAAG,aAAa,CAAC,KAAK,CAAoB,CAAC;YAC1D,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACK,QAAQ,CAAC,SAAiB;QAChC,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACvC,IAAI,aAAa,GAAG,IAAI,CAAC,YAAY,CAAC;QACtC,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE;YAC1B,aAAa,GAAG,aAAa,CAAC,KAAK,CAAoB,CAAC;QAC1D,CAAC,CAAC,CAAC;QACH,OAAO,aAAa,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACK,WAAW,CAAC,SAAiB;QACnC,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACvC,IAAI,aAAa,GAAG,IAAI,CAAC,YAAY,CAAC;QACtC,SAAS,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE;YACjC,IAAI,KAAK,KAAK,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACnC,gEAAgE;gBAChE,OAAO,aAAa,CAAC,KAAK,CAAC,CAAC;YAC9B,CAAC;iBAAM,CAAC;gBACN,aAAa,GAAG,aAAa,CAAC,KAAK,CAAoB,CAAC;YAC1D,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC;CACF"}

package/lib/schemas/validators/ValidateUtil.ts

@@ -31,6 +31,11 @@ export default class Validate {
     this.parentObject = parentObject as IndexableObject;
   }
 
+  /**
+   * Validates if the field is an optional string.
+   *
+   * @param fieldName - The name of the field to validate.
+   */
   optionalString(fieldName: string) {
     if (
       this.fieldPathIsValid(fieldName) &&
@@ -41,6 +46,11 @@ export default class Validate {
     }
   }
 
+  /**
+   * Validates if the field is an optional number.
+   *
+   * @param fieldName - The name of the field to validate.
+   */
   optionalNumber(fieldName: string) {
     if (
       this.fieldPathIsValid(fieldName) &&
@@ -51,6 +61,11 @@ export default class Validate {
     }
   }
 
+  /**
+   * Validates if the field is an optional boolean.
+   *
+   * @param fieldName - The name of the field to validate.
+   */
   optionalBoolean(fieldName: string) {
     if (
       this.fieldPathIsValid(fieldName) &&
@@ -61,6 +76,11 @@ export default class Validate {
     }
   }
 
+  /**
+   * Validates if the field is an optional array.
+   *
+   * @param fieldName - The name of the field to validate.
+   */
   optionalArray(fieldName: string) {
     if (
       this.fieldPathIsValid(fieldName) &&
@@ -71,6 +91,11 @@ export default class Validate {
     }
   }
 
+  /**
+   * Validates if the field is an optional object.
+   *
+   * @param fieldName - The name of the field to validate.
+   */
   optionalObject(fieldName: string) {
     if (
       this.fieldPathIsValid(fieldName) &&
@@ -81,6 +106,12 @@ export default class Validate {
     }
   }
 
+  /**
+   * Validates if the field is a string.
+   *
+   * @param fieldName - The name of the field to validate.
+   * @param defaultValue - The default value to set if validation fails.
+   */
   string(fieldName: string, defaultValue: string) {
     if (
       this.fieldPathIsValid(fieldName) &&
@@ -91,6 +122,12 @@ export default class Validate {
     }
   }
 
+  /**
+   * Validates if the field is an object.
+   *
+   * @param fieldName - The name of the field to validate.
+   * @param defaultValue - The default value to set if validation fails.
+   */
   object(fieldName: string, defaultValue: object) {
     if (
       this.fieldPathIsValid(fieldName) &&
@@ -102,6 +139,12 @@ export default class Validate {
     }
   }
 
+  /**
+   * Validates if the field is a number.
+   *
+   * @param fieldName - The name of the field to validate.
+   * @param defaultValue - The default value to set if validation fails.
+   */
   number(fieldName: string, defaultValue: number) {
     if (
       this.fieldPathIsValid(fieldName) &&
@@ -112,6 +155,12 @@ export default class Validate {
     }
   }
 
+  /**
+   * Validates if the field is a boolean.
+   *
+   * @param fieldName - The name of the field to validate.
+   * @param defaultValue - The default value to set if validation fails.
+   */
   boolean(fieldName: string, defaultValue: boolean) {
     if (
       this.fieldPathIsValid(fieldName) &&
@@ -122,6 +171,12 @@ export default class Validate {
     }
   }
 
+  /**
+   * Validates if the field is an array.
+   *
+   * @param fieldName - The name of the field to validate.
+   * @param defaultValue - The default value to set if validation fails.
+   */
   array(fieldName: string, defaultValue: unknown[]) {
     if (
       this.fieldPathIsValid(fieldName) &&
@@ -141,6 +196,9 @@ export default class Validate {
    * The idea is that if the field path is invalid, then this class will
    * not report an error, because it is assumed that the parent of the field
    * path will report the error.
+   *
+   * @param fieldName - The name of the field to check.
+   * @returns boolean - True if the field path is valid, false otherwise.
    */
   private fieldPathIsValid(fieldName: string): boolean {
     const fieldPath = fieldName.split('.');
@@ -157,6 +215,12 @@ export default class Validate {
     return true;
   }
 
+  /**
+   * Updates the field with the provided default value.
+   *
+   * @param fieldName - The name of the field to update.
+   * @param defaultValue - The default value to set.
+   */
   private updateField(fieldName: string, defaultValue: unknown) {
     const fieldPath = fieldName.split('.');
     let currentObject = this.parentObject;
@@ -169,6 +233,12 @@ export default class Validate {
     });
   }
 
+  /**
+   * Retrieves the value of the field.
+   *
+   * @param fieldName - The name of the field to retrieve.
+   * @returns unknown - The value of the field.
+   */
   private getField(fieldName: string): unknown {
     const fieldPath = fieldName.split('.');
     let currentObject = this.parentObject;
@@ -178,6 +248,11 @@ export default class Validate {
     return currentObject;
   }
 
+  /**
+   * Deletes the field from the parent object.
+   *
+   * @param fieldName - The name of the field to delete.
+   */
   private deleteField(fieldName: string) {
     const fieldPath = fieldName.split('.');
     let currentObject = this.parentObject;

package/lib/services/dashboard/Task/TaskFilterService.d.ts

@@ -13,7 +13,7 @@ export type DashboardTaskFilterResult = {
     removedIds: string[];
 };
 /**
- * A service responsible for filtering
+ * A service responsible for filtering tasks based on provided settings.
  */
 export default class DashboardTaskFilterService {
     /**
@@ -23,10 +23,16 @@ export default class DashboardTaskFilterService {
      * cases, then the less common or more heavy cases later on to increase
      * performance.
      *
-     * @param taskMap the map of tasks to use for filtering. This is used so that
+     * @param taskMap - The map of tasks to use for filtering. This is used so that
      * the task map doesn't need to be generated multiple times.
-     * @param parentTaskId determines if the current list is for a parent task
-     * or not
+     * @param taskIds - The IDs of the tasks to be filtered.
+     * @param settings - The filter settings to apply.
+     * @param category - The category to filter tasks by.
+     * @param parentTaskId - (Optional) Determines if the current list is for a parent task
+     * or not.
+     * @returns An object containing the IDs of the tasks that satisfy the filter settings
+     * (`resultIds`) and the IDs of the tasks that were filtered but still apply to the same
+     * category (`removedIds`).
      */
     static filter(taskMap: DashboardTaskMap, taskIds: string[], settings: DashboardTaskListFilterSettings, category: string, parentTaskId?: string): DashboardTaskFilterResult;
 }

package/lib/services/dashboard/Task/TaskFilterService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TaskFilterService.d.ts","sourceRoot":"./src/","sources":["services/dashboard/Task/TaskFilterService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,sCAAsC,CAAC;AACxE,OAAO,EAAE,+BAA+B,EAAE,MAAM,0DAA0D,CAAC;AAE3G,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB;;;;OAIG;IACH,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,0BAA0B;IAC7C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAAM,CACX,OAAO,EAAE,gBAAgB,EACzB,OAAO,EAAE,MAAM,EAAE,EACjB,QAAQ,EAAE,+BAA+B,EACzC,QAAQ,EAAE,MAAM,EAChB,YAAY,CAAC,EAAE,MAAM,GACpB,yBAAyB;CAkE7B"}
+{"version":3,"file":"TaskFilterService.d.ts","sourceRoot":"./src/","sources":["services/dashboard/Task/TaskFilterService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,sCAAsC,CAAC;AACxE,OAAO,EAAE,+BAA+B,EAAE,MAAM,0DAA0D,CAAC;AAE3G,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB;;;;OAIG;IACH,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,0BAA0B;IAC7C;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,MAAM,CACX,OAAO,EAAE,gBAAgB,EACzB,OAAO,EAAE,MAAM,EAAE,EACjB,QAAQ,EAAE,+BAA+B,EACzC,QAAQ,EAAE,MAAM,EAChB,YAAY,CAAC,EAAE,MAAM,GACpB,yBAAyB;CAkE7B"}

package/lib/services/dashboard/Task/TaskFilterService.js

@@ -1,5 +1,5 @@
 /**
- * A service responsible for filtering
+ * A service responsible for filtering tasks based on provided settings.
  */
 export default class DashboardTaskFilterService {
     /**
@@ -9,10 +9,16 @@ export default class DashboardTaskFilterService {
      * cases, then the less common or more heavy cases later on to increase
      * performance.
      *
-     * @param taskMap the map of tasks to use for filtering. This is used so that
+     * @param taskMap - The map of tasks to use for filtering. This is used so that
      * the task map doesn't need to be generated multiple times.
-     * @param parentTaskId determines if the current list is for a parent task
-     * or not
+     * @param taskIds - The IDs of the tasks to be filtered.
+     * @param settings - The filter settings to apply.
+     * @param category - The category to filter tasks by.
+     * @param parentTaskId - (Optional) Determines if the current list is for a parent task
+     * or not.
+     * @returns An object containing the IDs of the tasks that satisfy the filter settings
+     * (`resultIds`) and the IDs of the tasks that were filtered but still apply to the same
+     * category (`removedIds`).
      */
     static filter(taskMap, taskIds, settings, category, parentTaskId) {
         // The filtered IDs that apply to the category, and aren't grandchildren

package/lib/services/dashboard/Task/TaskFilterService.js.map

@@ -1 +1 @@
-{"version":3,"file":"TaskFilterService.js","sourceRoot":"./src/","sources":["services/dashboard/Task/TaskFilterService.ts"],"names":[],"mappings":"AAgBA;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,0BAA0B;IAC7C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,MAAM,CACX,OAAyB,EACzB,OAAiB,EACjB,QAAyC,EACzC,QAAgB,EAChB,YAAqB;QAErB,wEAAwE;QACxE,SAAS;QACT,MAAM,UAAU,GAAa,EAAE,CAAC;QAChC,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE;YAC1C,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;YAE7B,WAAW;YACX,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,QAAQ,KAAK,QAAQ;gBAAE,OAAO,KAAK,CAAC;YAEtD,cAAc;YACd,4CAA4C;YAC5C,IAAI,YAAY,EAAE,CAAC;gBACjB,IACE,CAAC,QAAQ,CAAC,kBAAkB,CAAC,IAAI;oBACjC,IAAI,CAAC,YAAY;oBACjB,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,KAAK,YAAY,EAC7C,CAAC;oBACD,OAAO,KAAK,CAAC;gBACf,CAAC;gBACD,0EAA0E;YAC5E,CAAC;iBAAM,IACL,CAAC,QAAQ,CAAC,kBAAkB,CAAC,IAAI;gBACjC,IAAI,CAAC,YAAY;gBACjB,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC,EACrC,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC;YAED,YAAY;YACZ,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;gBAC/C,OAAO,KAAK,CAAC;YACf,CAAC;YAED,aAAa;YACb,IACE,CAAC,QAAQ,CAAC,SAAS,CAAC,eAAe;gBACnC,IAAI,CAAC,SAAS;gBACd,IAAI,CAAC,SAAS,GAAG,IAAI,IAAI,EAAE,EAC3B,CAAC;gBACD,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACxB,OAAO,KAAK,CAAC;YACf,CAAC;YAED,OAAO;YACP,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACxC,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC5B,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE;oBACnC,IAAI,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;wBACnD,OAAO,IAAI,CAAC;oBACd,CAAC;oBACD,OAAO,KAAK,CAAC;gBACf,CAAC,CAAC,CAAC;gBACH,IAAI,UAAU,EAAE,CAAC;oBACf,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;oBACxB,OAAO,KAAK,CAAC;gBACf,CAAC;YACH,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QACH,OAAO;YACL,SAAS;YACT,UAAU;SACX,CAAC;IACJ,CAAC;CACF"}
+{"version":3,"file":"TaskFilterService.js","sourceRoot":"./src/","sources":["services/dashboard/Task/TaskFilterService.ts"],"names":[],"mappings":"AAgBA;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,0BAA0B;IAC7C;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,MAAM,CACX,OAAyB,EACzB,OAAiB,EACjB,QAAyC,EACzC,QAAgB,EAChB,YAAqB;QAErB,wEAAwE;QACxE,SAAS;QACT,MAAM,UAAU,GAAa,EAAE,CAAC;QAChC,MAAM,SAAS,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE;YAC1C,MAAM,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;YAE7B,WAAW;YACX,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,QAAQ,KAAK,QAAQ;gBAAE,OAAO,KAAK,CAAC;YAEtD,cAAc;YACd,4CAA4C;YAC5C,IAAI,YAAY,EAAE,CAAC;gBACjB,IACE,CAAC,QAAQ,CAAC,kBAAkB,CAAC,IAAI;oBACjC,IAAI,CAAC,YAAY;oBACjB,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,KAAK,YAAY,EAC7C,CAAC;oBACD,OAAO,KAAK,CAAC;gBACf,CAAC;gBACD,0EAA0E;YAC5E,CAAC;iBAAM,IACL,CAAC,QAAQ,CAAC,kBAAkB,CAAC,IAAI;gBACjC,IAAI,CAAC,YAAY;gBACjB,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC,EACrC,CAAC;gBACD,OAAO,KAAK,CAAC;YACf,CAAC;YAED,YAAY;YACZ,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;gBAC/C,OAAO,KAAK,CAAC;YACf,CAAC;YAED,aAAa;YACb,IACE,CAAC,QAAQ,CAAC,SAAS,CAAC,eAAe;gBACnC,IAAI,CAAC,SAAS;gBACd,IAAI,CAAC,SAAS,GAAG,IAAI,IAAI,EAAE,EAC3B,CAAC;gBACD,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBACxB,OAAO,KAAK,CAAC;YACf,CAAC;YAED,OAAO;YACP,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;YACxC,IAAI,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC5B,MAAM,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE;oBACnC,IAAI,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC;wBACnD,OAAO,IAAI,CAAC;oBACd,CAAC;oBACD,OAAO,KAAK,CAAC;gBACf,CAAC,CAAC,CAAC;gBACH,IAAI,UAAU,EAAE,CAAC;oBACf,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;oBACxB,OAAO,KAAK,CAAC;gBACf,CAAC;YACH,CAAC;YAED,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,CAAC;QACH,OAAO;YACL,SAAS;YACT,UAAU;SACX,CAAC;IACJ,CAAC;CACF"}

package/lib/services/dashboard/Task/TaskFilterService.ts

@@ -15,7 +15,7 @@ export type DashboardTaskFilterResult = {
 };
 
 /**
- * A service responsible for filtering
+ * A service responsible for filtering tasks based on provided settings.
  */
 export default class DashboardTaskFilterService {
   /**
@@ -25,10 +25,16 @@ export default class DashboardTaskFilterService {
    * cases, then the less common or more heavy cases later on to increase
    * performance.
    *
-   * @param taskMap the map of tasks to use for filtering. This is used so that
+   * @param taskMap - The map of tasks to use for filtering. This is used so that
    * the task map doesn't need to be generated multiple times.
-   * @param parentTaskId determines if the current list is for a parent task
-   * or not
+   * @param taskIds - The IDs of the tasks to be filtered.
+   * @param settings - The filter settings to apply.
+   * @param category - The category to filter tasks by.
+   * @param parentTaskId - (Optional) Determines if the current list is for a parent task
+   * or not.
+   * @returns An object containing the IDs of the tasks that satisfy the filter settings
+   * (`resultIds`) and the IDs of the tasks that were filtered but still apply to the same
+   * category (`removedIds`).
    */
   static filter(
     taskMap: DashboardTaskMap,

package/lib/services/dashboard/Task/TaskRecurrenceService.d.ts

@@ -2,8 +2,11 @@ import DashboardTask from '../../../documents/dashboard/Task.js';
 import { RecurrenceFrequency } from '../../../embedded-types/dashboard/task/RecurrenceInfo.js';
 export default class DashboardTaskRecurrenceService {
     /**
-     * Gets the next frequency date from the provided basis date. Returns null
-     * if the provided frequency is in an invalid state.
+     * Gets the next frequency date from the provided basis date.
+     *
+     * @param basisDate - The date from which to calculate the next frequency date.
+     * @param frequency - The recurrence frequency details.
+     * @returns The next frequency date or null if the frequency is in an invalid state.
      */
     static getNextFrequencyDate(basisDate: Date, frequency: RecurrenceFrequency): Date | null;
     /**
@@ -14,8 +17,17 @@ export default class DashboardTaskRecurrenceService {
      *
      * Makes no changes if the state of the task is invalid for recurrence or
      * there isn't recurrence info.
+     *
+     * @param task - The task whose dates need to be updated.
      */
     static updateDatesForRecurrence(task: DashboardTask): void;
+    /**
+     * Calculates the difference in time between the basis date and the next frequency date.
+     *
+     * @param basisDate - The date from which to calculate the difference.
+     * @param frequency - The recurrence frequency details.
+     * @returns The difference in time in milliseconds.
+     */
     private static getDiffForDateUpdate;
 }
 //# sourceMappingURL=TaskRecurrenceService.d.ts.map

package/lib/services/dashboard/Task/TaskRecurrenceService.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"TaskRecurrenceService.d.ts","sourceRoot":"./src/","sources":["services/dashboard/Task/TaskRecurrenceService.ts"],"names":[],"mappings":"AACA,OAAO,aAAa,MAAM,sCAAsC,CAAC;AACjE,OAAO,EAEL,mBAAmB,EAEpB,MAAM,0DAA0D,CAAC;AAElE,MAAM,CAAC,OAAO,OAAO,8BAA8B;IACjD;;;OAGG;IACH,MAAM,CAAC,oBAAoB,CAAC,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,mBAAmB;IAsE3E;;;;;;;;OAQG;IACH,MAAM,CAAC,wBAAwB,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI;IAkE1D,OAAO,CAAC,MAAM,CAAC,oBAAoB;CAapC"}
+{"version":3,"file":"TaskRecurrenceService.d.ts","sourceRoot":"./src/","sources":["services/dashboard/Task/TaskRecurrenceService.ts"],"names":[],"mappings":"AACA,OAAO,aAAa,MAAM,sCAAsC,CAAC;AACjE,OAAO,EAEL,mBAAmB,EAEpB,MAAM,0DAA0D,CAAC;AAElE,MAAM,CAAC,OAAO,OAAO,8BAA8B;IACjD;;;;;;OAMG;IACH,MAAM,CAAC,oBAAoB,CACzB,SAAS,EAAE,IAAI,EACf,SAAS,EAAE,mBAAmB,GAC7B,IAAI,GAAG,IAAI;IAsEd;;;;;;;;;;OAUG;IACH,MAAM,CAAC,wBAAwB,CAAC,IAAI,EAAE,aAAa,GAAG,IAAI;IAkE1D;;;;;;OAMG;IACH,OAAO,CAAC,MAAM,CAAC,oBAAoB;CAapC"}

package/lib/services/dashboard/Task/TaskRecurrenceService.js

@@ -2,8 +2,11 @@ import { DateService } from '@aneuhold/core-ts-lib';
 import { RecurrenceBasis, RecurrenceFrequencyType } from '../../../embedded-types/dashboard/task/RecurrenceInfo.js';
 export default class DashboardTaskRecurrenceService {
     /**
-     * Gets the next frequency date from the provided basis date. Returns null
-     * if the provided frequency is in an invalid state.
+     * Gets the next frequency date from the provided basis date.
+     *
+     * @param basisDate - The date from which to calculate the next frequency date.
+     * @param frequency - The recurrence frequency details.
+     * @returns The next frequency date or null if the frequency is in an invalid state.
      */
     static getNextFrequencyDate(basisDate, frequency) {
         // Last day of month
@@ -72,6 +75,8 @@ export default class DashboardTaskRecurrenceService {
      *
      * Makes no changes if the state of the task is invalid for recurrence or
      * there isn't recurrence info.
+     *
+     * @param task - The task whose dates need to be updated.
      */
     static updateDatesForRecurrence(task) {
         // Initial basic validation
@@ -122,6 +127,13 @@ export default class DashboardTaskRecurrenceService {
             task.dueDate = new Date(task.dueDate.getTime() + diff);
         }
     }
+    /**
+     * Calculates the difference in time between the basis date and the next frequency date.
+     *
+     * @param basisDate - The date from which to calculate the difference.
+     * @param frequency - The recurrence frequency details.
+     * @returns The difference in time in milliseconds.
+     */
     static getDiffForDateUpdate(basisDate, frequency) {
         if (!basisDate) {
             return 0;