@aneuhold/core-ts-db-lib 1.0.39 → 1.0.40

package/lib/index.d.ts

@@ -11,7 +11,7 @@ import { DashboardTagSetting, DashboardTagSettings } from './embedded-types/dash
 import RequiredUserId from './schemas/required-refs/RequiredUserId';
 import { DocumentValidator } from './schemas/validators/DocumentValidator';
 import DocumentService from './services/DocumentService';
-import DashboardTaskService from './services/dashboard/Task/TaskService';
+import DashboardTaskService, { DashboardTaskFilterAndSortResult } from './services/dashboard/Task/TaskService';
 export { User, validateUser, ApiKey, validateApiKey, DashboardUserConfig, validateDashboardUserConfig, DashboardTask, RecurrenceFrequencyType, RecurrenceBasis, RecurrenceEffect, DashboardTaskSortBy, DashboardTaskSortDirection, getDefaultTaskListFilterSettings, getDefaultTaskListSortSettings, validateDashboardTask, DashboardTaskService, BaseDocument, BaseDocumentWithType, RequiredUserId, DocumentService };
-export type { DocumentValidator, UserCTO, RecurrenceInfo, RecurrenceFrequency, ParentRecurringTaskInfo, DashboardTaskMap, DashboardTaskListGlobalFilterSettings, DashboardTaskFilterSettings, DashboardTaskListFilterSettings, DashboardTaskListGlobalSortSettings, DashboardTaskSortSettings, DashboardTaskListSortSettings, DashboardTaskSortSetting, DashboardTagSettings, DashboardTagSetting };
+export type { DocumentValidator, UserCTO, RecurrenceInfo, RecurrenceFrequency, ParentRecurringTaskInfo, DashboardTaskMap, DashboardTaskListGlobalFilterSettings, DashboardTaskFilterSettings, DashboardTaskFilterAndSortResult, DashboardTaskListFilterSettings, DashboardTaskListGlobalSortSettings, DashboardTaskSortSettings, DashboardTaskListSortSettings, DashboardTaskSortSetting, DashboardTagSettings, DashboardTagSetting };
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,0BAA0B,CAAC;AACpD,OAAO,oBAAoB,MAAM,kCAAkC,CAAC;AACpE,OAAO,MAAM,EAAE,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAO,IAAI,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,aAAa,EAAE,EACpB,gBAAgB,EAChB,qBAAqB,EACtB,MAAM,4BAA4B,CAAC;AACpC,OAAO,mBAAmB,EAAE,EAC1B,2BAA2B,EAC5B,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACL,qCAAqC,EACrC,2BAA2B,EAC3B,+BAA+B,EAC/B,gCAAgC,EACjC,MAAM,gDAAgD,CAAC;AACxD,OAAO,EACL,uBAAuB,EACvB,eAAe,EACf,gBAAgB,EAChB,mBAAmB,EACnB,uBAAuB,EACvB,cAAc,EACf,MAAM,gDAAgD,CAAC;AACxD,OAAO,EACL,mCAAmC,EACnC,6BAA6B,EAC7B,mBAAmB,EACnB,0BAA0B,EAC1B,yBAAyB,EACzB,wBAAwB,EACxB,8BAA8B,EAC/B,MAAM,8CAA8C,CAAC;AACtD,OAAO,EACL,mBAAmB,EACnB,oBAAoB,EACrB,MAAM,4CAA4C,CAAC;AACpD,OAAO,cAAc,MAAM,wCAAwC,CAAC;AACpE,OAAO,EAAE,iBAAiB,EAAE,MAAM,wCAAwC,CAAC;AAC3E,OAAO,eAAe,MAAM,4BAA4B,CAAC;AACzD,OAAO,oBAAoB,MAAM,uCAAuC,CAAC;AAGzE,OAAO,EACL,IAAI,EACJ,YAAY,EACZ,MAAM,EACN,cAAc,EACd,mBAAmB,EACnB,2BAA2B,EAC3B,aAAa,EACb,uBAAuB,EACvB,eAAe,EACf,gBAAgB,EAChB,mBAAmB,EACnB,0BAA0B,EAC1B,gCAAgC,EAChC,8BAA8B,EAC9B,qBAAqB,EACrB,oBAAoB,EACpB,YAAY,EACZ,oBAAoB,EACpB,cAAc,EACd,eAAe,EAChB,CAAC;AAGF,YAAY,EACV,iBAAiB,EACjB,OAAO,EACP,cAAc,EACd,mBAAmB,EACnB,uBAAuB,EACvB,gBAAgB,EAChB,qCAAqC,EACrC,2BAA2B,EAC3B,+BAA+B,EAC/B,mCAAmC,EACnC,yBAAyB,EACzB,6BAA6B,EAC7B,wBAAwB,EACxB,oBAAoB,EACpB,mBAAmB,EACpB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,0BAA0B,CAAC;AACpD,OAAO,oBAAoB,MAAM,kCAAkC,CAAC;AACpE,OAAO,MAAM,EAAE,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AACnE,OAAO,IAAI,EAAE,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACtE,OAAO,aAAa,EAAE,EACpB,gBAAgB,EAChB,qBAAqB,EACtB,MAAM,4BAA4B,CAAC;AACpC,OAAO,mBAAmB,EAAE,EAC1B,2BAA2B,EAC5B,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACL,qCAAqC,EACrC,2BAA2B,EAC3B,+BAA+B,EAC/B,gCAAgC,EACjC,MAAM,gDAAgD,CAAC;AACxD,OAAO,EACL,uBAAuB,EACvB,eAAe,EACf,gBAAgB,EAChB,mBAAmB,EACnB,uBAAuB,EACvB,cAAc,EACf,MAAM,gDAAgD,CAAC;AACxD,OAAO,EACL,mCAAmC,EACnC,6BAA6B,EAC7B,mBAAmB,EACnB,0BAA0B,EAC1B,yBAAyB,EACzB,wBAAwB,EACxB,8BAA8B,EAC/B,MAAM,8CAA8C,CAAC;AACtD,OAAO,EACL,mBAAmB,EACnB,oBAAoB,EACrB,MAAM,4CAA4C,CAAC;AACpD,OAAO,cAAc,MAAM,wCAAwC,CAAC;AACpE,OAAO,EAAE,iBAAiB,EAAE,MAAM,wCAAwC,CAAC;AAC3E,OAAO,eAAe,MAAM,4BAA4B,CAAC;AACzD,OAAO,oBAAoB,EAAE,EAC3B,gCAAgC,EACjC,MAAM,uCAAuC,CAAC;AAG/C,OAAO,EACL,IAAI,EACJ,YAAY,EACZ,MAAM,EACN,cAAc,EACd,mBAAmB,EACnB,2BAA2B,EAC3B,aAAa,EACb,uBAAuB,EACvB,eAAe,EACf,gBAAgB,EAChB,mBAAmB,EACnB,0BAA0B,EAC1B,gCAAgC,EAChC,8BAA8B,EAC9B,qBAAqB,EACrB,oBAAoB,EACpB,YAAY,EACZ,oBAAoB,EACpB,cAAc,EACd,eAAe,EAChB,CAAC;AAGF,YAAY,EACV,iBAAiB,EACjB,OAAO,EACP,cAAc,EACd,mBAAmB,EACnB,uBAAuB,EACvB,gBAAgB,EAChB,qCAAqC,EACrC,2BAA2B,EAC3B,gCAAgC,EAChC,+BAA+B,EAC/B,mCAAmC,EACnC,yBAAyB,EACzB,6BAA6B,EAC7B,wBAAwB,EACxB,oBAAoB,EACpB,mBAAmB,EACpB,CAAC"}

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

@@ -1,5 +1,17 @@
 import { DashboardTaskMap } from '../../../documents/dashboard/Task';
 import { DashboardTaskListFilterSettings } from '../../../embedded-types/dashboard/task/FilterSettings';
+export type DashboardTaskFilterResult = {
+    /**
+     * The IDs of the tasks that satisfy the filter settings.
+     */
+    resultIds: string[];
+    /**
+     * The IDs of the tasks that were filtered, but still apply to the same
+     * category. Does not include tasks that were filtered because of grand
+     * children tasks.
+     */
+    removedIds: string[];
+};
 /**
  * A service responsible for filtering
  */
@@ -16,6 +28,6 @@ export default class DashboardTaskFilterService {
      * @param parentTaskId determines if the current list is for a parent task
      * or not
      */
-    static filter(taskMap: DashboardTaskMap, taskIds: string[], settings: DashboardTaskListFilterSettings, category: string, parentTaskId?: string): string[];
+    static filter(taskMap: DashboardTaskMap, taskIds: string[], settings: DashboardTaskListFilterSettings, category: string, parentTaskId?: string): DashboardTaskFilterResult;
 }
 //# sourceMappingURL=TaskFilterService.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"TaskFilterService.d.ts","sourceRoot":"","sources":["../../../../src/services/dashboard/Task/TaskFilterService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AACrE,OAAO,EAAE,+BAA+B,EAAE,MAAM,uDAAuD,CAAC;AAExG;;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;CA0DxB"}
+{"version":3,"file":"TaskFilterService.d.ts","sourceRoot":"","sources":["../../../../src/services/dashboard/Task/TaskFilterService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAC;AACrE,OAAO,EAAE,+BAA+B,EAAE,MAAM,uDAAuD,CAAC;AAExG,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;CAoE7B"}

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

@@ -17,7 +17,10 @@ class DashboardTaskFilterService {
      * or not
      */
     static filter(taskMap, taskIds, settings, category, parentTaskId) {
-        return taskIds.filter((taskId) => {
+        // The filtered IDs that apply to the category, and aren't grandchildren
+        // tasks.
+        const removedIds = [];
+        const resultIds = taskIds.filter((taskId) => {
             const task = taskMap[taskId];
             // Category
             if (!task || task.category !== category)
@@ -39,12 +42,14 @@ class DashboardTaskFilterService {
             }
             // Completed
             if (!settings.completed.show && task.completed) {
+                removedIds.push(taskId);
                 return false;
             }
             // Start date
             if (!settings.startDate.showFutureTasks &&
                 task.startDate &&
                 task.startDate > new Date()) {
+                removedIds.push(taskId);
                 return false;
             }
             // Tags
@@ -54,14 +59,20 @@ class DashboardTaskFilterService {
                     if (settings.tags[tag] && !settings.tags[tag].show) {
                         return true;
                     }
+                    removedIds.push(taskId);
                     return false;
                 });
                 if (shouldHide) {
+                    removedIds.push(taskId);
                     return false;
                 }
             }
             return true;
         });
+        return {
+            resultIds,
+            removedIds
+        };
     }
 }
 exports.default = DashboardTaskFilterService;

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

@@ -11,6 +11,15 @@ export type DashboardTaskFilterTaskInfo = {
     taskId: string;
     allChildrenIds: string[];
 };
+export type DashboardTaskFilterAndSortResult = {
+    filteredAndSortedIds: string[];
+    /**
+     * The IDs of the tasks that were filtered, but still apply to the same
+     * category. Does not include tasks that were filtered because of grand
+     * children tasks.
+     */
+    removedIds: string[];
+};
 export default class DashboardTaskService {
     /**
      * Gets all the children task IDs for the given parent task IDs.
@@ -39,7 +48,7 @@ export default class DashboardTaskService {
      * Otherwise, this will use the default filter settings for the user. If
      * the user does not have filter settings, then it will use the default.
      */
-    static getFilteredAndSortedTaskIds(taskMap: DashboardTaskMap, category: string, filterSettings: DashboardTaskListFilterSettings, sortSettings: DashboardTaskListSortSettings, tagSettings: DashboardTagSettings, taskInfo?: DashboardTaskFilterTaskInfo): string[];
+    static getFilteredAndSortedTaskIds(taskMap: DashboardTaskMap, category: string, filterSettings: DashboardTaskListFilterSettings, sortSettings: DashboardTaskListSortSettings, tagSettings: DashboardTagSettings, taskInfo?: DashboardTaskFilterTaskInfo): DashboardTaskFilterAndSortResult;
     /**
      * Gets a map of task IDs to tag header names. Used only for when sorting by
      * tags. If the first task in the list has no high-priority tags, then

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

@@ -1 +1 @@
-{"version":3,"file":"TaskService.d.ts","sourceRoot":"","sources":["../../../../src/services/dashboard/Task/TaskService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,aAAa,EAAE,EACpB,gBAAgB,EACjB,MAAM,mCAAmC,CAAC;AAE3C,OAAO,EAAE,+BAA+B,EAAE,MAAM,uDAAuD,CAAC;AACxG,OAAO,EAAE,6BAA6B,EAAE,MAAM,qDAAqD,CAAC;AAGpG,OAAO,EAAE,oBAAoB,EAAE,MAAM,mDAAmD,CAAC;AACzF,OAAO,EAAE,mBAAmB,EAAE,MAAM,uDAAuD,CAAC;AAE5F;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,EAAE,CAAC;CAC1B,CAAC;AAEF,MAAM,CAAC,OAAO,OAAO,oBAAoB;IACvC;;OAEG;IACH,MAAM,CAAC,cAAc,iBACL,aAAa,EAAE,iBACd,QAAQ,EAAE,KACxB,QAAQ,EAAE,CA2BX;IAEF;;;OAGG;IACH,MAAM,CAAC,oBAAoB,CAAC,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,mBAAmB;IAO3E;;;;;;;;OAQG;IACH,MAAM,CAAC,wBAAwB,CAAC,IAAI,EAAE,aAAa;IAInD;;;;;;;OAOG;IACH,MAAM,CAAC,2BAA2B,CAChC,OAAO,EAAE,gBAAgB,EACzB,QAAQ,EAAE,MAAM,EAChB,cAAc,EAAE,+BAA+B,EAC/C,YAAY,EAAE,6BAA6B,EAC3C,WAAW,EAAE,oBAAoB,EACjC,QAAQ,CAAC,EAAE,2BAA2B,GACrC,MAAM,EAAE;IA2BX;;;;OAIG;IACH,MAAM,CAAC,eAAe,CACpB,OAAO,EAAE,gBAAgB,EACzB,OAAO,EAAE,MAAM,EAAE,EACjB,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,oBAAoB,EACjC,uBAAuB,EAAE,MAAM;IAWjC,OAAO,CAAC,MAAM,CAAC,kBAAkB;CAsBlC"}
+{"version":3,"file":"TaskService.d.ts","sourceRoot":"","sources":["../../../../src/services/dashboard/Task/TaskService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,MAAM,CAAC;AAChC,OAAO,aAAa,EAAE,EACpB,gBAAgB,EACjB,MAAM,mCAAmC,CAAC;AAE3C,OAAO,EAAE,+BAA+B,EAAE,MAAM,uDAAuD,CAAC;AACxG,OAAO,EAAE,6BAA6B,EAAE,MAAM,qDAAqD,CAAC;AAKpG,OAAO,EAAE,oBAAoB,EAAE,MAAM,mDAAmD,CAAC;AACzF,OAAO,EAAE,mBAAmB,EAAE,MAAM,uDAAuD,CAAC;AAE5F;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,MAAM,EAAE,MAAM,CAAC;IACf,cAAc,EAAE,MAAM,EAAE,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,gCAAgC,GAAG;IAC7C,oBAAoB,EAAE,MAAM,EAAE,CAAC;IAC/B;;;;OAIG;IACH,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB,CAAC;AAEF,MAAM,CAAC,OAAO,OAAO,oBAAoB;IACvC;;OAEG;IACH,MAAM,CAAC,cAAc,iBACL,aAAa,EAAE,iBACd,QAAQ,EAAE,KACxB,QAAQ,EAAE,CA2BX;IAEF;;;OAGG;IACH,MAAM,CAAC,oBAAoB,CAAC,SAAS,EAAE,IAAI,EAAE,SAAS,EAAE,mBAAmB;IAO3E;;;;;;;;OAQG;IACH,MAAM,CAAC,wBAAwB,CAAC,IAAI,EAAE,aAAa;IAInD;;;;;;;OAOG;IACH,MAAM,CAAC,2BAA2B,CAChC,OAAO,EAAE,gBAAgB,EACzB,QAAQ,EAAE,MAAM,EAChB,cAAc,EAAE,+BAA+B,EAC/C,YAAY,EAAE,6BAA6B,EAC3C,WAAW,EAAE,oBAAoB,EACjC,QAAQ,CAAC,EAAE,2BAA2B,GACrC,gCAAgC;IA8BnC;;;;OAIG;IACH,MAAM,CAAC,eAAe,CACpB,OAAO,EAAE,gBAAgB,EACzB,OAAO,EAAE,MAAM,EAAE,EACjB,MAAM,EAAE,MAAM,EACd,WAAW,EAAE,oBAAoB,EACjC,uBAAuB,EAAE,MAAM;IAWjC,OAAO,CAAC,MAAM,CAAC,kBAAkB;CAsBlC"}

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

@@ -68,7 +68,10 @@ class DashboardTaskService {
         else {
             filterResult = TaskFilterService_1.default.filter(taskMap, taskInfo.allChildrenIds, filterSettings, category, taskInfo.taskId);
         }
-        return TaskSortService_1.default.sort(taskMap, filterResult, sortSettings, tagSettings);
+        return {
+            filteredAndSortedIds: TaskSortService_1.default.sort(taskMap, filterResult.resultIds, sortSettings, tagSettings),
+            removedIds: filterResult.removedIds
+        };
     }
     /**
      * Gets a map of task IDs to tag header names. Used only for when sorting by

package/lib/services/dashboard/Task/TaskService.spec.js

@@ -209,7 +209,7 @@ describe('DashboardTaskService', () => {
             const { tasksList, taskMap, filterSettings, sortSettings, tagSettings } = setupSortAndFilterTest();
             tasksList[0].category = 'somethingelse';
             // Call
-            const result = TaskService_1.default.getFilteredAndSortedTaskIds(taskMap, 'default', filterSettings, sortSettings, tagSettings);
+            const { filteredAndSortedIds: result } = TaskService_1.default.getFilteredAndSortedTaskIds(taskMap, 'default', filterSettings, sortSettings, tagSettings);
             // Assert
             expect(result.length).toBe(4);
             result.forEach((taskId) => {
@@ -228,7 +228,7 @@ describe('DashboardTaskService', () => {
             tasksList[4].startDate = startDate1;
             tasksList[1].startDate = startDate2;
             tasksList[2].startDate = startDate3;
-            const result = TaskService_1.default.getFilteredAndSortedTaskIds(taskMap, 'default', filterSettings, sortSettings, tagSettings);
+            const { filteredAndSortedIds: result } = TaskService_1.default.getFilteredAndSortedTaskIds(taskMap, 'default', filterSettings, sortSettings, tagSettings);
             expect(result.length).toBe(5);
             expect(taskMap[result[0]].startDate?.getTime()).toBe(startDate1.getTime());
             expect(taskMap[result[1]].startDate?.getTime()).toBe(startDate2.getTime());
@@ -261,7 +261,7 @@ describe('DashboardTaskService', () => {
             tasksList[3].tags = {
                 [sortSettings.userId]: ['tag1']
             };
-            const result = TaskService_1.default.getFilteredAndSortedTaskIds(taskMap, 'default', filterSettings, sortSettings, tagSettings);
+            const { filteredAndSortedIds: result } = TaskService_1.default.getFilteredAndSortedTaskIds(taskMap, 'default', filterSettings, sortSettings, tagSettings);
             expect(result.length).toBe(5);
             expect(taskMap[result[0]].tags[sortSettings.userId]).toEqual([
                 'tag1',
@@ -318,7 +318,7 @@ describe('DashboardTaskService', () => {
             task6.tags = {
                 [sortSettings.userId]: ['tagWithoutPriority']
             };
-            const sortedTaskIds = TaskService_1.default.getFilteredAndSortedTaskIds(taskMap, 'default', filterSettings, sortSettings, tagSettings);
+            const { filteredAndSortedIds: sortedTaskIds } = TaskService_1.default.getFilteredAndSortedTaskIds(taskMap, 'default', filterSettings, sortSettings, tagSettings);
             expect(sortedTaskIds.length).toBe(10);
             expect(sortedTaskIds[0]).toBe(task1._id.toString());
             expect(sortedTaskIds[1]).toBe(task2._id.toString());
@@ -390,7 +390,7 @@ describe('DashboardTaskService', () => {
             task4.title = 'a';
             task5.title = 'b';
             task6.title = 'c';
-            const result = TaskService_1.default.getFilteredAndSortedTaskIds(taskMap, 'default', filterSettings, sortSettings, tagSettings);
+            const { filteredAndSortedIds: result } = TaskService_1.default.getFilteredAndSortedTaskIds(taskMap, 'default', filterSettings, sortSettings, tagSettings);
             expect(result.length).toBe(10);
             expect(result[0]).toBe(task1._id.toString());
             expect(result[1]).toBe(task2._id.toString());

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aneuhold/core-ts-db-lib",
-  "version": "1.0.39",
+  "version": "1.0.40",
   "description": "A core database library used for personal projects",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",