@outliant/sunrise-utils 1.1.27 → 1.1.28

package/CHANGELOG.md

@@ -4,9 +4,18 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [1.1.28](https://github.com/outliant/sunrise-utils/compare/1.1.27...1.1.28)
+
+- task starred column #86azquc2z [`#36`](https://github.com/outliant/sunrise-utils/pull/36)
+- banners name and options update #85ztcymgr [`#37`](https://github.com/outliant/sunrise-utils/pull/37)
+- starredTaskIds parameter default value [`d1f69b5`](https://github.com/outliant/sunrise-utils/commit/d1f69b59611dc6b31d7c68a43e18b2920ea46c27)
+
 #### [1.1.27](https://github.com/outliant/sunrise-utils/compare/1.1.26...1.1.27)
 
+> 2 April 2024
+
 - critical path age color display fix utils #86azmbay5 [`#35`](https://github.com/outliant/sunrise-utils/pull/35)
+- chore(release): 1.1.27 [`3401e5a`](https://github.com/outliant/sunrise-utils/commit/3401e5a3f7a56ab1d8e8faf0b28e00015ed770a8)
 
 #### [1.1.26](https://github.com/outliant/sunrise-utils/compare/1.1.25...1.1.26)
 

package/constants.js

@@ -1,18 +1,30 @@
 module.exports.PROJECT_BANNERS = [
   {
     label: 'Whale',
-    value: 'whale',
+    value: 'whale'
   },
   {
     label: 'VIP',
-    value: 'vip',
+    value: 'vip'
   },
   {
     label: 'Legal',
-    value: 'legal',
+    value: 'legal'
   },
   {
     label: 'Escalation',
-    value: 'escalation',
+    value: 'escalation'
+  },
+  {
+    label: 'Loan Risk',
+    value: 'loan-risk'
+  },
+  {
+    label: 'Not Serviceable',
+    value: 'not-serviceable'
+  },
+  {
+    label: 'Roof Leak',
+    value: 'roof-leak'
   }
-];
+];

package/helpers/projectFilter/index.js

@@ -100,7 +100,7 @@ module.exports.defaultCustomColumns = [
     field_type: 'date'
   },
   {
-    name: 'Notable',
+    name: 'Banners',
     value: 'banner',
     type: 'banner',
     field_type: 'checkbox',

package/helpers/sortScript.js

@@ -328,6 +328,28 @@ module.exports.wasMarkedIncomplete = (order) => {
   };
 };
 
+module.exports.isStarred = (order, starredTaskIds) => {
+  return {
+    _script: {
+      type: 'number',
+      script: {
+        lang: 'painless',
+        source: `
+          if (params.starredTaskIds.contains(doc._id.value)) {
+            return 1;
+          } else {
+            return 0;
+          }
+        `,
+        params: {
+          starredTaskIds: starredTaskIds || []
+        }
+      },
+      order
+    }
+  };
+};
+
 module.exports.projectFieldNumeric = (order, value) => {
   return {
     _script: {

package/helpers/taskFilter/index.js

@@ -6,6 +6,7 @@ const buildTaskFieldFilter = require('./taskFieldFilter');
 const buildCriticalPathFilter = require('./criticalPathFilter');
 const buildOnHoldFilter = require('./onHoldFilter');
 const buildIsPausedFilter = require('./isPausedFilter');
+const buildIsStarredFilter = require('./isStarredFilter');
 const buildDaysToCompleteFilter = require('./daysToComplete');
 const buildAgeColorFilter = require('./buildAgeColorFilter');
 const buildProjectFieldFilter = require('../projectFilter/projectFieldFilter');
@@ -217,11 +218,17 @@ module.exports.defaultCustomColumns = [
     field_type: 'date'
   },
   {
-    name: 'Notable',
+    name: 'Banners',
     value: 'project_banner',
     type: 'project_banner',
     field_type: 'checkbox',
     options: PROJECT_BANNERS
+  },
+  {
+    name: 'Is Starred',
+    value: 'is_starred',
+    type: 'is_starred',
+    field_type: 'boolean'
   }
 ];
 
@@ -272,7 +279,7 @@ module.exports.defaultFilterSetting = {
   }
 };
 
-module.exports.buildTaskPipelineFilter = (filter) => {
+module.exports.buildTaskPipelineFilter = (filter, starredTaskIds) => {
   switch (filter.type) {
     case 'status':
       return buildStatusFilter(filter);
@@ -329,6 +336,8 @@ module.exports.buildTaskPipelineFilter = (filter) => {
     case 'ticketinformation':
     case 'taskfield':
       return buildProjectFieldFilter(filter);
+    case 'is_starred':
+      return buildIsStarredFilter(filter, starredTaskIds);
     default:
       // Task Fields
       return buildTaskFieldFilter(filter);

package/helpers/taskFilter/isStarredFilter.js

@@ -0,0 +1,50 @@
+module.exports = (filter, starredTaskIds = []) => {
+  switch (filter.condition) {
+    case 'is_true':
+      return module.exports.isTrue(starredTaskIds);
+    case 'is_false':
+      return module.exports.isFalse(starredTaskIds);
+    default:
+      return null;
+  }
+};
+
+module.exports.isTrue = (starredTaskIds = []) => {
+  return {
+    script: {
+      script: {
+        lang: 'painless',
+        source: `
+              if (params.starredTaskIds.contains(doc._id.value)) {
+                return true;
+              } else {
+                return false;
+              }
+            `,
+        params: {
+          starredTaskIds
+        }
+      }
+    }
+  };
+};
+
+module.exports.isFalse = (starredTaskIds = []) => {
+  return {
+    script: {
+      script: {
+        lang: 'painless',
+        source: `
+              if (params.starredTaskIds.contains(doc._id.value)) {
+                return false;
+              } else {
+                return true;
+              }
+            `,
+        params: {
+          starredTaskIds
+        }
+      }
+    }
+  };
+};

package/lib/fieldConditions.js

@@ -212,6 +212,16 @@ module.exports.conditions = {
       label: 'Is None Of',
       value: 'is_none_of'
     }
+  ],
+  boolean: [
+    {
+      label: 'Is True',
+      value: 'is_true'
+    },
+    {
+      label: 'Is False',
+      value: 'is_false'
+    }
   ]
 };
 

package/lib/taskPipeline.js

@@ -25,7 +25,8 @@ class TaskPipeline {
     departmentId,
     filters = [],
     query = {},
-    searchFields = []
+    searchFields = [],
+    starredTaskIds = []
   ) {
     const mustQuery = [
       {
@@ -76,7 +77,7 @@ class TaskPipeline {
     }
 
     for (const filter of filters) {
-      const queryFilter = buildTaskPipelineFilter(filter);
+      const queryFilter = buildTaskPipelineFilter(filter, starredTaskIds);
 
       if (queryFilter) {
         mustQuery.push(queryFilter);
@@ -90,7 +91,7 @@ class TaskPipeline {
     return { bool: { must: mustQuery } };
   }
 
-  buildSortScript(query = {}, customSort = []) {
+  buildSortScript(query = {}, customSort = [], starredTaskIds = []) {
     const sortMultiple = (query.sort || 'desc').split(',');
     const sortByMultiple = (query.sortBy || 'created_at').split(',');
     let taskPipelinesSort = [];
@@ -110,8 +111,8 @@ class TaskPipeline {
             taskPipelinesSort.push(sortScript.isPaused(sort));
             break;
 
-          case s === 'owner' :
-          case s === 'completed_by' :
+          case s === 'owner':
+          case s === 'completed_by':
             taskPipelinesSort.push(sortScript.owner(sort));
             break;
 
@@ -158,6 +159,10 @@ class TaskPipeline {
             taskPipelinesSort.push(sortScript.projectFieldText(sort, s));
             break;
 
+          case s === 'is_starred':
+            taskPipelinesSort.push(sortScript.isStarred(sort, starredTaskIds));
+            break;
+
           default:
             taskPipelinesSort.push({
               [s]: { order: sort, missing: '_last' }
@@ -187,12 +192,8 @@ class TaskPipeline {
       return;
     }
 
-    const readyAt = moment(task.ready_at)
-      .utc()
-      .startOf('day');
-    const completedAt = moment(task.completed_at)
-      .utc()
-      .startOf('day');
+    const readyAt = moment(task.ready_at).utc().startOf('day');
+    const completedAt = moment(task.completed_at).utc().startOf('day');
 
     return completedAt.diff(readyAt, 'days');
   };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@outliant/sunrise-utils",
   "description": "Helper functions for project Sunrise",
-  "version": "1.1.27",
+  "version": "1.1.28",
   "license": "ISC",
   "author": "Outliant",
   "main": "index.js",

package/test/helpers/sortScript.spec.js

@@ -45,4 +45,32 @@ describe('sortScript', function () {
       });
     }
   });
+  describe('task/is_starred', function () {
+    const orders = ['desc', 'asc'];
+    for (const order of orders) {
+      it(`should handle \`${order}\` sort order`, () => {
+        const sort = sortScript.isStarred(order, []);
+        expect(sort).to.be.deep.equal({
+          _script: {
+            type: 'number',
+            script: {
+              lang: 'painless',
+              source:
+                '\n' +
+                '          if (params.starredTaskIds.contains(doc._id.value)) {\n' +
+                '            return 1;\n' +
+                '          } else {\n' +
+                '            return 0;\n' +
+                '          }\n' +
+                '        ',
+              params: {
+                starredTaskIds: []
+              }
+            },
+            order
+          }
+        });
+      });
+    }
+  });
 });

package/test/helpers/taskFilter/index.spec.js

@@ -425,12 +425,12 @@ describe('taskFilter', function () {
             must_not: {
               range: {
                 'last_comment_data.created_at': {
-                    gte: 1704038400000,
-                    lte: 1704124799999
-                  }
+                  gte: 1704038400000,
+                  lte: 1704124799999
                 }
               }
             }
+          }
         });
       });
 
@@ -447,9 +447,9 @@ describe('taskFilter', function () {
         expect(filter).to.be.deep.equal({
           range: {
             'last_comment_data.created_at': {
-                gt: 1704124799999
-              }
+              gt: 1704124799999
             }
+          }
         });
       });
 
@@ -466,9 +466,9 @@ describe('taskFilter', function () {
         expect(filter).to.be.deep.equal({
           range: {
             'last_comment_data.created_at': {
-                lt: 1704038400000
-              }
+              lt: 1704038400000
             }
+          }
         });
       });
 
@@ -485,10 +485,72 @@ describe('taskFilter', function () {
         expect(filter).to.be.deep.equal({
           range: {
             'last_comment_data.created_at': {
-                gte: 1705593600000,
-                lte: 1709222399999
+              gte: 1705593600000,
+              lte: 1709222399999
+            }
+          }
+        });
+      });
+    });
+
+    describe('is_starred', () => {
+      it('should handle `is_true` filter', () => {
+        const filter = taskFilter.buildTaskPipelineFilter({
+          field_id: '',
+          field_type: 'boolean',
+          type: 'is_starred',
+          condition: 'is_true',
+          value: null,
+          second_value: null
+        });
+
+        expect(filter).to.be.deep.equal({
+          script: {
+            script: {
+              lang: 'painless',
+              source:
+                '\n' +
+                '              if (params.starredTaskIds.contains(doc._id.value)) {\n' +
+                '                return true;\n' +
+                '              } else {\n' +
+                '                return false;\n' +
+                '              }\n' +
+                '            ',
+              params: {
+                starredTaskIds: []
+              }
+            }
+          }
+        });
+      });
+
+      it('should handle `is_false` filter', () => {
+        const filter = taskFilter.buildTaskPipelineFilter({
+          field_id: '',
+          field_type: 'boolean',
+          type: 'is_starred',
+          condition: 'is_false',
+          value: null,
+          second_value: null
+        });
+
+        expect(filter).to.be.deep.equal({
+          script: {
+            script: {
+              lang: 'painless',
+              source:
+                '\n' +
+                '              if (params.starredTaskIds.contains(doc._id.value)) {\n' +
+                '                return false;\n' +
+                '              } else {\n' +
+                '                return true;\n' +
+                '              }\n' +
+                '            ',
+              params: {
+                starredTaskIds: []
               }
             }
+          }
         });
       });
     });