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

package/lib/documents/common/ApiKey.d.ts

@@ -19,6 +19,8 @@ export default class ApiKey extends BaseDocument implements RequiredUserId {
     userId: ObjectId;
     /**
      * Constructs a new {@link ApiKey} for the provided user.
+     *
+     * @param userId - The ID of the user.
      */
     constructor(userId: ObjectId);
 }

package/lib/documents/common/ApiKey.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ApiKey.d.ts","sourceRoot":"./src/","sources":["documents/common/ApiKey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAe,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,cAAc,MAAM,+CAA+C,CAAC;AAC3E,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAElF,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAE9C,eAAO,MAAM,cAAc,EAAE,iBAAiB,CAAC,MAAM,CAQpD,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,YAAa,YAAW,cAAc;IACxE;;OAEG;IACH,GAAG,EAAE,IAAI,CAAuB;IAEhC;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;OAEG;gBACS,MAAM,EAAE,QAAQ;CAI7B"}
+{"version":3,"file":"ApiKey.d.ts","sourceRoot":"./src/","sources":["documents/common/ApiKey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAe,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AACtC,OAAO,cAAc,MAAM,+CAA+C,CAAC;AAC3E,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAElF,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAE9C,eAAO,MAAM,cAAc,EAAE,iBAAiB,CAAC,MAAM,CAQpD,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,YAAa,YAAW,cAAc;IACxE;;OAEG;IACH,GAAG,EAAE,IAAI,CAAuB;IAEhC;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;;;OAIG;gBACS,MAAM,EAAE,QAAQ;CAI7B"}

package/lib/documents/common/ApiKey.js

@@ -24,6 +24,8 @@ export default class ApiKey extends BaseDocument {
     userId;
     /**
      * Constructs a new {@link ApiKey} for the provided user.
+     *
+     * @param userId - The ID of the user.
      */
     constructor(userId) {
         super();

package/lib/documents/common/ApiKey.js.map

@@ -1 +1 @@
-{"version":3,"file":"ApiKey.js","sourceRoot":"./src/","sources":["documents/common/ApiKey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,MAAgB,MAAM,QAAQ,CAAC;AAGtC,OAAO,QAAQ,MAAM,0CAA0C,CAAC;AAChE,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAE9C,MAAM,CAAC,MAAM,cAAc,GAA8B,CAAC,MAAc,EAAE,EAAE;IAC1E,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,aAAa,GAAG,IAAI,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC,CAAC;IACjD,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAE9C,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC;IAE1C,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;AACxC,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,YAAY;IAC9C;;OAEG;IACH,GAAG,GAAS,MAAM,CAAC,UAAU,EAAE,CAAC;IAEhC;;OAEG;IACH,MAAM,CAAW;IAEjB;;OAEG;IACH,YAAY,MAAgB;QAC1B,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF"}
+{"version":3,"file":"ApiKey.js","sourceRoot":"./src/","sources":["documents/common/ApiKey.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,MAAgB,MAAM,QAAQ,CAAC;AAGtC,OAAO,QAAQ,MAAM,0CAA0C,CAAC;AAChE,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAE9C,MAAM,CAAC,MAAM,cAAc,GAA8B,CAAC,MAAc,EAAE,EAAE;IAC1E,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,aAAa,GAAG,IAAI,MAAM,CAAC,IAAI,QAAQ,EAAE,CAAC,CAAC;IACjD,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAE9C,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC;IAE1C,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC;AACxC,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,MAAO,SAAQ,YAAY;IAC9C;;OAEG;IACH,GAAG,GAAS,MAAM,CAAC,UAAU,EAAE,CAAC;IAEhC;;OAEG;IACH,MAAM,CAAW;IAEjB;;;;OAIG;IACH,YAAY,MAAgB;QAC1B,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;CACF"}

package/lib/documents/common/ApiKey.ts

@@ -32,6 +32,8 @@ export default class ApiKey extends BaseDocument implements RequiredUserId {
 
   /**
    * Constructs a new {@link ApiKey} for the provided user.
+   *
+   * @param userId - The ID of the user.
    */
   constructor(userId: ObjectId) {
     super();

package/lib/documents/common/User.d.ts

@@ -9,6 +9,12 @@ export type UserCTO = {
     _id: ObjectId;
     userName: string;
 };
+/**
+ * Validates a User document.
+ *
+ * @param user - The user document to validate.
+ * @returns An object containing the updated user document and an array of error messages, if any.
+ */
 export declare const validateUser: DocumentValidator<User>;
 /**
  * A standard user of all personal projects. This should be linked to from
@@ -28,6 +34,8 @@ export default class User extends BaseDocument {
     };
     /**
      * Constructs a new {@link User} with default values.
+     *
+     * @param userName - The username of the user.
      */
     constructor(userName: string);
 }

package/lib/documents/common/User.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"User.d.ts","sourceRoot":"./src/","sources":["documents/common/User.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAElF,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAE9C;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,GAAG,EAAE,QAAQ,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,eAAO,MAAM,YAAY,EAAE,iBAAiB,CAAC,IAAI,CAkBhD,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,YAAY;IAC5C,GAAG,EAAE,QAAQ,CAAkB;IAE/B,QAAQ,EAAE,MAAM,CAAC;IAEjB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE;QACJ,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAM;IAEP,aAAa;;MAEX;IAEF;;OAEG;gBACS,QAAQ,EAAE,MAAM;CAI7B"}
+{"version":3,"file":"User.d.ts","sourceRoot":"./src/","sources":["documents/common/User.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAElF,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAE9C;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,GAAG,EAAE,QAAQ,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,YAAY,EAAE,iBAAiB,CAAC,IAAI,CAkBhD,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,YAAY;IAC5C,GAAG,EAAE,QAAQ,CAAkB;IAE/B,QAAQ,EAAE,MAAM,CAAC;IAEjB,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,IAAI,EAAE;QACJ,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB,CAAM;IAEP,aAAa;;MAEX;IAEF;;;;OAIG;gBACS,QAAQ,EAAE,MAAM;CAI7B"}

package/lib/documents/common/User.js

@@ -1,6 +1,12 @@
 import { ObjectId } from 'bson';
 import Validate from '../../schemas/validators/ValidateUtil.js';
 import BaseDocument from '../BaseDocument.js';
+/**
+ * Validates a User document.
+ *
+ * @param user - The user document to validate.
+ * @returns An object containing the updated user document and an array of error messages, if any.
+ */
 export const validateUser = (user) => {
     const errors = [];
     const validate = new Validate(user, errors);
@@ -30,6 +36,8 @@ export default class User extends BaseDocument {
     };
     /**
      * Constructs a new {@link User} with default values.
+     *
+     * @param userName - The username of the user.
      */
     constructor(userName) {
         super();

package/lib/documents/common/User.js.map

@@ -1 +1 @@
-{"version":3,"file":"User.js","sourceRoot":"./src/","sources":["documents/common/User.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAEhC,OAAO,QAAQ,MAAM,0CAA0C,CAAC;AAChE,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAW9C,MAAM,CAAC,MAAM,YAAY,GAA4B,CAAC,IAAI,EAAE,EAAE;IAC5D,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC5C,MAAM,WAAW,GAAG,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC;IAExC,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;IAC/C,QAAQ,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IACpC,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACjC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC;IAC1C,QAAQ,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;IACzC,QAAQ,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;IACzC,QAAQ,CAAC,MAAM,CAAC,eAAe,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;IAC5D,QAAQ,CAAC,OAAO,CACd,yBAAyB,EACzB,WAAW,CAAC,aAAa,CAAC,SAAS,CACpC,CAAC;IAEF,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AACtC,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,YAAY;IAC5C,GAAG,GAAa,IAAI,QAAQ,EAAE,CAAC;IAE/B,QAAQ,CAAS;IAEjB,KAAK,CAAU;IAEf,IAAI,GAGA,EAAE,CAAC;IAEP,aAAa,GAAG;QACd,SAAS,EAAE,IAAI;KAChB,CAAC;IAEF;;OAEG;IACH,YAAY,QAAgB;QAC1B,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;CACF"}
+{"version":3,"file":"User.js","sourceRoot":"./src/","sources":["documents/common/User.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAEhC,OAAO,QAAQ,MAAM,0CAA0C,CAAC;AAChE,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAW9C;;;;;GAKG;AACH,MAAM,CAAC,MAAM,YAAY,GAA4B,CAAC,IAAI,EAAE,EAAE;IAC5D,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC5C,MAAM,WAAW,GAAG,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC;IAExC,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE,iBAAiB,CAAC,CAAC;IAC/C,QAAQ,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;IACpC,QAAQ,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACjC,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC;IAC1C,QAAQ,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;IACzC,QAAQ,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;IACzC,QAAQ,CAAC,MAAM,CAAC,eAAe,EAAE,WAAW,CAAC,aAAa,CAAC,CAAC;IAC5D,QAAQ,CAAC,OAAO,CACd,yBAAyB,EACzB,WAAW,CAAC,aAAa,CAAC,SAAS,CACpC,CAAC;IAEF,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AACtC,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,OAAO,OAAO,IAAK,SAAQ,YAAY;IAC5C,GAAG,GAAa,IAAI,QAAQ,EAAE,CAAC;IAE/B,QAAQ,CAAS;IAEjB,KAAK,CAAU;IAEf,IAAI,GAGA,EAAE,CAAC;IAEP,aAAa,GAAG;QACd,SAAS,EAAE,IAAI;KAChB,CAAC;IAEF;;;;OAIG;IACH,YAAY,QAAgB;QAC1B,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;IAC3B,CAAC;CACF"}

package/lib/documents/common/User.ts

@@ -12,6 +12,12 @@ export type UserCTO = {
   userName: string;
 };
 
+/**
+ * Validates a User document.
+ *
+ * @param user - The user document to validate.
+ * @returns An object containing the updated user document and an array of error messages, if any.
+ */
 export const validateUser: DocumentValidator<User> = (user) => {
   const errors: string[] = [];
   const validate = new Validate(user, errors);
@@ -55,6 +61,8 @@ export default class User extends BaseDocument {
 
   /**
    * Constructs a new {@link User} with default values.
+   *
+   * @param userName - The username of the user.
    */
   constructor(userName: string) {
     super();

package/lib/documents/dashboard/Task.d.ts

@@ -67,6 +67,9 @@ export default class DashboardTask extends BaseDocumentWithType implements Requi
      * same as the parent recurring task.
      */
     parentRecurringTaskInfo?: ParentRecurringTaskInfo;
+    /**
+     * The title of the task.
+     */
     title: string;
     completed: boolean;
     /**

package/lib/documents/dashboard/Task.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Task.d.ts","sourceRoot":"./src/","sources":["documents/dashboard/Task.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,EAAE,2BAA2B,EAAE,MAAM,uDAAuD,CAAC;AACpG,OAAO,EACL,uBAAuB,EACvB,cAAc,EAEf,MAAM,uDAAuD,CAAC;AAC/D,OAAO,EAAE,yBAAyB,EAAE,MAAM,qDAAqD,CAAC;AAChG,OAAO,cAAc,MAAM,+CAA+C,CAAC;AAC3E,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAElF,OAAO,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AAChE,OAAO,oBAAoB,MAAM,4BAA4B,CAAC;AAE9D,eAAO,MAAM,qBAAqB,EAAE,iBAAiB,CAAC,aAAa,CAwBlE,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,OAAO,OAAO,aACnB,SAAQ,oBACR,YAAW,cAAc;IAEzB,MAAM,CAAC,OAAO,SAAU;IAExB,OAAO,SAAyB;IAEhC;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;;;;;;;;;;OAWG;IACH,UAAU,EAAE,QAAQ,EAAE,CAAM;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,QAAQ,CAAC;IAEtB;;OAEG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;IAEhC;;;;;OAKG;IACH,uBAAuB,CAAC,EAAE,uBAAuB,CAAC;IAElD,KAAK,SAAM;IAEX,SAAS,UAAS;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,QAAQ,CAAC;IAExB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,EAAE,IAAI,CAAc;IAE/B;;OAEG;IACH,eAAe,EAAE,IAAI,CAAc;IAEnC,SAAS,CAAC,EAAE,IAAI,CAAC;IAEjB,OAAO,CAAC,EAAE,IAAI,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE;QAAE,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAA;KAAE,CAAM;IAEtD;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAa;IAE7B;;;OAGG;IACH,cAAc,EAAE,2BAA2B,CAAM;IAEjD;;;OAGG;IACH,YAAY,EAAE,yBAAyB,CAAM;gBAEjC,OAAO,EAAE,QAAQ;CAO9B"}
+{"version":3,"file":"Task.d.ts","sourceRoot":"./src/","sources":["documents/dashboard/Task.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,EAAE,2BAA2B,EAAE,MAAM,uDAAuD,CAAC;AACpG,OAAO,EACL,uBAAuB,EACvB,cAAc,EAEf,MAAM,uDAAuD,CAAC;AAC/D,OAAO,EAAE,yBAAyB,EAAE,MAAM,qDAAqD,CAAC;AAChG,OAAO,cAAc,MAAM,+CAA+C,CAAC;AAC3E,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAElF,OAAO,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AAChE,OAAO,oBAAoB,MAAM,4BAA4B,CAAC;AAE9D,eAAO,MAAM,qBAAqB,EAAE,iBAAiB,CAAC,aAAa,CAwBlE,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,WAAW,CAAC,aAAa,CAAC,CAAC;AAE1D;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,OAAO,OAAO,aACnB,SAAQ,oBACR,YAAW,cAAc;IAEzB,MAAM,CAAC,OAAO,SAAU;IAExB,OAAO,SAAyB;IAEhC;;OAEG;IACH,MAAM,EAAE,QAAQ,CAAC;IAEjB;;;;;;;;;;;OAWG;IACH,UAAU,EAAE,QAAQ,EAAE,CAAM;IAE5B;;OAEG;IACH,UAAU,CAAC,EAAE,QAAQ,CAAC;IAEtB;;OAEG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;IAEhC;;;;;OAKG;IACH,uBAAuB,CAAC,EAAE,uBAAuB,CAAC;IAElD;;OAEG;IACH,KAAK,SAAM;IAEX,SAAS,UAAS;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,QAAQ,CAAC;IAExB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,WAAW,EAAE,IAAI,CAAc;IAE/B;;OAEG;IACH,eAAe,EAAE,IAAI,CAAc;IAEnC,SAAS,CAAC,EAAE,IAAI,CAAC;IAEjB,OAAO,CAAC,EAAE,IAAI,CAAC;IAEf;;OAEG;IACH,IAAI,EAAE;QAAE,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAA;KAAE,CAAM;IAEtD;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAa;IAE7B;;;OAGG;IACH,cAAc,EAAE,2BAA2B,CAAM;IAEjD;;;OAGG;IACH,YAAY,EAAE,yBAAyB,CAAM;gBAEjC,OAAO,EAAE,QAAQ;CAO9B"}

package/lib/documents/dashboard/Task.js

@@ -79,6 +79,9 @@ export default class DashboardTask extends BaseDocumentWithType {
      * same as the parent recurring task.
      */
     parentRecurringTaskInfo;
+    /**
+     * The title of the task.
+     */
     title = '';
     completed = false;
     /**

package/lib/documents/dashboard/Task.js.map

@@ -1 +1 @@
-{"version":3,"file":"Task.js","sourceRoot":"./src/","sources":["documents/dashboard/Task.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAEhC,OAAO,EAGL,sBAAsB,EACvB,MAAM,uDAAuD,CAAC;AAI/D,OAAO,QAAQ,MAAM,0CAA0C,CAAC;AAEhE,OAAO,oBAAoB,MAAM,4BAA4B,CAAC;AAE9D,MAAM,CAAC,MAAM,qBAAqB,GAAqC,CACrE,IAAmB,EACnB,EAAE;IACF,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC5C,MAAM,WAAW,GAAG,IAAI,aAAa,CAAC,IAAI,QAAQ,EAAE,CAAC,CAAC;IAEtD,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC;IAC5C,QAAQ,CAAC,OAAO,CAAC,WAAW,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;IACrD,QAAQ,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;IACvC,QAAQ,CAAC,KAAK,CAAC,YAAY,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC;IACrD,QAAQ,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;IAC1C,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC5B,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;IAClD,QAAQ,CAAC,MAAM,CAAC,aAAa,EAAE,WAAW,CAAC,WAAW,CAAC,CAAC;IACxD,QAAQ,CAAC,MAAM,CAAC,iBAAiB,EAAE,WAAW,CAAC,eAAe,CAAC,CAAC;IAChE,QAAQ,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IACrC,QAAQ,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;IACnC,QAAQ,CAAC,cAAc,CAAC,yBAAyB,CAAC,CAAC;IACnD,QAAQ,CAAC,MAAM,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;IACtC,QAAQ,CAAC,MAAM,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IACpC,sBAAsB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAErC,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AACtC,CAAC,CAAC;AAOF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,OAAO,OAAO,aACnB,SAAQ,oBAAoB;IAG5B,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC;IAExB,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC;IAEhC;;OAEG;IACH,MAAM,CAAW;IAEjB;;;;;;;;;;;OAWG;IACH,UAAU,GAAe,EAAE,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAY;IAEtB;;OAEG;IACH,cAAc,CAAkB;IAEhC;;;;;OAKG;IACH,uBAAuB,CAA2B;IAElD,KAAK,GAAG,EAAE,CAAC;IAEX,SAAS,GAAG,KAAK,CAAC;IAElB;;OAEG;IACH,YAAY,CAAY;IAExB;;;;;OAKG;IACH,WAAW,CAAU;IAErB;;OAEG;IACH,WAAW,GAAS,IAAI,IAAI,EAAE,CAAC;IAE/B;;OAEG;IACH,eAAe,GAAS,IAAI,IAAI,EAAE,CAAC;IAEnC,SAAS,CAAQ;IAEjB,OAAO,CAAQ;IAEf;;OAEG;IACH,IAAI,GAA+C,EAAE,CAAC;IAEtD;;;OAGG;IACH,QAAQ,GAAW,SAAS,CAAC;IAE7B;;;OAGG;IACH,cAAc,GAAgC,EAAE,CAAC;IAEjD;;;OAGG;IACH,YAAY,GAA8B,EAAE,CAAC;IAE7C,YAAY,OAAiB;QAC3B,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC;QACtB,IAAI,CAAC,IAAI,GAAG;YACV,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE;SACzB,CAAC;IACJ,CAAC"}
+{"version":3,"file":"Task.js","sourceRoot":"./src/","sources":["documents/dashboard/Task.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAEhC,OAAO,EAGL,sBAAsB,EACvB,MAAM,uDAAuD,CAAC;AAI/D,OAAO,QAAQ,MAAM,0CAA0C,CAAC;AAEhE,OAAO,oBAAoB,MAAM,4BAA4B,CAAC;AAE9D,MAAM,CAAC,MAAM,qBAAqB,GAAqC,CACrE,IAAmB,EACnB,EAAE;IACF,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,QAAQ,GAAG,IAAI,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC5C,MAAM,WAAW,GAAG,IAAI,aAAa,CAAC,IAAI,QAAQ,EAAE,CAAC,CAAC;IAEtD,QAAQ,CAAC,MAAM,CAAC,OAAO,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC;IAC5C,QAAQ,CAAC,OAAO,CAAC,WAAW,EAAE,WAAW,CAAC,SAAS,CAAC,CAAC;IACrD,QAAQ,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;IACvC,QAAQ,CAAC,KAAK,CAAC,YAAY,EAAE,WAAW,CAAC,UAAU,CAAC,CAAC;IACrD,QAAQ,CAAC,cAAc,CAAC,gBAAgB,CAAC,CAAC;IAC1C,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC5B,QAAQ,CAAC,MAAM,CAAC,UAAU,EAAE,WAAW,CAAC,QAAQ,CAAC,CAAC;IAClD,QAAQ,CAAC,MAAM,CAAC,aAAa,EAAE,WAAW,CAAC,WAAW,CAAC,CAAC;IACxD,QAAQ,CAAC,MAAM,CAAC,iBAAiB,EAAE,WAAW,CAAC,eAAe,CAAC,CAAC;IAChE,QAAQ,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IACrC,QAAQ,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;IACnC,QAAQ,CAAC,cAAc,CAAC,yBAAyB,CAAC,CAAC;IACnD,QAAQ,CAAC,MAAM,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC;IACtC,QAAQ,CAAC,MAAM,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;IACpC,sBAAsB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAErC,OAAO,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;AACtC,CAAC,CAAC;AAOF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,CAAC,OAAO,OAAO,aACnB,SAAQ,oBAAoB;IAG5B,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC;IAExB,OAAO,GAAG,aAAa,CAAC,OAAO,CAAC;IAEhC;;OAEG;IACH,MAAM,CAAW;IAEjB;;;;;;;;;;;OAWG;IACH,UAAU,GAAe,EAAE,CAAC;IAE5B;;OAEG;IACH,UAAU,CAAY;IAEtB;;OAEG;IACH,cAAc,CAAkB;IAEhC;;;;;OAKG;IACH,uBAAuB,CAA2B;IAElD;;OAEG;IACH,KAAK,GAAG,EAAE,CAAC;IAEX,SAAS,GAAG,KAAK,CAAC;IAElB;;OAEG;IACH,YAAY,CAAY;IAExB;;;;;OAKG;IACH,WAAW,CAAU;IAErB;;OAEG;IACH,WAAW,GAAS,IAAI,IAAI,EAAE,CAAC;IAE/B;;OAEG;IACH,eAAe,GAAS,IAAI,IAAI,EAAE,CAAC;IAEnC,SAAS,CAAQ;IAEjB,OAAO,CAAQ;IAEf;;OAEG;IACH,IAAI,GAA+C,EAAE,CAAC;IAEtD;;;OAGG;IACH,QAAQ,GAAW,SAAS,CAAC;IAE7B;;;OAGG;IACH,cAAc,GAAgC,EAAE,CAAC;IAEjD;;;OAGG;IACH,YAAY,GAA8B,EAAE,CAAC;IAE7C,YAAY,OAAiB;QAC3B,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,OAAO,CAAC;QACtB,IAAI,CAAC,IAAI,GAAG;YACV,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,EAAE,EAAE;SACzB,CAAC;IACJ,CAAC"}

package/lib/documents/dashboard/Task.ts

@@ -109,6 +109,9 @@ export default class DashboardTask
    */
   parentRecurringTaskInfo?: ParentRecurringTaskInfo;
 
+  /**
+   * The title of the task.
+   */
   title = '';
 
   completed = false;

package/lib/embedded-types/dashboard/task/FilterSettings.d.ts

@@ -1,6 +1,18 @@
 import DashboardUserConfig from '../../../documents/dashboard/UserConfig.js';
 import Validate from '../../../schemas/validators/ValidateUtil.js';
+/**
+ * Returns the default filter settings for a task list for a given user.
+ *
+ * @param userId - The ID of the user.
+ * @returns The default filter settings for the user's task list.
+ */
 export declare function getDefaultTaskListFilterSettings(userId: string): DashboardTaskListFilterSettings;
+/**
+ * Validates the filter settings in the user configuration.
+ *
+ * @param validate - The validation utility.
+ * @param config - The user configuration containing the filter settings.
+ */
 export declare function validateFilterSettings(validate: Validate, config: DashboardUserConfig): void;
 /**
  * Global task list filter settings. These are created for each user in the

package/lib/embedded-types/dashboard/task/FilterSettings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FilterSettings.d.ts","sourceRoot":"./src/","sources":["embedded-types/dashboard/task/FilterSettings.ts"],"names":[],"mappings":"AAAA,OAAO,mBAAmB,MAAM,4CAA4C,CAAC;AAC7E,OAAO,QAAQ,MAAM,6CAA6C,CAAC;AAEnE,wBAAgB,gCAAgC,CAC9C,MAAM,EAAE,MAAM,GACb,+BAA+B,CAQjC;AAED,wBAAgB,sBAAsB,CACpC,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,mBAAmB,QA2C5B;AAED;;;GAGG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD,CAAC,QAAQ,EAAE,MAAM,GAAG,+BAA+B,CAAC;CACrD,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,CAAC,MAAM,EAAE,MAAM,GAAG,+BAA+B,CAAC;CACnD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,qBAAqB,CAAC;IACjC,kBAAkB,EAAE,qBAAqB,CAAC;IAC1C,SAAS,EAAE;QACT,eAAe,EAAE,OAAO,CAAC;KAC1B,CAAC;IACF;;OAEG;IACH,IAAI,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,qBAAqB,CAAA;KAAE,CAAC;CAChD,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,OAAO,CAAC;CACf,CAAC"}
+{"version":3,"file":"FilterSettings.d.ts","sourceRoot":"./src/","sources":["embedded-types/dashboard/task/FilterSettings.ts"],"names":[],"mappings":"AAAA,OAAO,mBAAmB,MAAM,4CAA4C,CAAC;AAC7E,OAAO,QAAQ,MAAM,6CAA6C,CAAC;AAEnE;;;;;GAKG;AACH,wBAAgB,gCAAgC,CAC9C,MAAM,EAAE,MAAM,GACb,+BAA+B,CAQjC;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,mBAAmB,QA2C5B;AAED;;;GAGG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD,CAAC,QAAQ,EAAE,MAAM,GAAG,+BAA+B,CAAC;CACrD,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,CAAC,MAAM,EAAE,MAAM,GAAG,+BAA+B,CAAC;CACnD,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,qBAAqB,CAAC;IACjC,kBAAkB,EAAE,qBAAqB,CAAC;IAC1C,SAAS,EAAE;QACT,eAAe,EAAE,OAAO,CAAC;KAC1B,CAAC;IACF;;OAEG;IACH,IAAI,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,qBAAqB,CAAA;KAAE,CAAC;CAChD,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IAClC,IAAI,EAAE,OAAO,CAAC;CACf,CAAC"}

package/lib/embedded-types/dashboard/task/FilterSettings.js

@@ -1,3 +1,9 @@
+/**
+ * Returns the default filter settings for a task list for a given user.
+ *
+ * @param userId - The ID of the user.
+ * @returns The default filter settings for the user's task list.
+ */
 export function getDefaultTaskListFilterSettings(userId) {
     return {
         userId,
@@ -7,6 +13,12 @@ export function getDefaultTaskListFilterSettings(userId) {
         tags: {}
     };
 }
+/**
+ * Validates the filter settings in the user configuration.
+ *
+ * @param validate - The validation utility.
+ * @param config - The user configuration containing the filter settings.
+ */
 export function validateFilterSettings(validate, config) {
     validate.object('taskListFilterSettings', {});
     const categories = Object.keys(config.taskListFilterSettings);

package/lib/embedded-types/dashboard/task/FilterSettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"FilterSettings.js","sourceRoot":"./src/","sources":["embedded-types/dashboard/task/FilterSettings.ts"],"names":[],"mappings":"AAGA,MAAM,UAAU,gCAAgC,CAC9C,MAAc;IAEd,OAAO;QACL,MAAM;QACN,SAAS,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE;QACzB,kBAAkB,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;QACnC,SAAS,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE;QACpC,IAAI,EAAE,EAAE;KACT,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,sBAAsB,CACpC,QAAkB,EAClB,MAA2B;IAE3B,QAAQ,CAAC,MAAM,CAAC,wBAAwB,EAAE,EAAE,CAAC,CAAC;IAC9C,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC;IAC9D,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,MAAM,eAAe,GAAG,gCAAgC,CACtD,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CACzB,CAAC;QACF,UAAU,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;YAC9B,QAAQ,CAAC,MAAM,CACb,0BAA0B,QAAQ,SAAS,EAC3C,eAAe,CAAC,MAAM,CACvB,CAAC;YACF,QAAQ,CAAC,MAAM,CACb,0BAA0B,QAAQ,YAAY,EAC9C,eAAe,CAAC,SAAS,CAC1B,CAAC;YACF,QAAQ,CAAC,OAAO,CACd,0BAA0B,QAAQ,iBAAiB,EACnD,eAAe,CAAC,SAAS,CAAC,IAAI,CAC/B,CAAC;YACF,QAAQ,CAAC,MAAM,CACb,0BAA0B,QAAQ,qBAAqB,EACvD,eAAe,CAAC,kBAAkB,CACnC,CAAC;YACF,QAAQ,CAAC,OAAO,CACd,0BAA0B,QAAQ,0BAA0B,EAC5D,eAAe,CAAC,kBAAkB,CAAC,IAAI,CACxC,CAAC;YACF,QAAQ,CAAC,MAAM,CACb,0BAA0B,QAAQ,YAAY,EAC9C,eAAe,CAAC,SAAS,CAC1B,CAAC;YACF,QAAQ,CAAC,OAAO,CACd,0BAA0B,QAAQ,4BAA4B,EAC9D,eAAe,CAAC,SAAS,CAAC,eAAe,CAC1C,CAAC;YACF,QAAQ,CAAC,MAAM,CACb,0BAA0B,QAAQ,OAAO,EACzC,eAAe,CAAC,IAAI,CACrB,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;AACH,CAAC"}
+{"version":3,"file":"FilterSettings.js","sourceRoot":"./src/","sources":["embedded-types/dashboard/task/FilterSettings.ts"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH,MAAM,UAAU,gCAAgC,CAC9C,MAAc;IAEd,OAAO;QACL,MAAM;QACN,SAAS,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE;QACzB,kBAAkB,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;QACnC,SAAS,EAAE,EAAE,eAAe,EAAE,IAAI,EAAE;QACpC,IAAI,EAAE,EAAE;KACT,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,sBAAsB,CACpC,QAAkB,EAClB,MAA2B;IAE3B,QAAQ,CAAC,MAAM,CAAC,wBAAwB,EAAE,EAAE,CAAC,CAAC;IAC9C,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC;IAC9D,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,MAAM,eAAe,GAAG,gCAAgC,CACtD,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CACzB,CAAC;QACF,UAAU,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;YAC9B,QAAQ,CAAC,MAAM,CACb,0BAA0B,QAAQ,SAAS,EAC3C,eAAe,CAAC,MAAM,CACvB,CAAC;YACF,QAAQ,CAAC,MAAM,CACb,0BAA0B,QAAQ,YAAY,EAC9C,eAAe,CAAC,SAAS,CAC1B,CAAC;YACF,QAAQ,CAAC,OAAO,CACd,0BAA0B,QAAQ,iBAAiB,EACnD,eAAe,CAAC,SAAS,CAAC,IAAI,CAC/B,CAAC;YACF,QAAQ,CAAC,MAAM,CACb,0BAA0B,QAAQ,qBAAqB,EACvD,eAAe,CAAC,kBAAkB,CACnC,CAAC;YACF,QAAQ,CAAC,OAAO,CACd,0BAA0B,QAAQ,0BAA0B,EAC5D,eAAe,CAAC,kBAAkB,CAAC,IAAI,CACxC,CAAC;YACF,QAAQ,CAAC,MAAM,CACb,0BAA0B,QAAQ,YAAY,EAC9C,eAAe,CAAC,SAAS,CAC1B,CAAC;YACF,QAAQ,CAAC,OAAO,CACd,0BAA0B,QAAQ,4BAA4B,EAC9D,eAAe,CAAC,SAAS,CAAC,eAAe,CAC1C,CAAC;YACF,QAAQ,CAAC,MAAM,CACb,0BAA0B,QAAQ,OAAO,EACzC,eAAe,CAAC,IAAI,CACrB,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;AACH,CAAC"}

package/lib/embedded-types/dashboard/task/FilterSettings.ts

@@ -1,6 +1,12 @@
 import DashboardUserConfig from '../../../documents/dashboard/UserConfig.js';
 import Validate from '../../../schemas/validators/ValidateUtil.js';
 
+/**
+ * Returns the default filter settings for a task list for a given user.
+ *
+ * @param userId - The ID of the user.
+ * @returns The default filter settings for the user's task list.
+ */
 export function getDefaultTaskListFilterSettings(
   userId: string
 ): DashboardTaskListFilterSettings {
@@ -13,6 +19,12 @@ export function getDefaultTaskListFilterSettings(
   };
 }
 
+/**
+ * Validates the filter settings in the user configuration.
+ *
+ * @param validate - The validation utility.
+ * @param config - The user configuration containing the filter settings.
+ */
 export function validateFilterSettings(
   validate: Validate,
   config: DashboardUserConfig

package/lib/embedded-types/dashboard/task/RecurrenceInfo.d.ts

@@ -1,5 +1,11 @@
 import { ObjectId } from 'bson';
 import DashboardTask from '../../../documents/dashboard/Task.js';
+/**
+ * Validates the recurrence information of a given task.
+ *
+ * @param task - The dashboard task to validate.
+ * @param errors - An array to collect validation error messages.
+ */
 export declare function validateRecurrenceInfo(task: DashboardTask, errors: string[]): void;
 export type RecurrenceInfo = {
     frequency: RecurrenceFrequency;

package/lib/embedded-types/dashboard/task/RecurrenceInfo.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RecurrenceInfo.d.ts","sourceRoot":"./src/","sources":["embedded-types/dashboard/task/RecurrenceInfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,aAAa,MAAM,sCAAsC,CAAC;AAEjE,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,aAAa,EAAE,MAAM,EAAE,MAAM,EAAE,QAuB3E;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,SAAS,EAAE,mBAAmB,CAAC;IAC/B,eAAe,EAAE,eAAe,CAAC;IACjC,gBAAgB,EAAE,gBAAgB,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,uBAAuB,CAAC;IAC9B,cAAc,CAAC,EAAE;QACf,QAAQ,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;QAC5C;;WAEG;QACH,CAAC,EAAE,MAAM,CAAC;KACX,CAAC;IACF;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,oBAAoB,CAAC,EAAE;QACrB,OAAO,EAAE,MAAM,CAAC;QAChB;;;;WAIG;QACH,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC;KAC9B,CAAC;CACH,CAAC;AAEF,oBAAY,uBAAuB;IACjC,cAAc,mBAAmB;IACjC,UAAU,eAAe;IACzB,oBAAoB,yBAAyB;IAC7C,cAAc,mBAAmB;CAClC;AAED;;GAEG;AACH,oBAAY,eAAe;IACzB,SAAS,cAAc;IACvB,OAAO,YAAY;CACpB;AAED,oBAAY,gBAAgB;IAC1B;;OAEG;IACH,WAAW,gBAAgB;IAC3B;;;OAGG;IACH,gBAAgB,qBAAqB;IACrC;;;;OAIG;IACH,KAAK,UAAU;CAChB;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,MAAM,EAAE,QAAQ,CAAC;IACjB,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,OAAO,CAAC,EAAE,IAAI,CAAC;CAChB,CAAC"}
+{"version":3,"file":"RecurrenceInfo.d.ts","sourceRoot":"./src/","sources":["embedded-types/dashboard/task/RecurrenceInfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,aAAa,MAAM,sCAAsC,CAAC;AAEjE;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,IAAI,EAAE,aAAa,EACnB,MAAM,EAAE,MAAM,EAAE,GACf,IAAI,CAuBN;AAED,MAAM,MAAM,cAAc,GAAG;IAC3B,SAAS,EAAE,mBAAmB,CAAC;IAC/B,eAAe,EAAE,eAAe,CAAC;IACjC,gBAAgB,EAAE,gBAAgB,CAAC;CACpC,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,uBAAuB,CAAC;IAC9B,cAAc,CAAC,EAAE;QACf,QAAQ,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAC;QAC5C;;WAEG;QACH,CAAC,EAAE,MAAM,CAAC;KACX,CAAC;IACF;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,oBAAoB,CAAC,EAAE;QACrB,OAAO,EAAE,MAAM,CAAC;QAChB;;;;WAIG;QACH,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC;KAC9B,CAAC;CACH,CAAC;AAEF,oBAAY,uBAAuB;IACjC,cAAc,mBAAmB;IACjC,UAAU,eAAe;IACzB,oBAAoB,yBAAyB;IAC7C,cAAc,mBAAmB;CAClC;AAED;;GAEG;AACH,oBAAY,eAAe;IACzB,SAAS,cAAc;IACvB,OAAO,YAAY;CACpB;AAED,oBAAY,gBAAgB;IAC1B;;OAEG;IACH,WAAW,gBAAgB;IAC3B;;;OAGG;IACH,gBAAgB,qBAAqB;IACrC;;;;OAIG;IACH,KAAK,UAAU;CAChB;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,MAAM,EAAE,QAAQ,CAAC;IACjB,SAAS,CAAC,EAAE,IAAI,CAAC;IACjB,OAAO,CAAC,EAAE,IAAI,CAAC;CAChB,CAAC"}

package/lib/embedded-types/dashboard/task/RecurrenceInfo.js

@@ -1,3 +1,9 @@
+/**
+ * Validates the recurrence information of a given task.
+ *
+ * @param task - The dashboard task to validate.
+ * @param errors - An array to collect validation error messages.
+ */
 export function validateRecurrenceInfo(task, errors) {
     const recurrenceErrors = [];
     if (!task.recurrenceInfo) {
@@ -12,7 +18,7 @@ export function validateRecurrenceInfo(task, errors) {
     if (!task.recurrenceInfo.recurrenceEffect) {
         recurrenceErrors.push('RecurrenceInfo recurrenceEffect is required.');
     }
-    // Write more if this later if there are any changes to the data model so it
+    // Write more of this later if there are any changes to the data model so it
     // can be correctly converted.
     if (recurrenceErrors.length > 0) {
         task.recurrenceInfo = undefined;

package/lib/embedded-types/dashboard/task/RecurrenceInfo.js.map

@@ -1 +1 @@
-{"version":3,"file":"RecurrenceInfo.js","sourceRoot":"./src/","sources":["embedded-types/dashboard/task/RecurrenceInfo.ts"],"names":[],"mappings":"AAGA,MAAM,UAAU,sBAAsB,CAAC,IAAmB,EAAE,MAAgB;IAC1E,MAAM,gBAAgB,GAAa,EAAE,CAAC;IACtC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;QACzB,OAAO;IACT,CAAC;IAED,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,SAAS,EAAE,CAAC;QACnC,gBAAgB,CAAC,IAAI,CAAC,uCAAuC,CAAC,CAAC;IACjE,CAAC;IACD,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,eAAe,EAAE,CAAC;QACzC,gBAAgB,CAAC,IAAI,CAAC,6CAA6C,CAAC,CAAC;IACvE,CAAC;IACD,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,gBAAgB,EAAE,CAAC;QAC1C,gBAAgB,CAAC,IAAI,CAAC,8CAA8C,CAAC,CAAC;IACxE,CAAC;IAED,4EAA4E;IAC5E,8BAA8B;IAE9B,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChC,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;IAClC,CAAC;IACD,MAAM,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC,CAAC;AACnC,CAAC;AAoCD,MAAM,CAAN,IAAY,uBAKX;AALD,WAAY,uBAAuB;IACjC,4DAAiC,CAAA;IACjC,oDAAyB,CAAA;IACzB,wEAA6C,CAAA;IAC7C,4DAAiC,CAAA;AACnC,CAAC,EALW,uBAAuB,KAAvB,uBAAuB,QAKlC;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,eAGX;AAHD,WAAY,eAAe;IACzB,0CAAuB,CAAA;IACvB,sCAAmB,CAAA;AACrB,CAAC,EAHW,eAAe,KAAf,eAAe,QAG1B;AAED,MAAM,CAAN,IAAY,gBAgBX;AAhBD,WAAY,gBAAgB;IAC1B;;OAEG;IACH,+CAA2B,CAAA;IAC3B;;;OAGG;IACH,yDAAqC,CAAA;IACrC;;;;OAIG;IACH,mCAAe,CAAA;AACjB,CAAC,EAhBW,gBAAgB,KAAhB,gBAAgB,QAgB3B"}
+{"version":3,"file":"RecurrenceInfo.js","sourceRoot":"./src/","sources":["embedded-types/dashboard/task/RecurrenceInfo.ts"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH,MAAM,UAAU,sBAAsB,CACpC,IAAmB,EACnB,MAAgB;IAEhB,MAAM,gBAAgB,GAAa,EAAE,CAAC;IACtC,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;QACzB,OAAO;IACT,CAAC;IAED,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,SAAS,EAAE,CAAC;QACnC,gBAAgB,CAAC,IAAI,CAAC,uCAAuC,CAAC,CAAC;IACjE,CAAC;IACD,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,eAAe,EAAE,CAAC;QACzC,gBAAgB,CAAC,IAAI,CAAC,6CAA6C,CAAC,CAAC;IACvE,CAAC;IACD,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,gBAAgB,EAAE,CAAC;QAC1C,gBAAgB,CAAC,IAAI,CAAC,8CAA8C,CAAC,CAAC;IACxE,CAAC;IAED,4EAA4E;IAC5E,8BAA8B;IAE9B,IAAI,gBAAgB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChC,IAAI,CAAC,cAAc,GAAG,SAAS,CAAC;IAClC,CAAC;IACD,MAAM,CAAC,IAAI,CAAC,GAAG,gBAAgB,CAAC,CAAC;AACnC,CAAC;AAoCD,MAAM,CAAN,IAAY,uBAKX;AALD,WAAY,uBAAuB;IACjC,4DAAiC,CAAA;IACjC,oDAAyB,CAAA;IACzB,wEAA6C,CAAA;IAC7C,4DAAiC,CAAA;AACnC,CAAC,EALW,uBAAuB,KAAvB,uBAAuB,QAKlC;AAED;;GAEG;AACH,MAAM,CAAN,IAAY,eAGX;AAHD,WAAY,eAAe;IACzB,0CAAuB,CAAA;IACvB,sCAAmB,CAAA;AACrB,CAAC,EAHW,eAAe,KAAf,eAAe,QAG1B;AAED,MAAM,CAAN,IAAY,gBAgBX;AAhBD,WAAY,gBAAgB;IAC1B;;OAEG;IACH,+CAA2B,CAAA;IAC3B;;;OAGG;IACH,yDAAqC,CAAA;IACrC;;;;OAIG;IACH,mCAAe,CAAA;AACjB,CAAC,EAhBW,gBAAgB,KAAhB,gBAAgB,QAgB3B"}

package/lib/embedded-types/dashboard/task/RecurrenceInfo.ts

@@ -1,7 +1,16 @@
 import { ObjectId } from 'bson';
 import DashboardTask from '../../../documents/dashboard/Task.js';
 
-export function validateRecurrenceInfo(task: DashboardTask, errors: string[]) {
+/**
+ * Validates the recurrence information of a given task.
+ *
+ * @param task - The dashboard task to validate.
+ * @param errors - An array to collect validation error messages.
+ */
+export function validateRecurrenceInfo(
+  task: DashboardTask,
+  errors: string[]
+): void {
   const recurrenceErrors: string[] = [];
   if (!task.recurrenceInfo) {
     return;
@@ -17,7 +26,7 @@ export function validateRecurrenceInfo(task: DashboardTask, errors: string[]) {
     recurrenceErrors.push('RecurrenceInfo recurrenceEffect is required.');
   }
 
-  // Write more if this later if there are any changes to the data model so it
+  // Write more of this later if there are any changes to the data model so it
   // can be correctly converted.
 
   if (recurrenceErrors.length > 0) {

package/lib/embedded-types/dashboard/task/SortSettings.d.ts

@@ -1,7 +1,22 @@
 import DashboardUserConfig from '../../../documents/dashboard/UserConfig.js';
 import Validate from '../../../schemas/validators/ValidateUtil.js';
+/**
+ * Gets the default task list sort settings for a user.
+ *
+ * @param userId - The ID of the user.
+ * @returns The default task list sort settings for the user.
+ */
 export declare function getDefaultTaskListSortSettings(userId: string): DashboardTaskListSortSettings;
+/**
+ * Validates the sort settings for the task list.
+ *
+ * @param validate - The validation utility.
+ * @param config - The user configuration for the dashboard.
+ */
 export declare function validateSortSettings(validate: Validate, config: DashboardUserConfig): void;
+/**
+ * Represents the global sort settings for the task list.
+ */
 export type DashboardTaskListGlobalSortSettings = {
     [category: string]: DashboardTaskListSortSettings;
 };
@@ -33,6 +48,9 @@ export declare enum DashboardTaskSortBy {
     createdDate = "createdDate",
     lastUpdatedDate = "lastUpdatedDate"
 }
+/**
+ * Represents a sort setting for a task list.
+ */
 export type DashboardTaskSortSetting = {
     sortBy: DashboardTaskSortBy;
     sortDirection: DashboardTaskSortDirection;

package/lib/embedded-types/dashboard/task/SortSettings.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"SortSettings.d.ts","sourceRoot":"./src/","sources":["embedded-types/dashboard/task/SortSettings.ts"],"names":[],"mappings":"AAAA,OAAO,mBAAmB,MAAM,4CAA4C,CAAC;AAC7E,OAAO,QAAQ,MAAM,6CAA6C,CAAC;AAEnE,wBAAgB,8BAA8B,CAC5C,MAAM,EAAE,MAAM,GACb,6BAA6B,CAK/B;AAED,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,mBAAmB,QAmB5B;AAED,MAAM,MAAM,mCAAmC,GAAG;IAChD,CAAC,QAAQ,EAAE,MAAM,GAAG,6BAA6B,CAAC;CACnD,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,CAAC,MAAM,EAAE,MAAM,GAAG,6BAA6B,CAAC;CACjD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,KAAK,CAAC,wBAAwB,CAAC,CAAC;CAC3C,CAAC;AAEF;;GAEG;AACH,oBAAY,mBAAmB;IAC7B;;OAEG;IACH,IAAI,SAAS;IACb,KAAK,UAAU;IACf,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,WAAW,gBAAgB;IAC3B,eAAe,oBAAoB;CACpC;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,MAAM,EAAE,mBAAmB,CAAC;IAC5B,aAAa,EAAE,0BAA0B,CAAC;CAC3C,CAAC;AAEF;;;GAGG;AACH,oBAAY,0BAA0B;IACpC;;OAEG;IACH,SAAS,IAAI;IACb;;OAEG;IACH,UAAU,KAAK;CAChB"}
+{"version":3,"file":"SortSettings.d.ts","sourceRoot":"./src/","sources":["embedded-types/dashboard/task/SortSettings.ts"],"names":[],"mappings":"AAAA,OAAO,mBAAmB,MAAM,4CAA4C,CAAC;AAC7E,OAAO,QAAQ,MAAM,6CAA6C,CAAC;AAEnE;;;;;GAKG;AACH,wBAAgB,8BAA8B,CAC5C,MAAM,EAAE,MAAM,GACb,6BAA6B,CAK/B;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CAClC,QAAQ,EAAE,QAAQ,EAClB,MAAM,EAAE,mBAAmB,QAmB5B;AAED;;GAEG;AACH,MAAM,MAAM,mCAAmC,GAAG;IAChD,CAAC,QAAQ,EAAE,MAAM,GAAG,6BAA6B,CAAC;CACnD,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,CAAC,MAAM,EAAE,MAAM,GAAG,6BAA6B,CAAC;CACjD,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,KAAK,CAAC,wBAAwB,CAAC,CAAC;CAC3C,CAAC;AAEF;;GAEG;AACH,oBAAY,mBAAmB;IAC7B;;OAEG;IACH,IAAI,SAAS;IACb,KAAK,UAAU;IACf,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,WAAW,gBAAgB;IAC3B,eAAe,oBAAoB;CACpC;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,MAAM,EAAE,mBAAmB,CAAC;IAC5B,aAAa,EAAE,0BAA0B,CAAC;CAC3C,CAAC;AAEF;;;GAGG;AACH,oBAAY,0BAA0B;IACpC;;OAEG;IACH,SAAS,IAAI;IACb;;OAEG;IACH,UAAU,KAAK;CAChB"}

package/lib/embedded-types/dashboard/task/SortSettings.js

@@ -1,9 +1,21 @@
+/**
+ * Gets the default task list sort settings for a user.
+ *
+ * @param userId - The ID of the user.
+ * @returns The default task list sort settings for the user.
+ */
 export function getDefaultTaskListSortSettings(userId) {
     return {
         userId,
         sortList: []
     };
 }
+/**
+ * Validates the sort settings for the task list.
+ *
+ * @param validate - The validation utility.
+ * @param config - The user configuration for the dashboard.
+ */
 export function validateSortSettings(validate, config) {
     validate.object('taskListSortSettings', {});
     const categories = Object.keys(config.taskListSortSettings);

package/lib/embedded-types/dashboard/task/SortSettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"SortSettings.js","sourceRoot":"./src/","sources":["embedded-types/dashboard/task/SortSettings.ts"],"names":[],"mappings":"AAGA,MAAM,UAAU,8BAA8B,CAC5C,MAAc;IAEd,OAAO;QACL,MAAM;QACN,QAAQ,EAAE,EAAE;KACb,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,oBAAoB,CAClC,QAAkB,EAClB,MAA2B;IAE3B,QAAQ,CAAC,MAAM,CAAC,sBAAsB,EAAE,EAAE,CAAC,CAAC;IAC5C,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC;IAC5D,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,MAAM,eAAe,GAAG,8BAA8B,CACpD,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CACzB,CAAC;QACF,UAAU,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;YAC9B,QAAQ,CAAC,MAAM,CACb,wBAAwB,QAAQ,SAAS,EACzC,eAAe,CAAC,MAAM,CACvB,CAAC;YACF,QAAQ,CAAC,KAAK,CACZ,wBAAwB,QAAQ,WAAW,EAC3C,eAAe,CAAC,QAAQ,CACzB,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAsBD;;GAEG;AACH,MAAM,CAAN,IAAY,mBAUX;AAVD,WAAY,mBAAmB;IAC7B;;OAEG;IACH,oCAAa,CAAA;IACb,sCAAe,CAAA;IACf,0CAAmB,CAAA;IACnB,8CAAuB,CAAA;IACvB,kDAA2B,CAAA;IAC3B,0DAAmC,CAAA;AACrC,CAAC,EAVW,mBAAmB,KAAnB,mBAAmB,QAU9B;AAOD;;;GAGG;AACH,MAAM,CAAN,IAAY,0BASX;AATD,WAAY,0BAA0B;IACpC;;OAEG;IACH,qFAAa,CAAA;IACb;;OAEG;IACH,wFAAe,CAAA;AACjB,CAAC,EATW,0BAA0B,KAA1B,0BAA0B,QASrC"}
+{"version":3,"file":"SortSettings.js","sourceRoot":"./src/","sources":["embedded-types/dashboard/task/SortSettings.ts"],"names":[],"mappings":"AAGA;;;;;GAKG;AACH,MAAM,UAAU,8BAA8B,CAC5C,MAAc;IAEd,OAAO;QACL,MAAM;QACN,QAAQ,EAAE,EAAE;KACb,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,oBAAoB,CAClC,QAAkB,EAClB,MAA2B;IAE3B,QAAQ,CAAC,MAAM,CAAC,sBAAsB,EAAE,EAAE,CAAC,CAAC;IAC5C,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC;IAC5D,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,MAAM,eAAe,GAAG,8BAA8B,CACpD,MAAM,CAAC,MAAM,CAAC,QAAQ,EAAE,CACzB,CAAC;QACF,UAAU,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,EAAE;YAC9B,QAAQ,CAAC,MAAM,CACb,wBAAwB,QAAQ,SAAS,EACzC,eAAe,CAAC,MAAM,CACvB,CAAC;YACF,QAAQ,CAAC,KAAK,CACZ,wBAAwB,QAAQ,WAAW,EAC3C,eAAe,CAAC,QAAQ,CACzB,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;AACH,CAAC;AAyBD;;GAEG;AACH,MAAM,CAAN,IAAY,mBAUX;AAVD,WAAY,mBAAmB;IAC7B;;OAEG;IACH,oCAAa,CAAA;IACb,sCAAe,CAAA;IACf,0CAAmB,CAAA;IACnB,8CAAuB,CAAA;IACvB,kDAA2B,CAAA;IAC3B,0DAAmC,CAAA;AACrC,CAAC,EAVW,mBAAmB,KAAnB,mBAAmB,QAU9B;AAUD;;;GAGG;AACH,MAAM,CAAN,IAAY,0BASX;AATD,WAAY,0BAA0B;IACpC;;OAEG;IACH,qFAAa,CAAA;IACb;;OAEG;IACH,wFAAe,CAAA;AACjB,CAAC,EATW,0BAA0B,KAA1B,0BAA0B,QASrC"}

package/lib/embedded-types/dashboard/task/SortSettings.ts

@@ -1,6 +1,12 @@
 import DashboardUserConfig from '../../../documents/dashboard/UserConfig.js';
 import Validate from '../../../schemas/validators/ValidateUtil.js';
 
+/**
+ * Gets the default task list sort settings for a user.
+ *
+ * @param userId - The ID of the user.
+ * @returns The default task list sort settings for the user.
+ */
 export function getDefaultTaskListSortSettings(
   userId: string
 ): DashboardTaskListSortSettings {
@@ -10,6 +16,12 @@ export function getDefaultTaskListSortSettings(
   };
 }
 
+/**
+ * Validates the sort settings for the task list.
+ *
+ * @param validate - The validation utility.
+ * @param config - The user configuration for the dashboard.
+ */
 export function validateSortSettings(
   validate: Validate,
   config: DashboardUserConfig
@@ -33,6 +45,9 @@ export function validateSortSettings(
   }
 }
 
+/**
+ * Represents the global sort settings for the task list.
+ */
 export type DashboardTaskListGlobalSortSettings = {
   [category: string]: DashboardTaskListSortSettings;
 };
@@ -68,6 +83,9 @@ export enum DashboardTaskSortBy {
   lastUpdatedDate = 'lastUpdatedDate'
 }
 
+/**
+ * Represents a sort setting for a task list.
+ */
 export type DashboardTaskSortSetting = {
   sortBy: DashboardTaskSortBy;
   sortDirection: DashboardTaskSortDirection;

package/lib/schemas/type-guards/commonTypeGuards.d.ts

@@ -1,6 +1,36 @@
+/**
+ * Checks if the value is either undefined or an object (but not an array).
+ *
+ * @param value - The value to check.
+ * @returns True if the value is undefined or an object, false otherwise.
+ */
 export declare function isOptionalObject(value: unknown): value is undefined | object;
+/**
+ * Checks if the value is either undefined, null, or an array.
+ *
+ * @param value - The value to check.
+ * @returns True if the value is undefined, null, or an array, false otherwise.
+ */
 export declare function isOptionalArray(value: unknown): value is undefined | Array<unknown> | null;
+/**
+ * Checks if the value is either undefined, null, or a string.
+ *
+ * @param value - The value to check.
+ * @returns True if the value is undefined, null, or a string, false otherwise.
+ */
 export declare function isOptionalString(value: unknown): value is undefined | string | null;
+/**
+ * Checks if the value is either undefined, null, or a number.
+ *
+ * @param value - The value to check.
+ * @returns True if the value is undefined, null, or a number, false otherwise.
+ */
 export declare function isOptionalNumber(value: unknown): value is undefined | null | number;
+/**
+ * Checks if the value is either undefined, null, or a boolean.
+ *
+ * @param value - The value to check.
+ * @returns True if the value is undefined, null, or a boolean, false otherwise.
+ */
 export declare function isOptionalBoolean(value: unknown): value is undefined | null | boolean;
 //# sourceMappingURL=commonTypeGuards.d.ts.map

package/lib/schemas/type-guards/commonTypeGuards.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"commonTypeGuards.d.ts","sourceRoot":"./src/","sources":["schemas/type-guards/commonTypeGuards.ts"],"names":[],"mappings":"AAAA,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,SAAS,GAAG,MAAM,CAI5E;AAED,wBAAgB,eAAe,CAC7B,KAAK,EAAE,OAAO,GACb,KAAK,IAAI,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,IAAI,CAE5C;AAED,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,OAAO,GACb,KAAK,IAAI,SAAS,GAAG,MAAM,GAAG,IAAI,CAEpC;AAED,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,OAAO,GACb,KAAK,IAAI,SAAS,GAAG,IAAI,GAAG,MAAM,CAEpC;AAED,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,OAAO,GACb,KAAK,IAAI,SAAS,GAAG,IAAI,GAAG,OAAO,CAErC"}
+{"version":3,"file":"commonTypeGuards.d.ts","sourceRoot":"./src/","sources":["schemas/type-guards/commonTypeGuards.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,SAAS,GAAG,MAAM,CAI5E;AAED;;;;;GAKG;AACH,wBAAgB,eAAe,CAC7B,KAAK,EAAE,OAAO,GACb,KAAK,IAAI,SAAS,GAAG,KAAK,CAAC,OAAO,CAAC,GAAG,IAAI,CAE5C;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,OAAO,GACb,KAAK,IAAI,SAAS,GAAG,MAAM,GAAG,IAAI,CAEpC;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,OAAO,GACb,KAAK,IAAI,SAAS,GAAG,IAAI,GAAG,MAAM,CAEpC;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,OAAO,GACb,KAAK,IAAI,SAAS,GAAG,IAAI,GAAG,OAAO,CAErC"}

package/lib/schemas/type-guards/commonTypeGuards.js

@@ -1,15 +1,45 @@
+/**
+ * Checks if the value is either undefined or an object (but not an array).
+ *
+ * @param value - The value to check.
+ * @returns True if the value is undefined or an object, false otherwise.
+ */
 export function isOptionalObject(value) {
     return (value === undefined || (typeof value === 'object' && !Array.isArray(value)));
 }
+/**
+ * Checks if the value is either undefined, null, or an array.
+ *
+ * @param value - The value to check.
+ * @returns True if the value is undefined, null, or an array, false otherwise.
+ */
 export function isOptionalArray(value) {
     return value === undefined || value === null || Array.isArray(value);
 }
+/**
+ * Checks if the value is either undefined, null, or a string.
+ *
+ * @param value - The value to check.
+ * @returns True if the value is undefined, null, or a string, false otherwise.
+ */
 export function isOptionalString(value) {
     return value === undefined || value === null || typeof value === 'string';
 }
+/**
+ * Checks if the value is either undefined, null, or a number.
+ *
+ * @param value - The value to check.
+ * @returns True if the value is undefined, null, or a number, false otherwise.
+ */
 export function isOptionalNumber(value) {
     return value === undefined || value === null || typeof value === 'number';
 }
+/**
+ * Checks if the value is either undefined, null, or a boolean.
+ *
+ * @param value - The value to check.
+ * @returns True if the value is undefined, null, or a boolean, false otherwise.
+ */
 export function isOptionalBoolean(value) {
     return value === undefined || value === null || typeof value === 'boolean';
 }

package/lib/schemas/type-guards/commonTypeGuards.js.map

@@ -1 +1 @@
-{"version":3,"file":"commonTypeGuards.js","sourceRoot":"./src/","sources":["schemas/type-guards/commonTypeGuards.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,gBAAgB,CAAC,KAAc;IAC7C,OAAO,CACL,KAAK,KAAK,SAAS,IAAI,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAC5E,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,eAAe,CAC7B,KAAc;IAEd,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AACvE,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,KAAc;IAEd,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC;AAC5E,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC9B,KAAc;IAEd,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC;AAC5E,CAAC;AAED,MAAM,UAAU,iBAAiB,CAC/B,KAAc;IAEd,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,SAAS,CAAC;AAC7E,CAAC"}
+{"version":3,"file":"commonTypeGuards.js","sourceRoot":"./src/","sources":["schemas/type-guards/commonTypeGuards.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAc;IAC7C,OAAO,CACL,KAAK,KAAK,SAAS,IAAI,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAC5E,CAAC;AACJ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAC7B,KAAc;IAEd,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AACvE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAC9B,KAAc;IAEd,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC;AAC5E,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAC9B,KAAc;IAEd,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,QAAQ,CAAC;AAC5E,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAC/B,KAAc;IAEd,OAAO,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,SAAS,CAAC;AAC7E,CAAC"}

package/lib/schemas/type-guards/commonTypeGuards.ts

@@ -1,27 +1,57 @@
+/**
+ * Checks if the value is either undefined or an object (but not an array).
+ *
+ * @param value - The value to check.
+ * @returns True if the value is undefined or an object, false otherwise.
+ */
 export function isOptionalObject(value: unknown): value is undefined | object {
   return (
     value === undefined || (typeof value === 'object' && !Array.isArray(value))
   );
 }
 
+/**
+ * Checks if the value is either undefined, null, or an array.
+ *
+ * @param value - The value to check.
+ * @returns True if the value is undefined, null, or an array, false otherwise.
+ */
 export function isOptionalArray(
   value: unknown
 ): value is undefined | Array<unknown> | null {
   return value === undefined || value === null || Array.isArray(value);
 }
 
+/**
+ * Checks if the value is either undefined, null, or a string.
+ *
+ * @param value - The value to check.
+ * @returns True if the value is undefined, null, or a string, false otherwise.
+ */
 export function isOptionalString(
   value: unknown
 ): value is undefined | string | null {
   return value === undefined || value === null || typeof value === 'string';
 }
 
+/**
+ * Checks if the value is either undefined, null, or a number.
+ *
+ * @param value - The value to check.
+ * @returns True if the value is undefined, null, or a number, false otherwise.
+ */
 export function isOptionalNumber(
   value: unknown
 ): value is undefined | null | number {
   return value === undefined || value === null || typeof value === 'number';
 }
 
+/**
+ * Checks if the value is either undefined, null, or a boolean.
+ *
+ * @param value - The value to check.
+ * @returns True if the value is undefined, null, or a boolean, false otherwise.
+ */
 export function isOptionalBoolean(
   value: unknown
 ): value is undefined | null | boolean {