@outliant/sunrise-utils 1.1.11 → 1.1.13

package/CHANGELOG.md

@@ -4,10 +4,26 @@ 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.13](https://github.com/outliant/sunrise-utils/compare/1.1.12...1.1.13)
+
+- chore: change equal condition [`#18`](https://github.com/outliant/sunrise-utils/pull/18)
+- chore: update isPaused filter [`99d882d`](https://github.com/outliant/sunrise-utils/commit/99d882d74cb7fb6d7aba3048a2328343017ca512)
+
+#### [1.1.12](https://github.com/outliant/sunrise-utils/compare/1.1.11...1.1.12)
+
+> 7 November 2023
+
+- chore: add isPaused [`#17`](https://github.com/outliant/sunrise-utils/pull/17)
+- chore: add unit test for is_paused [`aa5fada`](https://github.com/outliant/sunrise-utils/commit/aa5fada660f2883004a1a72ddb0603f412dec18e)
+- chore(release): 1.1.12 [`56f3083`](https://github.com/outliant/sunrise-utils/commit/56f30836a6b021e0d57cfabf9541b063ddb92afd)
+
 #### [1.1.11](https://github.com/outliant/sunrise-utils/compare/1.1.10...1.1.11)
 
+> 18 October 2023
+
 - chore: implement case insensitive search for id [`#16`](https://github.com/outliant/sunrise-utils/pull/16)
 - chore: add test for projectPipeline utils [`b35d394`](https://github.com/outliant/sunrise-utils/commit/b35d394d98713d01c1149ef1a36f6c7c2cf4adab)
+- chore(release): 1.1.11 [`e88579a`](https://github.com/outliant/sunrise-utils/commit/e88579ab043a70ca5901c0fbeb4cdda58f9cccd2)
 
 #### [1.1.10](https://github.com/outliant/sunrise-utils/compare/1.1.9...1.1.10)
 

package/helpers/projectFilter/index.js

@@ -1,6 +1,7 @@
 const buildRegionFilter = require('./regionFilter');
 const buildCriticalPathFilter = require('./criticalPathFilter');
 const buildOnHoldFilter = require('./onHoldFilter');
+const buildIsPausedFilter = require('./isPausedFilter');
 const buildIsGeneratedFilter = require('./isGeneratedFilter');
 const buildTagFilter = require('./tagFilter');
 const buildProjectFieldFilter = require('./projectFieldFilter');
@@ -32,6 +33,22 @@ module.exports.defaultCustomColumns = [
     type: 'on_hold',
     field_type: 'select'
   },
+  {
+    name: 'Is Paused',
+    value: 'is_paused',
+    type: 'is_paused',
+    field_type: 'select',
+    options: [
+      {
+        label: 'Yes',
+        value: 'Yes'
+      },
+      {
+        label: 'No',
+        value: 'No'
+      }
+    ]
+  },
   {
     name: 'Is Generated',
     value: 'is_generated',
@@ -93,6 +110,8 @@ module.exports.buildProjectPipelineFilter = (filter) => {
       return buildCriticalPathFilter(filter);
     case 'on_hold':
       return buildOnHoldFilter(filter);
+    case 'is_paused':
+      return buildIsPausedFilter(filter);
     case 'is_generated':
       return buildIsGeneratedFilter(filter);
     case 'dealPropertyMappings':

package/helpers/projectFilter/isPausedFilter.js

@@ -0,0 +1,41 @@
+module.exports = (filter) => {
+  switch (filter.condition) {
+    case 'is_equal':
+      return module.exports.isEqual();
+    case 'not_equal':
+      return module.exports.isNotEqual();
+    default:
+      return null;
+  }
+};
+
+module.exports.isEqual = () => {
+  return {
+    match: {
+      is_paused: true
+    }
+  };
+};
+
+module.exports.isNotEqual = () => {
+  return {
+    bool: {
+      should: [
+        {
+          match: {
+            is_paused: false
+          }
+        },
+        {
+          bool: {
+            must_not: {
+              exists: {
+                field: 'is_paused'
+              }
+            }
+          }
+        }
+      ]
+    }
+  };
+};

package/helpers/sortScript.js

@@ -222,6 +222,23 @@ module.exports.criticalPathStage = (order) => {
   };
 };
 
+module.exports.isPaused = (order) => {
+  return {
+    _script: {
+      type: 'number',
+      script: {
+        lang: 'painless',
+        source: `
+          return doc['is_paused'].empty
+            ? 0
+            : doc['is_paused'].value ? 1 : 0;
+      `
+      },
+      order
+    }
+  };
+};
+
 module.exports.projectId = (order) => {
   return {
     _script: {

package/helpers/taskFilter/index.js

@@ -5,6 +5,7 @@ const buildRegionFilter = require('./regionFilter');
 const buildTaskFieldFilter = require('./taskFieldFilter');
 const buildCriticalPathFilter = require('./criticalPathFilter');
 const buildOnHoldFilter = require('./onHoldFilter');
+const buildIsPausedFilter = require('./isPausedFilter');
 const buildDaysToCompleteFilter = require('./daysToComplete');
 const buildAgeColorFilter = require('./buildAgeColorFilter');
 const buildProjectFieldFilter = require('../projectFilter/projectFieldFilter');
@@ -121,6 +122,22 @@ module.exports.defaultCustomColumns = [
       }
     ]
   },
+  {
+    name: 'Is Paused',
+    value: 'is_paused',
+    type: 'is_paused',
+    field_type: 'select',
+    options: [
+      {
+        label: 'Yes',
+        value: 'Yes'
+      },
+      {
+        label: 'No',
+        value: 'No'
+      }
+    ]
+  },
   {
     name: 'Last Comment',
     value: 'last_comment',
@@ -235,6 +252,8 @@ module.exports.buildTaskPipelineFilter = (filter) => {
       return buildCriticalPathFilter(filter);
     case 'on_hold':
       return buildOnHoldFilter(filter);
+    case 'is_paused':
+      return buildIsPausedFilter(filter);
     case 'days_to_complete':
       return buildDaysToCompleteFilter(filter);
     // Always expected as is_equal condition

package/helpers/taskFilter/isPausedFilter.js

@@ -0,0 +1,122 @@
+const splitString = require('../splitString');
+
+module.exports = (filter) => {
+  switch (filter.condition) {
+    case 'is_empty':
+      return module.exports.isEmpty();
+    case 'is_not_empty':
+      return module.exports.isNotEmpty();
+    case 'is_equal':
+      return module.exports.isEqual(filter);
+    case 'not_equal':
+      return module.exports.isNotEqual(filter);
+    case 'is_any_of':
+      return module.exports.isAnyOf(filter); // if is any, means all tasks that have value
+    default:
+      return null;
+  }
+};
+
+module.exports.isEmpty = () => {
+  return {
+    bool: {
+      must_not: [
+        {
+          exists: {
+            field: 'is_paused'
+          }
+        }
+      ]
+    }
+  };
+};
+
+module.exports.isNotEmpty = () => {
+  return {
+    bool: {
+      must: [
+        {
+          exists: {
+            field: 'is_paused'
+          }
+        }
+      ]
+    }
+  };
+};
+
+module.exports.isEqual = (filter) => {
+  const isYes = filter.value === 'Yes';
+
+  if (isYes) {
+    return {
+      bool: {
+        must: [
+          {
+            term: {
+              is_paused: {
+                value: true
+              }
+            }
+          }
+        ]
+      }
+    };
+  }
+
+  return {
+    bool: {
+      should: [
+        {
+          match: {
+            is_paused: false
+          }
+        },
+        {
+          bool: {
+            must_not: {
+              exists: {
+                field: 'is_paused'
+              }
+            }
+          }
+        }
+      ]
+    }
+  };
+};
+
+module.exports.isNotEqual = (filter) => {
+  return {
+    bool: {
+      must_not: [
+        module.exports.isEqual(filter)
+      ]
+    }
+  };
+};
+
+module.exports.isAnyOf = (filter) => {
+  let value = filter.value;
+
+  if (typeof value === 'string') {
+    value = splitString(value);
+  }
+
+  const should = [];
+  value.forEach((x) => {
+    should.push({
+      term: {
+        is_paused: {
+          value: x === 'Yes'
+        }
+      }
+    });
+  });
+
+  return {
+    bool: {
+      should
+    }
+  };
+};

package/lib/projectPipeline.js

@@ -89,21 +89,36 @@ class ProjectPipeline {
     if (sortByMultiple.length > 0) {
       sortByMultiple.forEach((s, i) => {
         const sort = sortMultiple[i] || 'desc';
-        if (isUuid(s)) {
-          projectPipelinesSort.push(sortScript.projectFieldNumeric(sort, s));
-          projectPipelinesSort.push(sortScript.projectFieldText(sort, s));
-        } else if (s === 'region') {
-          projectPipelinesSort.push(sortScript.region(sort));
-        } else if (s === 'criticalPathStage') {
-          projectPipelinesSort.push(sortScript.criticalPathStage(sort));
-        } else if (s === 'name') {
-          projectPipelinesSort.push({
-            'name.raw': { order: sort, missing: '_last' }
-          });
-        } else {
-          projectPipelinesSort.push({
-            [s]: { order: sort, missing: '_last' }
-          });
+
+        switch (true) {
+          case isUuid(s):
+            projectPipelinesSort.push(sortScript.projectFieldNumeric(sort, s));
+            projectPipelinesSort.push(sortScript.projectFieldText(sort, s));
+            break;
+
+          case s === 'region':
+            projectPipelinesSort.push(sortScript.region(sort));
+            break;
+
+          case s === 'criticalPathStage':
+            projectPipelinesSort.push(sortScript.criticalPathStage(sort));
+            break;
+
+          case s === 'is_paused':
+            projectPipelinesSort.push(sortScript.isPaused(sort));
+            break;
+
+          case s === 'name':
+            projectPipelinesSort.push({
+              'name.raw': { order: sort, missing: '_last' }
+            });
+            break;
+
+          default:
+            projectPipelinesSort.push({
+              [s]: { order: sort, missing: '_last' }
+            });
+            break;
         }
       });
     }

package/lib/taskPipeline.js

@@ -104,6 +104,10 @@ class TaskPipeline {
             taskPipelinesSort.push(sortScript.region(sort));
             break;
 
+          case s === 'is_paused':
+            taskPipelinesSort.push(sortScript.isPaused(sort));
+            break;
+
           case s === 'owner' :
           case s === 'completed_by' :
             taskPipelinesSort.push(sortScript.owner(sort));

package/package.json

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

package/test/lib/taskPipeline.spec.js

@@ -125,6 +125,66 @@ describe('taskPipeline', function () {
       done();
     });
 
+    it('should not add default is_paused filter if present', (done) => {
+      const filter = taskPipeline.buildFiltersQuery(
+        testOrgId,
+        testDepartmentId,
+        [
+          {
+            condition: 'is_equal',
+            field_id: '',
+            type: 'status',
+            field_type: 'select',
+            value: 'is_paused',
+            second_value: ''
+          }
+        ]
+      );
+
+      expect(filter).to.deep.equal({
+        bool: {
+          must: [
+            {
+              term: {
+                organization_id: {
+                  value: "test-org"
+                }
+              }
+            },
+            {
+              term: {
+                department_id: {
+                  value: "test-department"
+                }
+              }
+            },
+            {
+              bool: {
+                should: [
+                  {
+                    term: {
+                      on_hold: false
+                    }
+                  },
+                  {
+                    bool: {
+                      must_not: {
+                        exists: {
+                          field: "on_hold"
+                        }
+                      }
+                    }
+                  }
+                ]
+              }
+            }
+          ]
+        }
+      });
+
+      done();
+    });
+
     it('should handle unknown filter', (done) => {
       const filter = taskPipeline.buildFiltersQuery(
         testOrgId,
@@ -233,7 +293,7 @@ describe('taskPipeline', function () {
         {
           sort: 'asc,asc,asc',
           sortBy:
-            'region,owner,completed_by,status,critical_path_stage,project_id,ready_at,was_marked_incomplete,last_comment_date,38d423bf-fc24-4183-b8b7-15420c89e318,id'
+            'region,owner,completed_by,status,critical_path_stage,project_id,ready_at,was_marked_incomplete,last_comment_date,is_paused,38d423bf-fc24-4183-b8b7-15420c89e318,id'
         },
         [
           {
@@ -355,6 +415,16 @@ describe('taskPipeline', function () {
             order: "desc"
           }
         },
+        {
+          _script: {
+            type: "number",
+            script: {
+              lang: "painless",
+              source: "\n          return doc['is_paused'].empty\n            ? 0\n            : doc['is_paused'].value ? 1 : 0;\n      "
+            },
+            order: "desc"
+          }
+        },
         {
           _script: {
             type: "number",