@outliant/sunrise-utils 1.0.0 → 1.0.3

package/CHANGELOG.md

@@ -4,8 +4,30 @@ 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.0.3](https://github.com/outliant/sunrise-utils/compare/1.0.2...1.0.3)
+
+- chore: project pipeline filter query and sorting script #860pt9g1t [`533484f`](https://github.com/outliant/sunrise-utils/commit/533484fc97909d2ba45d425db57bc5942109c6f0)
+- chore: updated README [`62743ce`](https://github.com/outliant/sunrise-utils/commit/62743ce921655c3c1b64395268d3c1acf624071f)
+
+#### [1.0.2](https://github.com/outliant/sunrise-utils/compare/1.0.1...1.0.2)
+
+> 23 February 2023
+
+- chore(release): 1.0.2 [`499f9e5`](https://github.com/outliant/sunrise-utils/commit/499f9e5c633f6b85e413ff57905c46aba6adc16a)
+- chore: updated readme file [`97a2c96`](https://github.com/outliant/sunrise-utils/commit/97a2c96f3e88e7652bff68623e5ffb17e12db000)
+- chore: changed to private [`fa55dc4`](https://github.com/outliant/sunrise-utils/commit/fa55dc461a6fd9da40536e37a087f3832d78ba33)
+
+#### [1.0.1](https://github.com/outliant/sunrise-utils/compare/1.0.0...1.0.1)
+
+> 23 February 2023
+
+- chore(release): 1.0.1 [`c8a85ed`](https://github.com/outliant/sunrise-utils/commit/c8a85ed406be1d6475829ea0905478687c71278e)
+- chore: changed to private [`0f79a6b`](https://github.com/outliant/sunrise-utils/commit/0f79a6b4ebd9101d0d9ce523e23c3268a68a0bf1)
+
 #### 1.0.0
 
+> 23 February 2023
+
 - chore: task pipeline fixes #860pt9g1t [`#860`](https://github.com/outliant/sunrise-utils/issues/860)
 - chore: initial setup [`4e2206c`](https://github.com/outliant/sunrise-utils/commit/4e2206c5a002629fca7b608ed9cf6c60f3e6be37)
 - chore: task pipeline filter query and sorting script #860pt9g1t [`3bae8e1`](https://github.com/outliant/sunrise-utils/commit/3bae8e1aa6e02e6734ebaa6cdb3d822a7992aa21)

package/README.md

@@ -6,11 +6,28 @@ You have the following utils available:
 
 - `log`: Custom logging for sunrise projects
 - `fieldConditions`: Returns an array for sunrise column filters
-- `taskPipeline`: Class for task pipeline reusable codes
+- `taskPipeline`: Task pipeline reusable codes
   - `taskStatusOptions`: Array of task status column options
   - `defaultCustomColumns`: Array of task pipeline custom columns
-  - `buildFiltersQuery()`: Function to build task pipeline filter ES query
-  - `buildSortScript()`: Function to build task pipeline sort script
+  - `buildFiltersQuery(orgId, departmentId, filters = [], query = {}, searchFields = [])`: Function to build task pipeline filter ES query
+    - `orgId`: Organization ID
+    - `departmentId`: Department ID
+    - `filters`: Array of filters
+    - `query`: Query request params that includes `size`, `projectId`, `search`
+    - `searchFields`: Array of fields that the `search` will run against including the defaults
+  - `buildSortScript(query = {}, customSort = [])`: Function to build task pipeline sort script
+    - `query`: Query request params that includes `sort`, `sortBy`
+    - `customSort`: Array of custom ES sorting script that will be appended to the list of sorting script
+- `projectPipeline`: Project pipeline reusable codes
+  - `buildFiltersQuery(orgId, departmentId, filters = [], query = {}, searchFields = [])`: Function to build task pipeline filter ES query
+    - `orgId`: Organization ID
+    - `departmentId`: Department ID
+    - `filters`: Array of filters
+    - `query`: Query request params that includes `size`, `projectId`, `search`
+    - `searchFields`: Array of fields that the `search` will run against including the defaults
+  - `buildSortScript(query = {}, customSort = [])`: Function to build task pipeline sort script
+    - `query`: Query request params that includes `sort`, `sortBy`
+    - `customSort`: Array of custom ES sorting script that will be appended to the list of sorting script
 
 ## Installation
 

package/helpers/projectFilter/criticalPathFilter.js

@@ -0,0 +1,116 @@
+module.exports = (filter) => {
+  switch (filter.condition) {
+    case 'is_equal':
+      return module.exports.isEqual(filter);
+    case 'contains_any':
+      return module.exports.containsAny(filter);
+    case 'contains_none':
+    case 'not_equal':
+      return module.exports.containsNone(filter);
+    case 'greater_than_or_equal':
+      return module.exports.greaterThanOrEqual(filter);
+    case 'less_than_or_equal':
+      return module.exports.lessThanOrEqual(filter);
+
+    default:
+      return null;
+  }
+};
+
+module.exports.isEqual = (filter) => {
+  let value = filter.value;
+
+  if (typeof value === 'string') {
+    value = value.split(',');
+  }
+
+  return {
+    bool: {
+      must: value.map((x) => {
+        return {
+          term: {
+            'critical_path.stage_id': {
+              value: x
+            }
+          }
+        };
+      })
+    }
+  };
+};
+
+module.exports.containsAny = (filter) => {
+  let value = filter.value;
+
+  if (typeof value === 'string') {
+    value = value.split(',');
+  }
+
+  return {
+    bool: {
+      should: value.map((x) => {
+        return {
+          term: {
+            'critical_path.stage_id': {
+              value: x
+            }
+          }
+        };
+      })
+    }
+  };
+};
+
+module.exports.containsNone = (filter) => {
+  let value = filter.value;
+
+  if (typeof value === 'string') {
+    value = value.split(',');
+  }
+
+  return {
+    bool: {
+      must_not: value.map((x) => {
+        return {
+          term: {
+            'critical_path.stage_id': {
+              value: x
+            }
+          }
+        };
+      })
+    }
+  };
+};
+
+module.exports.greaterThanOrEqual = (filter) => {
+  let value = filter.value;
+
+  if (typeof value === 'string') {
+    value = parseInt(value);
+  }
+
+  return {
+    range: {
+      'critical_path.stage_index': {
+        gte: value
+      }
+    }
+  };
+};
+
+module.exports.lessThanOrEqual = (filter) => {
+  let value = filter.value;
+
+  if (typeof value === 'string') {
+    value = parseInt(value);
+  }
+
+  return {
+    range: {
+      'critical_path.stage_index': {
+        lte: value
+      }
+    }
+  };
+};

package/helpers/projectFilter/index.js

@@ -0,0 +1,27 @@
+const buildRegionFilter = require('./regionFilter');
+const buildCriticalPathFilter = require('./criticalPathFilter');
+const buildOnHoldFilter = require('./onHoldFilter');
+const buildIsGeneratedFilter = require('./isGeneratedFilter');
+const buildTagFilter = require('./tagFilter');
+const buildProjectFieldFilter = require('./projectFieldFilter');
+
+module.exports.buildProjectPipelineFilter = (filter) => {
+  switch (filter.type) {
+    case 'tags':
+      return buildTagFilter(filter);
+    case 'region':
+      return buildRegionFilter(filter);
+    case 'criticalPathStage':
+      return buildCriticalPathFilter(filter);
+    case 'on_hold':
+      return buildOnHoldFilter(filter);
+    case 'is_generated':
+      return buildIsGeneratedFilter(filter);
+    case 'dealPropertyMappings':
+    case 'ticketPropertyMappings':
+    case 'contactPropertyMappings':
+      return buildProjectFieldFilter(filter);
+    default:
+      return null;
+  }
+};

package/helpers/projectFilter/isGeneratedFilter.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_generated: true
+    }
+  };
+};
+
+module.exports.isNotEqual = () => {
+  return {
+    bool: {
+      should: [
+        {
+          match: {
+            is_generated: false
+          }
+        },
+        {
+          bool: {
+            must_not: {
+              exists: {
+                field: 'is_generated'
+              }
+            }
+          }
+        }
+      ]
+    }
+  };
+};

package/helpers/projectFilter/onHoldFilter.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 = (filter) => {
+  return {
+    match: {
+      on_hold: true
+    }
+  };
+};
+
+module.exports.isNotEqual = (filter) => {
+  return {
+    bool: {
+      should: [
+        {
+          match: {
+            on_hold: false
+          }
+        },
+        {
+          bool: {
+            must_not: {
+              exists: {
+                field: 'on_hold'
+              }
+            }
+          }
+        }
+      ]
+    }
+  };
+};

package/helpers/projectFilter/regionFilter.js

@@ -0,0 +1,56 @@
+module.exports = (filter) => {
+  switch (filter.condition) {
+    case 'contains_any':
+    case 'is_equal':
+      return module.exports.containsAny(filter);
+    case 'contains_none':
+    case 'not_equal':
+      return module.exports.containsNone(filter);
+    default:
+      return null;
+  }
+};
+
+module.exports.containsAny = (filter) => {
+  let value = filter.value;
+
+  if (typeof value === 'string') {
+    value = value.split(',');
+  }
+
+  return {
+    bool: {
+      should: value.map((x) => {
+        return {
+          term: {
+            region_id: {
+              value: x
+            }
+          }
+        };
+      })
+    }
+  };
+};
+
+module.exports.containsNone = (filter) => {
+  let value = filter.value;
+
+  if (typeof value === 'string') {
+    value = value.split(',');
+  }
+
+  return {
+    bool: {
+      must_not: value.map((x) => {
+        return {
+          term: {
+            region_id: {
+              value: x
+            }
+          }
+        };
+      })
+    }
+  };
+};

package/helpers/projectFilter/tagFilter.js

@@ -0,0 +1,81 @@
+module.exports = (filter) => {
+  switch (filter.condition) {
+    case 'contains_any':
+      return module.exports.containsAny(filter);
+    case 'contains_none':
+    case 'not_equal':
+      return module.exports.containsNone(filter);
+    case 'contains_all':
+    case 'is_equal':
+    case 'contains':
+      return module.exports.containsAll(filter);
+    default:
+      return null;
+  }
+};
+
+module.exports.containsAny = (filter) => {
+  let value = filter.value;
+
+  if (typeof value === 'string') {
+    value = value.split(',');
+  }
+
+  return {
+    bool: {
+      should: value.map((x) => {
+        return {
+          term: {
+            tag_ids: {
+              value: x
+            }
+          }
+        };
+      })
+    }
+  };
+};
+
+module.exports.containsNone = (filter) => {
+  let value = filter.value;
+
+  if (typeof value === 'string') {
+    value = value.split(',');
+  }
+
+  return {
+    bool: {
+      must_not: value.map((x) => {
+        return {
+          term: {
+            tag_ids: {
+              value: x
+            }
+          }
+        };
+      })
+    }
+  };
+};
+
+module.exports.containsAll = (filter) => {
+  let value = filter.value;
+
+  if (typeof value === 'string') {
+    value = value.split(',');
+  }
+
+  return {
+    bool: {
+      must: value.map((x) => {
+        return {
+          term: {
+            tag_ids: {
+              value: x
+            }
+          }
+        };
+      })
+    }
+  };
+};

package/helpers/searchFilter.js

@@ -38,9 +38,9 @@ module.exports = (query = {}, searchFields = []) => {
       });
     } else {
       should.push({
-        query_string: {
-          fields: localFields,
-          query: `${parsedQuery} OR *${parsedQuery.toLowerCase()}* OR *${parsedQuery.toUpperCase()}*`
+        multi_match: {
+          query: parsedQuery,
+          fields: localFields.map((x) => `${x}^5`)
         }
       });
     }

package/index.js

@@ -1,9 +1,11 @@
 const log = require('./lib/logger');
 const fieldConditions = require('./lib/fieldConditions');
 const taskPipeline = require('./lib/taskPipeline');
+const projectPipeline = require('./lib/projectPipeline');
 
 module.exports = {
   log,
   fieldConditions,
-  taskPipeline
+  taskPipeline,
+  projectPipeline
 };

package/lib/fieldConditions.js

@@ -17,12 +17,8 @@ module.exports.conditions = {
       value: 'is_not_empty'
     },
     {
-      label: 'Contains Any',
-      value: 'contains_any'
-    },
-    {
-      label: 'Contains None',
-      value: 'contains_none'
+      label: 'Is any of',
+      value: 'is_any_of'
     }
   ],
   textarea: [
@@ -43,12 +39,8 @@ module.exports.conditions = {
       value: 'is_not_empty'
     },
     {
-      label: 'Contains Any',
-      value: 'contains_any'
-    },
-    {
-      label: 'Contains None',
-      value: 'contains_none'
+      label: 'Is any of',
+      value: 'is_any_of'
     }
   ],
   number: [

package/lib/projectPipeline.js

@@ -0,0 +1,105 @@
+const { validate: isUuid } = require('uuid');
+const { buildProjectPipelineFilter } = require('../helpers/projectFilter');
+const searchFilter = require('../helpers/searchFilter');
+const sortScript = require('../helpers/sortScript');
+
+class ProjectPipeline {
+  buildFiltersQuery(
+    orgId,
+    departmentId,
+    filters = [],
+    query = {},
+    searchFields = []
+  ) {
+    const mustQuery = [
+      {
+        term: {
+          organization_id: {
+            value: orgId
+          }
+        }
+      },
+      {
+        term: {
+          department_id: {
+            value: departmentId
+          }
+        }
+      }
+    ];
+
+    if (query.search && query.search.length > 0) {
+      const should = searchFilter(query, searchFields);
+
+      if (should.length > 0) {
+        mustQuery.push({
+          bool: {
+            should
+          }
+        });
+      }
+    }
+
+    if (!filters.length) {
+      return {
+        bool: {
+          must: mustQuery
+        }
+      };
+    }
+
+    for (const filter of filters) {
+      const queryFilter = buildProjectPipelineFilter(filter);
+
+      if (queryFilter) {
+        mustQuery.push(queryFilter);
+      }
+    }
+
+    return { bool: { must: mustQuery } };
+  }
+
+  buildSortScript(query = {}, customSort = []) {
+    const sort = query.sort || 'desc';
+    const sortBy = query.sortBy || 'created_at';
+    const sortByMultiple = sortBy.split(',');
+    const projectPipelinesSort = [];
+
+    if (sortByMultiple.length > 0) {
+      sortByMultiple.forEach((s) => {
+        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: query.sort, missing: '_last' }
+          });
+        } else {
+          projectPipelinesSort.push({
+            [s]: { order: query.sort, missing: '_last' }
+          });
+        }
+      });
+    }
+
+    if (customSort.length > 0) {
+      customSort.forEach((cSort) => projectPipelinesSort.push(cSort));
+    }
+
+    if (!!query.search) {
+      projectPipelinesSort.unshift({
+        _score: {
+          order: 'desc'
+        }
+      });
+    }
+
+    return projectPipelinesSort;
+  }
+}
+
+module.exports = new ProjectPipeline();

package/lib/taskPipeline.js

@@ -6,7 +6,7 @@ const {
   buildTaskPipelineFilter
 } = require('../helpers/taskFilter');
 const searchFilter = require('../helpers/searchFilter');
-const taskSortScript = require('../helpers/taskSortScript');
+const sortScript = require('../helpers/sortScript');
 
 class TaskPipeline {
   taskStatusOptions = taskStatusOptions;
@@ -91,29 +91,29 @@ class TaskPipeline {
 
     if (sortByMultiple.length > 0) {
       if (sortByMultiple[0] === 'default') {
-        taskPipelinesSort = taskSortScript.default;
+        taskPipelinesSort = sortScript.default;
       } else {
         sortByMultiple.forEach((s) => {
           if (s === 'region') {
-            taskPipelinesSort.push(taskSortScript.region(sort));
+            taskPipelinesSort.push(sortScript.region(sort));
           } else if (s === 'owner' || s === 'completed_by') {
-            taskPipelinesSort.push(taskSortScript.owner(sort));
+            taskPipelinesSort.push(sortScript.owner(sort));
           } else if (s === 'status') {
-            taskPipelinesSort.push(taskSortScript.status(sort));
+            taskPipelinesSort.push(sortScript.status(sort));
           } else if (s === 'critical_path_stage') {
-            taskPipelinesSort.push(taskSortScript.criticalPathStage(sort));
+            taskPipelinesSort.push(sortScript.criticalPathStage(sort));
           } else if (s === 'project_id') {
             // Sort numeric part of the Project ID
-            taskPipelinesSort.push(taskSortScript.projectId(sort));
+            taskPipelinesSort.push(sortScript.projectId(sort));
           } else if (s === 'ready_at') {
-            taskPipelinesSort.push(taskSortScript.readyAt(sort));
+            taskPipelinesSort.push(sortScript.readyAt(sort));
           } else if (s === 'was_marked_incomplete') {
-            taskPipelinesSort.push(taskSortScript.wasMarkedIncomplete(sort));
+            taskPipelinesSort.push(sortScript.wasMarkedIncomplete(sort));
           } else if (s === 'last_comment_date') {
-            taskPipelinesSort.push(taskSortScript.lastCommentDate(sort));
+            taskPipelinesSort.push(sortScript.lastCommentDate(sort));
           } else if (isUuid(s)) {
-            taskPipelinesSort.push(taskSortScript.projectFieldNumeric(sort, s));
-            taskPipelinesSort.push(taskSortScript.projectFieldText(sort, s));
+            taskPipelinesSort.push(sortScript.projectFieldNumeric(sort, s));
+            taskPipelinesSort.push(sortScript.projectFieldText(sort, s));
           } else {
             taskPipelinesSort.push({
               [s]: { order: sort, missing: '_last' }
@@ -123,7 +123,7 @@ class TaskPipeline {
       }
     } else {
       // Default sorting
-      taskPipelinesSort = taskSortScript.default;
+      taskPipelinesSort = sortScript.default;
     }
 
     if (customSort.length > 0) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@outliant/sunrise-utils",
   "description": "Helper functions for project Sunrise",
-  "version": "1.0.0",
+  "version": "1.0.3",
   "license": "ISC",
   "author": "Outliant",
   "main": "index.js",
@@ -66,8 +66,5 @@
   "dependencies": {
     "moment": "^2.29.4",
     "uuid": "^9.0.0"
-  },
-  "publishConfig": {
-    "access": "public"
   }
 }