@outliant/sunrise-utils 1.0.0

package/helpers/taskSortScript.js

@@ -0,0 +1,356 @@
+module.exports.default = [
+  // Pending tasks should first be sorted by their age, in descending numerical order.
+  // Changed the default task sort order to be based on pending age oldest > newest
+  {
+    _script: {
+      type: 'number',
+      script: {
+        lang: 'painless',
+        source: `
+          try {
+            boolean isReady = doc['is_ready'].value;
+            boolean isComplete = doc['is_complete'].value;
+
+            if (isReady == true && isComplete == false) {
+              return 1;
+            }
+
+            return 0;
+          } catch (Exception err) {
+            return 0;
+          }
+        `
+      },
+      order: 'desc'
+    }
+  },
+  // Then, they should be sorted by their task name, in ascending alphabetical order.
+  {
+    _script: {
+      type: 'string',
+      script: {
+        lang: 'painless',
+        source: `
+          try {
+            boolean isReady = doc['is_ready'].value;
+            boolean isComplete = doc['is_complete'].value;
+
+            if (isReady == true && isComplete == false) {
+              return doc['name'].value.raw;
+            }
+
+            return 'zzzzzzzz';
+          } catch (Exception err) {
+            return 'zzzzzzzz';
+          }
+        `
+      },
+      order: 'asc'
+    }
+  },
+  // Completed tasks should first be sorted by their task name in ascending alphabetical order
+  {
+    _script: {
+      type: 'number',
+      script: {
+        lang: 'painless',
+        source: `
+          try {
+            boolean isReady = doc['is_ready'].value;
+            boolean isComplete = doc['is_complete'].value;
+
+            if (isReady == true && isComplete == true) {
+              return 1;
+            }
+
+            return 0;
+          } catch (Exception err) {
+            return 0;
+          }
+        `
+      },
+      order: 'desc'
+    }
+  },
+  {
+    _script: {
+      type: 'string',
+      script: {
+        lang: 'painless',
+        source: `
+          try {
+            boolean isReady = doc['is_ready'].value;
+            boolean isComplete = doc['is_complete'].value;
+
+            if (isReady == true && isComplete == true) {
+              return doc['name'].value.raw;
+            }
+
+            return 'zzzzzzzz';
+          } catch (Exception err) {
+            return 'zzzzzzzz';
+          }
+        `
+      },
+      order: 'asc'
+    }
+  },
+  // and then by their completion date in descending chronological order.
+  {
+    _script: {
+      type: 'number',
+      script: {
+        lang: 'painless',
+        source: `
+          try {
+            boolean isReady = doc['is_ready'].value;
+            boolean isComplete = doc['is_complete'].value;
+
+            if (isReady == true && isComplete == true) {
+              return doc['completed_at'].value.millis;
+            }
+
+            return 0;
+          } catch (Exception err) {
+            return 0;
+          }
+        `
+      },
+      order: 'desc'
+    }
+  },
+  // New tasks should be sorted by their name in ascending alphabetical order
+  {
+    'name.raw': { order: 'asc' }
+  },
+  // Use task id as tiebreaker
+  {
+    id: { order: 'asc' }
+  }
+];
+
+module.exports.region = (order) => {
+  return {
+    region_name: {
+      order
+    }
+  };
+};
+
+module.exports.lastCommentDate = (order) => {
+  return {
+    'last_comment_data.created_at': {
+      order
+    }
+  };
+};
+
+module.exports.owner = (order) => {
+  return {
+    _script: {
+      type: 'string',
+      script: {
+        lang: 'painless',
+        source: `
+        try {
+          String owner = doc['owner'].value;
+
+          if (owner != '' && owner != null) {
+            return owner.toLowerCase();
+          }
+        } catch (Exception err) {}
+
+        return '';
+      `
+      },
+      order
+    }
+  };
+};
+
+module.exports.status = (order) => {
+  return {
+    _script: {
+      type: 'string',
+      script: {
+        lang: 'painless',
+        source: `
+        try {
+          boolean isReady = doc['is_ready'].value;
+          boolean isComplete = doc['is_complete'].value;
+
+          if (isReady == true) {
+            if (isComplete == true) {
+              return 'completed';
+            }
+
+            return 'pending';
+          }
+
+          return 'new';
+        } catch (Exception err) {
+          return '';
+        }
+      `
+      },
+      order
+    }
+  };
+};
+
+module.exports.criticalPathStage = (order) => {
+  return {
+    _script: {
+      type: 'number',
+      script: {
+        lang: 'painless',
+        source: `
+        try {
+          def stageIndex = doc['critical_path.stage_index'].value;
+          if (stageIndex != null) {
+            return stageIndex;
+          }
+          
+          return 9999999;
+        } catch (Exception err) {
+          return 9999999;
+        }
+      `
+      },
+      order
+    }
+  };
+};
+
+module.exports.projectId = (order) => {
+  return {
+    _script: {
+      type: 'number',
+      script: {
+        lang: 'painless',
+        source: `
+        def projectNumber = params._source.project_id;
+        projectNumber = /[^0-9]/.matcher(projectNumber).replaceAll('');
+        return Integer.parseInt(projectNumber);
+      `
+      },
+      order
+    }
+  };
+};
+
+module.exports.readyAt = (order) => {
+  return {
+    _script: {
+      type: 'number',
+      script: {
+        lang: 'painless',
+        source: `
+        try {
+          boolean isReady = doc['is_ready'].value;
+          boolean isComplete = doc['is_complete'].value;
+
+          if (isReady == true && isComplete == true && doc.containsKey('completed_at') && !doc['completed_at'].empty) {
+            return doc['completed_at'].value.millis;
+          } else if (isReady == true && doc.containsKey('ready_at') && !doc['ready_at'].empty) {
+            return doc['ready_at'].value.millis;
+          }
+
+          return doc['created_at'].value.millis;
+        } catch (Exception err) {
+          return 0;
+        }
+      `
+      },
+      order
+    }
+  };
+};
+
+module.exports.wasMarkedIncomplete = (order) => {
+  return {
+    _script: {
+      type: 'number',
+      script: {
+        lang: 'painless',
+        source: `
+        return doc['was_marked_incomplete'].empty
+          ? 0
+          : doc['was_marked_incomplete'].value ? 1 : 0;
+      `
+      },
+      order
+    }
+  };
+};
+
+module.exports.projectFieldNumeric = (order, value) => {
+  return {
+    _script: {
+      type: 'number',
+      script: {
+        lang: 'painless',
+        source: `
+        try {
+          def fields = params._source.fields;
+
+          for (int i=0; i<fields.size(); i++) {
+            if (fields[i].id.equals(params.value)) {
+              if (fields[i].number != null) {
+                return fields[i].number;
+              } else {
+                return -999999;
+              }
+            }
+          }
+
+          return -999999;
+        } catch (Exception err) {
+          return -999999;
+        }
+      `,
+        params: {
+          value
+        }
+      },
+      order
+    }
+  };
+};
+
+module.exports.projectFieldText = (order, value) => {
+  return {
+    _script: {
+      type: 'string',
+      script: {
+        lang: 'painless',
+        source: `
+        try {
+          String textInfo = '';
+          def fields = params._source.fields;
+
+          for (int i=0; i<fields.size(); i++) {
+            if (fields[i].id.equals(params.value)) {
+
+              if (fields[i].number != null) {
+                return '';
+              }
+              
+              textInfo = fields[i].text == null ? '' : fields[i].text;
+            }
+
+          }
+
+          return textInfo;
+        } catch (Exception err) {
+          return '';
+        }
+      `,
+        params: {
+          value
+        }
+      },
+      order
+    }
+  };
+};

package/index.d.ts

@@ -0,0 +1,11 @@
+declare namespace Utils {
+  namespace log {
+    export function info(msg: any): void;
+
+    export function warn(msg: any): void;
+
+    export function error(msg: any): void;
+  }
+}
+
+export = Utils;

package/index.js

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

package/lib/fieldConditions.js

@@ -0,0 +1,166 @@
+module.exports.conditions = {
+  text: [
+    {
+      label: 'Equals',
+      value: 'is_equal'
+    },
+    {
+      label: "Doesn't Equal",
+      value: 'not_equal'
+    },
+    {
+      label: 'Is Empty',
+      value: 'is_empty'
+    },
+    {
+      label: 'Is Not Empty',
+      value: 'is_not_empty'
+    },
+    {
+      label: 'Contains Any',
+      value: 'contains_any'
+    },
+    {
+      label: 'Contains None',
+      value: 'contains_none'
+    }
+  ],
+  textarea: [
+    {
+      label: 'Equals',
+      value: 'is_equal'
+    },
+    {
+      label: "Doesn't Equal",
+      value: 'not_equal'
+    },
+    {
+      label: 'Is Empty',
+      value: 'is_empty'
+    },
+    {
+      label: 'Is Not Empty',
+      value: 'is_not_empty'
+    },
+    {
+      label: 'Contains Any',
+      value: 'contains_any'
+    },
+    {
+      label: 'Contains None',
+      value: 'contains_none'
+    }
+  ],
+  number: [
+    {
+      label: 'Equals',
+      value: 'is_equal'
+    },
+    {
+      label: "Doesn't Equal",
+      value: 'not_equal'
+    },
+    {
+      label: 'Greater Than',
+      value: 'greater_than'
+    },
+    {
+      label: 'Less Than',
+      value: 'less_than'
+    },
+    {
+      label: 'Greater Than or Equal To',
+      value: 'greater_than_or_equal'
+    },
+    {
+      label: 'Less Than or Equal To',
+      value: 'less_than_or_equal'
+    },
+    {
+      label: 'Between',
+      value: 'between'
+    },
+    {
+      label: 'Is Empty',
+      value: 'is_empty'
+    },
+    {
+      label: 'Is Not Empty',
+      value: 'is_not_empty'
+    }
+  ],
+  checkbox: [
+    {
+      label: 'Contains',
+      value: 'is_equal'
+    },
+    {
+      label: "Doesn't Contains",
+      value: 'not_equal'
+    },
+    {
+      label: 'Is Empty',
+      value: 'is_empty'
+    },
+    {
+      label: 'Is Not Empty',
+      value: 'is_not_empty'
+    }
+  ],
+  select: [
+    {
+      label: 'Equals',
+      value: 'is_equal'
+    },
+    {
+      label: "Doesn't Equal",
+      value: 'not_equal'
+    },
+    {
+      label: 'Is Empty',
+      value: 'is_empty'
+    },
+    {
+      label: 'Is Not Empty',
+      value: 'is_not_empty'
+    },
+    {
+      label: 'Is any of',
+      value: 'is_any_of'
+    }
+  ],
+  date: [
+    {
+      label: 'Equals',
+      value: 'is_equal'
+    },
+    {
+      label: "Doesn't Equal",
+      value: 'not_equal'
+    },
+    {
+      label: 'Before',
+      value: 'before'
+    },
+    {
+      label: 'After',
+      value: 'after'
+    },
+    {
+      label: 'Between',
+      value: 'between'
+    },
+    {
+      label: 'Is Empty',
+      value: 'is_empty'
+    },
+    {
+      label: 'Is Not Empty',
+      value: 'is_not_empty'
+    }
+  ]
+};
+
+module.exports.getConditions = (filedType) => {
+  return module.exports.conditions[filedType];
+};

package/lib/logger.js

@@ -0,0 +1,48 @@
+/* eslint-disable no-console */
+
+/**
+ * Logs an info message.
+ * Takes either a string or a JSON object. And prepends [INFO]: to the message.
+ * If the input is a string it will be places within a JSON object in the Message property.
+ */
+const info = (message) => {
+  if (typeof message === 'string') {
+    console.info('[INFO]:\n' + JSON.stringify({ Message: message }, null, 4));
+  } else {
+    console.info('[INFO]:\n' + JSON.stringify(message, null, 4));
+  }
+};
+
+/**
+ * Logs a warning message.
+ * Takes either a string or a JSON object. And prepends [WARNING]: to the message.
+ * If the input is a string it will be places within a JSON object in the Message property.
+ */
+const warn = (message) => {
+  if (typeof message === 'string') {
+    console.warn(
+      '[WARNING]:\n' + JSON.stringify({ Message: message }, null, 4)
+    );
+  } else {
+    console.warn('[WARNING]:\n' + JSON.stringify(message, null, 4));
+  }
+};
+
+/**
+ * Logs an error message.
+ * Takes either a string or a JSON object. And prepends [ERROR]: to the message.
+ * If the input is a string it will be places within a JSON object in the Message property.
+ */
+const error = (message) => {
+  if (typeof message === 'string') {
+    console.error('[ERROR]:\n' + JSON.stringify({ Message: message }, null, 4));
+  } else {
+    console.error('[ERROR]:\n' + JSON.stringify(message, null, 4));
+  }
+};
+
+module.exports = {
+  info,
+  warn,
+  error
+};