@outliant/sunrise-utils 1.1.16 → 1.1.18

package/CHANGELOG.md

@@ -4,9 +4,24 @@ 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.18](https://github.com/outliant/sunrise-utils/compare/1.1.17...1.1.18)
+
+- chore: update is_paused query filters #863hbxjkt [`#24`](https://github.com/outliant/sunrise-utils/pull/24)
+
+#### [1.1.17](https://github.com/outliant/sunrise-utils/compare/1.1.16...1.1.17)
+
+> 15 January 2024
+
+- chore: update task status filter #863hbxjkt [`#23`](https://github.com/outliant/sunrise-utils/pull/23)
+- chore: clean up is_paused filter #863hbxjkt [`f098a15`](https://github.com/outliant/sunrise-utils/commit/f098a15636cc2bb8fcd1c2bfc3fb9f4ceec5fc89)
+- chore(release): 1.1.17 [`a796e59`](https://github.com/outliant/sunrise-utils/commit/a796e594a343f41ceb7941607f43ed95c894d2e5)
+
 #### [1.1.16](https://github.com/outliant/sunrise-utils/compare/1.1.15...1.1.16)
 
+> 13 December 2023
+
 - chore: update is none of filter #85ztm47dj [`#22`](https://github.com/outliant/sunrise-utils/pull/22)
+- chore(release): 1.1.16 [`e322032`](https://github.com/outliant/sunrise-utils/commit/e32203205b74ae0e079612ab842451b210263051)
 
 #### [1.1.15](https://github.com/outliant/sunrise-utils/compare/1.1.14...1.1.15)
 

package/helpers/projectFilter/index.js

@@ -34,6 +34,7 @@ module.exports.defaultCustomColumns = [
     field_type: 'select'
   },
   {
+    validate: (validator) => validator && validator.isCommercial(),
     name: 'Is Paused',
     value: 'is_paused',
     type: 'is_paused',

package/helpers/taskFilter/index.js

@@ -32,6 +32,11 @@ module.exports.taskStatusOptions = [
   {
     label: 'Overdue',
     value: 'overdue'
+  },
+  {
+    validate: (validator) => validator && validator.isCommercial(),
+    label: 'Paused',
+    value: 'paused'
   }
 ];
 
@@ -123,6 +128,7 @@ module.exports.defaultCustomColumns = [
     ]
   },
   {
+    validate: (validator) => validator && validator.isCommercial(),
     name: 'Is Paused',
     value: 'is_paused',
     type: 'is_paused',

package/helpers/taskFilter/statusFilter.js

@@ -141,6 +141,18 @@ module.exports.isEqual = (filter) => {
           ]
         }
       };
+    case 'paused':
+      return {
+        bool: {
+          must: [
+            {
+              term: {
+                is_paused: true
+              }
+            }
+          ]
+        }
+      };
     default:
       return null;
   }

package/index.d.ts

@@ -69,6 +69,11 @@ declare namespace Utils {
     ): any;
     export function buildSortScript(query?: Query, customSort?: any[]): any;
   }
+
+  namespace queries {
+    export function getIsPausedQuery(): any;
+    export function getNotIsPausedQuery(): any;
+  }
 }
 
 export = Utils;

package/index.js

@@ -3,11 +3,13 @@ const fieldConditions = require('./lib/fieldConditions');
 const taskPipeline = require('./lib/taskPipeline');
 const projectPipeline = require('./lib/projectPipeline');
 const usersPipeline = require('./lib/usersPipeline');
+const queries = require('./lib/queries');
 
 module.exports = {
   log,
   fieldConditions,
   taskPipeline,
   projectPipeline,
-  usersPipeline
+  usersPipeline,
+  queries
 };

package/lib/queries.js

@@ -0,0 +1,57 @@
+/**
+ * Generates an Elasticsearch query for filtering based on 'is_paused' equals to 'true'.
+ *
+ * @returns {Object} - Elasticsearch query object.
+ */
+module.exports.getIsPausedQuery = () => {
+  return  {
+    bool: {
+      must: [
+        {
+          term: {
+            is_paused: true
+          }
+        }
+      ]
+    }
+  };
+};
+
+/**
+ * Generates an Elasticsearch query for filtering based on 'is_paused' equal to 'false' or doesn't exist.
+ *
+ * @returns {Object} - Elasticsearch query object.
+ */
+module.exports.getNotIsPausedQuery = () => {
+  return {
+    bool: {
+      should: [
+        {
+          bool: {
+            must: [
+              {
+                exists: {
+                  field: 'is_paused'
+                }
+              },
+              {
+                match: {
+                  is_paused: false
+                }
+              }
+            ]
+          }
+        },
+        {
+          bool: {
+            must_not: {
+              exists: {
+                field: 'is_paused'
+              }
+            }
+          }
+        }
+      ]
+    }
+  };
+};

package/package.json

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

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

@@ -54,6 +54,23 @@ describe('taskFilter/statusFilter', function () {
         }
       }
     },
+    {
+      input: {
+        condition: 'is_equal',
+        field_id: '',
+        type: 'status',
+        field_type: 'select',
+        value: 'paused',
+        second_value: ''
+      },
+      output: {
+        bool: {
+          must: [
+            { term: { is_paused: true } }
+          ]
+        }
+      }
+    },
     {
       input: {
         condition: 'is_equal',
@@ -128,7 +145,7 @@ describe('taskFilter/statusFilter', function () {
         field_id: '',
         type: 'status',
         field_type: 'select',
-        value: 'new;on_hold',
+        value: 'new;on_hold;paused',
         second_value: ''
       },
       output: {
@@ -142,7 +159,8 @@ describe('taskFilter/statusFilter', function () {
                 ]
               }
             },
-            { bool: { must: [{ term: { on_hold: true } }] } }
+            { bool: { must: [{ term: { on_hold: true } }] } },
+            { bool: { must: [{ term: { is_paused: true } }] } }
           ]
         }
       }
@@ -153,7 +171,33 @@ describe('taskFilter/statusFilter', function () {
         field_id: '',
         type: 'status',
         field_type: 'select',
-        value: ['new', 'on_hold'],
+        value: 'new,on_hold,paused',
+        second_value: ''
+      },
+      output: {
+        bool: {
+          should: [
+            {
+              bool: {
+                must: [
+                  { term: { is_ready: false } },
+                  { term: { is_complete: false } }
+                ]
+              }
+            },
+            { bool: { must: [{ term: { on_hold: true } }] } },
+            { bool: { must: [{ term: { is_paused: true } }] } }
+          ]
+        }
+      }
+    },
+    {
+      input: {
+        condition: 'is_any_of',
+        field_id: '',
+        type: 'status',
+        field_type: 'select',
+        value: ['new', 'on_hold', 'paused'],
         second_value: ''
       },
       output: {
@@ -167,7 +211,8 @@ describe('taskFilter/statusFilter', function () {
                 ]
               }
             },
-            { bool: { must: [{ term: { on_hold: true } }] } }
+            { bool: { must: [{ term: { on_hold: true } }] } },
+            { bool: { must: [{ term: { is_paused: true } }] } }
           ]
         }
       }

package/test/lib/queries.spec.js

@@ -0,0 +1,65 @@
+'use strict';
+
+/* eslint-env node, mocha */
+const { expect } = require('chai');
+
+// To test
+const queries = require('../../lib/queries');
+
+describe('queries', function () {
+  describe('getIsPausedQuery', () => {
+    it('should return an \'is_paused\' query', () => {
+      const output = queries.getIsPausedQuery();
+
+      expect(output).to.be.deep.equal({
+        bool: {
+          must: [
+            {
+              term: {
+                is_paused: true
+              }
+            }
+          ]
+        }
+      });
+    });
+  });
+
+  describe('getNotIsPausedQuery', () => {
+    it('should return a \'not is_paused\' query', () => {
+      const output = queries.getNotIsPausedQuery();
+
+      expect(output).to.be.deep.equal({
+        bool: {
+          should: [
+            {
+              bool: {
+                must: [
+                  {
+                    exists: {
+                      field: 'is_paused'
+                    }
+                  },
+                  {
+                    match: {
+                      is_paused: false
+                    }
+                  }
+                ]
+              }
+            },
+            {
+              bool: {
+                must_not: {
+                  exists: {
+                    field: 'is_paused'
+                  }
+                }
+              }
+            }
+          ]
+        }
+      });
+    });
+  });
+});