@outliant/sunrise-utils 1.1.12 → 1.1.14

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.14](https://github.com/outliant/sunrise-utils/compare/1.1.13...1.1.14)
+
+- chore: add Is None Of field condition #85ztm47dj [`#20`](https://github.com/outliant/sunrise-utils/pull/20)
+- chore: add Is None Of field condition (WIP) #85ztm47dj [`8005104`](https://github.com/outliant/sunrise-utils/commit/8005104a15eaf5102fe3672f1a9da5d03128ba4b)
+
+#### [1.1.13](https://github.com/outliant/sunrise-utils/compare/1.1.12...1.1.13)
+
+> 8 November 2023
+
+- 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)
+- chore(release): 1.1.13 [`998c753`](https://github.com/outliant/sunrise-utils/commit/998c753cd70aad1cf9f55e392a812bf40d74a602)
+
 #### [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)
 

package/helpers/common.js

@@ -0,0 +1,36 @@
+const splitString = require('./splitString');
+
+/**
+ * Creates a filter condition for "is_none_of" based on the provided filter and filterBuilder function.
+ *
+ * @param {Object} filter - The filter object.
+ * @param {Function} filterBuilder - The function to build filters.
+ * @returns {Object|null} The constructed filter condition or null if input is invalid.
+ */
+module.exports.isNoneOf = (filter, filterBuilder) => {
+  if (
+    !filter ||
+    !filter.value ||
+    !filterBuilder ||
+    typeof filterBuilder !== 'function'
+  ) {
+    return null;
+  }
+
+  const value = typeof filter.value === 'string'
+    ? splitString(filter.value)
+    : filter.value;
+
+  if (!value || value && value.length === 0) {
+    return null;
+  }
+
+  return {
+    bool: {
+      must_not: value.map(x => filterBuilder({
+        ...filter,
+        value: x
+      }))
+    }
+  };
+};

package/helpers/projectFilter/criticalPathFilter.js

@@ -1,4 +1,5 @@
 const splitString = require('../splitString');
+const { isNoneOf } = require('../common');
 
 module.exports = (filter) => {
   switch (filter.condition) {
@@ -9,6 +10,11 @@ module.exports = (filter) => {
     case 'contains_none':
     case 'not_equal':
       return module.exports.containsNone(filter);
+    case 'is_none_of':
+      return isNoneOf(
+        filter,
+        module.exports.isEqual
+      );
     case 'greater_than_or_equal':
       return module.exports.greaterThanOrEqual(filter);
     case 'less_than_or_equal':

package/helpers/projectFilter/index.js

@@ -1,7 +1,7 @@
 const buildRegionFilter = require('./regionFilter');
 const buildCriticalPathFilter = require('./criticalPathFilter');
 const buildOnHoldFilter = require('./onHoldFilter');
-const buildIsPausedFilter = require('../taskFilter/isPausedFilter');
+const buildIsPausedFilter = require('./isPausedFilter');
 const buildIsGeneratedFilter = require('./isGeneratedFilter');
 const buildTagFilter = require('./tagFilter');
 const buildProjectFieldFilter = require('./projectFieldFilter');

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/projectFilter/projectFieldFilter.js

@@ -1,6 +1,7 @@
 const moment = require('moment');
 const { escapeElasticQuery } = require('../es');
 const splitString = require('../splitString');
+const { isNoneOf } = require('../common');
 
 function getContainsMappingValue(filter) {
   if (['text', 'textarea'].includes(filter.field_type)) {
@@ -44,6 +45,11 @@ module.exports = (filter) => {
       return module.exports.isEqual(filter);
     case 'not_equal':
       return module.exports.isNotEqual(filter);
+    case 'is_none_of':
+      return isNoneOf(
+        filter,
+        module.exports.isEqual
+      );
     case 'before':
     case 'less_than':
       return module.exports.isBefore(filter);

package/helpers/projectFilter/projectFilter.js

@@ -1,6 +1,7 @@
 const moment = require('moment');
 const { escapeElasticQuery } = require('../es');
 const splitString = require('../splitString');
+const { isNoneOf } = require('../common');
 
 module.exports = (filter) => {
   switch (filter.condition) {
@@ -8,6 +9,11 @@ module.exports = (filter) => {
       return module.exports.isEqual(filter);
     case 'not_equal':
       return module.exports.isNotEqual(filter);
+    case 'is_none_of':
+      return isNoneOf(
+        filter,
+        module.exports.isEqual
+      );
     case 'before':
     case 'less_than':
       return module.exports.isBefore(filter);
@@ -429,4 +435,4 @@ module.exports.isNotEqual = (filter) => {
       must_not: [mappingValue]
     }
   };
-};
+};

package/helpers/projectFilter/regionFilter.js

@@ -1,4 +1,5 @@
 const splitString = require('../splitString');
+const { isNoneOf } = require('../common');
 
 module.exports = (filter) => {
   switch (filter.condition) {
@@ -8,6 +9,11 @@ module.exports = (filter) => {
     case 'contains_none':
     case 'not_equal':
       return module.exports.containsNone(filter);
+    case 'is_none_of':
+      return isNoneOf(
+        filter,
+        module.exports.containsAny
+      );
     default:
       return null;
   }
@@ -55,4 +61,4 @@ module.exports.containsNone = (filter) => {
       })
     }
   };
-};
+};

package/helpers/projectFilter/tagFilter.js

@@ -1,4 +1,5 @@
 const splitString = require('../splitString');
+const { isNoneOf } = require('../common');
 
 module.exports = (filter) => {
   switch (filter.condition) {
@@ -11,6 +12,11 @@ module.exports = (filter) => {
     case 'is_equal':
     case 'contains':
       return module.exports.containsAll(filter);
+    case 'is_none_of':
+      return isNoneOf(
+        filter,
+        module.exports.containsAll
+      );
     default:
       return null;
   }

package/helpers/taskFilter/criticalPathFilter.js

@@ -1,4 +1,5 @@
 const splitString = require('../splitString');
+const { isNoneOf } = require('../common');
 
 module.exports = (filter) => {
   switch (filter.condition) {
@@ -12,6 +13,11 @@ module.exports = (filter) => {
       return module.exports.isNotEqual(filter);
     case 'is_any_of':
       return module.exports.isAnyOf(filter);
+    case 'is_none_of':
+      return isNoneOf(
+        filter,
+        module.exports.isEqual
+      );
     default:
       return null;
   }

package/helpers/taskFilter/isPausedFilter.js

@@ -1,4 +1,5 @@
 const splitString = require('../splitString');
+const { isNoneOf } = require('../common');
 
 module.exports = (filter) => {
   switch (filter.condition) {
@@ -12,6 +13,11 @@ module.exports = (filter) => {
       return module.exports.isNotEqual(filter);
     case 'is_any_of':
       return module.exports.isAnyOf(filter); // if is any, means all tasks that have value
+    case 'is_none_of':
+      return isNoneOf(
+        filter,
+        module.exports.isEqual
+      );
     default:
       return null;
   }
@@ -46,13 +52,38 @@ module.exports.isNotEmpty = () => {
 };
 
 module.exports.isEqual = (filter) => {
+  const isYes = filter.value === 'Yes';
+
+  if (isYes) {
+    return {
+      bool: {
+        must: [
+          {
+            term: {
+              is_paused: {
+                value: true
+              }
+            }
+          }
+        ]
+      }
+    };
+  }
+
   return {
     bool: {
-      must: [
+      should: [
         {
-          term: {
-            is_paused: {
-              value: filter.value === 'Yes'
+          match: {
+            is_paused: false
+          }
+        },
+        {
+          bool: {
+            must_not: {
+              exists: {
+                field: 'is_paused'
+              }
             }
           }
         }
@@ -65,13 +96,7 @@ module.exports.isNotEqual = (filter) => {
   return {
     bool: {
       must_not: [
-        {
-          term: {
-            is_paused: {
-              value: filter.value === 'Yes'
-            }
-          }
-        }
+        module.exports.isEqual(filter)
       ]
     }
   };
@@ -100,4 +125,4 @@ module.exports.isAnyOf = (filter) => {
       should
     }
   };
-};
+};

package/helpers/taskFilter/onHoldFilter.js

@@ -1,4 +1,5 @@
 const splitString = require('../splitString');
+const { isNoneOf } = require('../common');
 
 module.exports = (filter) => {
   switch (filter.condition) {
@@ -12,6 +13,11 @@ module.exports = (filter) => {
       return module.exports.isNotEqual(filter);
     case 'is_any_of':
       return module.exports.isAnyOf(filter); // if is any, means all tasks that have value
+    case 'is_none_of':
+      return isNoneOf(
+        filter,
+        module.exports.isEqual
+      );
     default:
       return null;
   }
@@ -100,4 +106,4 @@ module.exports.isAnyOf = (filter) => {
       should
     }
   };
-};
+};

package/helpers/taskFilter/ownerFilter.js

@@ -1,6 +1,7 @@
 const { validate: isUuid } = require('uuid');
 
 const splitString = require('../splitString');
+const { isNoneOf } = require('../common');
 
 module.exports = (filter) => {
   switch (filter.condition) {
@@ -14,6 +15,11 @@ module.exports = (filter) => {
       return module.exports.isNotEqual(filter);
     case 'is_any_of':
       return module.exports.isAnyOf(filter);
+    case 'is_none_of':
+      return isNoneOf(
+        filter,
+        module.exports.isEqual
+      );
     default:
       return null;
   }

package/helpers/taskFilter/regionFilter.js

@@ -1,4 +1,5 @@
 const splitString = require('../splitString');
+const { isNoneOf } = require('../common');
 
 module.exports = (filter) => {
   switch (filter.condition) {
@@ -8,6 +9,11 @@ module.exports = (filter) => {
       return module.exports.isNotEmpty();
     case 'is_equal':
       return module.exports.isEqual(filter);
+    case 'is_none_of':
+      return isNoneOf(
+        filter,
+        module.exports.isEqual
+      );
     case 'not_equal':
       return module.exports.isNotEqual(filter);
     default:
@@ -81,4 +87,4 @@ module.exports.isNotEqual = (filter) => {
   }
 
   return null;
-};
+};

package/helpers/taskFilter/statusFilter.js

@@ -1,4 +1,5 @@
 const splitString = require('../splitString');
+const { isNoneOf } = require('../common');
 
 module.exports = (filter) => {
   switch (filter.condition) {
@@ -12,6 +13,11 @@ module.exports = (filter) => {
       return module.exports.isNotEqual(filter);
     case 'is_any_of':
       return module.exports.isAnyOf(filter);
+    case 'is_none_of':
+      return isNoneOf(
+        filter,
+        module.exports.isEqual
+      );
     default:
       return null;
   }
@@ -176,4 +182,4 @@ module.exports.isNotEqual = (filter) => {
   }
 
   return null;
-};
+};

package/helpers/taskFilter/taskFieldFilter.js

@@ -1,6 +1,7 @@
 const moment = require('moment');
 
 const splitString = require('../splitString');
+const { isNoneOf } = require('../common');
 
 module.exports = (filter) => {
   switch (filter.condition) {
@@ -18,6 +19,11 @@ module.exports = (filter) => {
       return module.exports.isEqual(filter);
     case 'not_equal':
       return module.exports.isNotEqual(filter);
+    case 'is_none_of':
+      return isNoneOf(
+        filter,
+        module.exports.isEqual
+      );
     case 'before':
     case 'less_than':
       return module.exports.isBefore(filter);

package/helpers/users/filters/status.js

@@ -1,9 +1,16 @@
+const { isNoneOf } = require('../common');
+
 module.exports = (filter) => {
   switch (filter.condition) {
     case 'is_equal':
       return module.exports.isEqual(filter);
     case 'not_equal':
       return module.exports.isNotEqual(filter);
+    case 'is_none_of':
+      return isNoneOf(
+        filter,
+        module.exports.isEqual
+      );
     default:
       return null;
   }
@@ -74,4 +81,4 @@ module.exports.isNotEqual = (filter) => {
   }
 
   return null;
-};
+};

package/lib/fieldConditions.js

@@ -27,6 +27,10 @@ module.exports.conditions = {
     {
       label: 'Contains None',
       value: 'contains_none'
+    },
+    {
+      label: 'Is None Of',
+      value: 'is_none_of'
     }
   ],
   textarea: [
@@ -57,6 +61,10 @@ module.exports.conditions = {
     {
       label: 'Contains None',
       value: 'contains_none'
+    },
+    {
+      label: 'Is None Of',
+      value: 'is_none_of'
     }
   ],
   number: [
@@ -113,6 +121,10 @@ module.exports.conditions = {
     {
       label: 'Is Not Empty',
       value: 'is_not_empty'
+    },
+    {
+      label: 'Is None Of',
+      value: 'is_none_of'
     }
   ],
   select: [
@@ -135,6 +147,10 @@ module.exports.conditions = {
     {
       label: 'Is any of',
       value: 'is_any_of'
+    },
+    {
+      label: 'Is None Of',
+      value: 'is_none_of'
     }
   ],
   date: [
@@ -191,6 +207,10 @@ module.exports.conditions = {
     {
       label: 'Is Not Empty',
       value: 'is_not_empty'
+    },
+    {
+      label: 'Is None Of',
+      value: 'is_none_of'
     }
   ]
 };

package/package.json

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

package/test/helpers/isNoneOf.spec.js

@@ -0,0 +1,139 @@
+'use strict';
+
+/* eslint-env node, mocha */
+const { expect } = require('chai');
+
+// To test
+const { isNoneOf } = require('../../helpers/common');
+const { isEqual } = require('../../helpers/taskFilter/ownerFilter');
+
+describe('isNoneOf', function () {
+  const filters = [
+    {
+      input: {
+        condition: 'is_none_of',
+        field_id: '',
+        type: 'critical_path_stage',
+        field_type: 'select',
+        value: 'meow1;meow2',
+        second_value: ''
+      },
+      callback: isEqual,
+      output: {
+        bool: {
+          must_not: [
+            {
+              bool: {
+                must: [
+                  { term: { team_id: { value: 'meow1' } } }
+                ]
+              }
+            },
+            {
+              bool: {
+                must: [
+                  { term: { team_id: { value: 'meow2' } } }
+                ]
+              }
+            }
+          ]
+        }
+      }      
+    },
+    {
+      input: {
+        condition: 'is_none_of',
+        field_id: '',
+        type: 'critical_path_stage',
+        field_type: 'select',
+        value: ['meow1', 'meow2'],
+        second_value: ''
+      },
+      callback: isEqual,
+      output: {
+        bool: {
+          must_not: [
+            {
+              bool: {
+                must: [
+                  { term: { team_id: { value: 'meow1' } } }
+                ]
+              }
+            },
+            {
+              bool: {
+                must: [
+                  { term: { team_id: { value: 'meow2' } } }
+                ]
+              }
+            }
+          ]
+        }
+      }      
+    },
+    {
+      input: {
+        condition: 'is_none_of',
+        field_id: '',
+        type: 'critical_path_stage',
+        field_type: 'select',
+        value: 'meow',
+        second_value: ''
+      },
+      callback: isEqual,
+      output: {
+        bool: {
+          must_not: [
+            {
+              bool: {
+                must: [
+                  { term: { team_id: { value: 'meow' } } }
+                ]
+              }
+            }
+          ]
+        }
+      }      
+    },
+    {
+      input: {
+        condition: 'is_none_of',
+        field_id: '',
+        type: 'critical_path_stage',
+        field_type: 'select',
+        value: [],
+        second_value: ''
+      },
+      callback: isEqual,
+      output: null
+    },
+    {
+      input: {
+        condition: 'is_none_of',
+        value: null
+      },
+      callback: isEqual,
+      output: null
+    },
+    {
+      input: {
+        condition: 'is_none_of',
+        field_id: '',
+        type: 'critical_path_stage',
+        field_type: 'select',
+        value: 'meow',
+        second_value: ''
+      },
+      callback: undefined,
+      output: null
+    }
+  ];
+  filters.forEach((filter) => {
+    it(`${filter.input.condition}: ${JSON.stringify(
+      filter.input.value
+    )}`, (done) => {
+      expect(isNoneOf(filter.input, filter.callback)).to.deep.equal(filter.output);
+      done();
+    });
+  });
+});