@go-mailer/jarvis 5.0.4 → 5.0.5

package/index.js

@@ -1,20 +1,22 @@
-const EnvVar = require('./lib/env')
-const FeatureFlag = require('./lib/flag')
-const Redis = require('./lib/redis/index')
-const QueryBuilder = require('./lib/query')
-const HTTP = require('./lib/middlewares/http')
-const Authenticator = require('./lib/middlewares/auth')
-const AutomationConstants = require('./lib/constants/automation')
-const { RequestLogger, ProcessLogger } = require('./lib/middlewares/logger')
+const EnvVar = require("./lib/env");
+const FeatureFlag = require("./lib/flag");
+const Redis = require("./lib/redis/index");
+const QueryBuilder = require("./lib/query");
+const HTTP = require("./lib/middlewares/http");
+const Authenticator = require("./lib/middlewares/auth");
+const AutomationConstants = require("./lib/constants/automation");
+const { RequestLogger, ProcessLogger } = require("./lib/middlewares/logger");
+const Utility = require("./lib/utilitiy/index");
 
-module.exports = { 
+module.exports = {
   Authenticator,
   AutomationConstants,
   EnvVar,
   FeatureFlag,
   HTTP,
   ProcessLogger,
-  RequestLogger,
   QueryBuilder,
-  Redis
-}
+  Redis,
+  RequestLogger,
+  Utility,
+};

package/lib/utilitiy/chart.js

@@ -0,0 +1,69 @@
+const processRangeInDays = (min = 0, seconds_in_day = 86400000) => {
+  const ranges = [];
+  let x = min;
+  for (let i = 0; i < 31; i++) {
+    const [, mmm, dd] = new Date(x).toDateString().split(" ");
+    ranges.push({ start: x, end: x + seconds_in_day - 1000, label: `${mmm} ${dd}` });
+    x += seconds_in_day;
+  }
+
+  return ranges;
+};
+
+const processRangeInWeeks = (min = 0, seconds_in_day = 86400000) => {
+  const ranges = [];
+  let x = min;
+  const [, mmm, dd] = new Date(x).toDateString().split(" ");
+  for (let i = 0; i < Math.ceil(100 / 7); i++) {
+    ranges[i] = {
+      start: x,
+      end: x + 6 * seconds_in_day - 1000,
+      label: `${mmm} ${dd}`,
+    };
+    x += 6 * seconds_in_day;
+  }
+
+  return ranges;
+};
+
+const processRangeInMonths = (min, max) => {
+  // group in months
+  const d = new Date(min);
+  const year = d.getFullYear();
+  const month = d.getUTCMonth();
+
+  const ranges = [];
+  let x = min;
+  for (let i = 1; x <= max; i++) {
+    const [, mmm, , yyyy] = new Date(x).toDateString().split(" ");
+    ranges.push({
+      start: x,
+      end: Date.parse(new Date(year, month + i, 1)) - 1000,
+      label: `${mmm} ${yyyy}`,
+    });
+
+    x = Date.parse(new Date(year, month + i, 1));
+  }
+
+  return ranges;
+};
+
+module.exports = {
+  processDateRange: (start, stop) => {
+    const min = Date.parse(start);
+    const max = Date.parse(stop);
+    const difference = max - min;
+    const seconds_in_day = 86400000;
+
+    let ranges = [];
+    if (difference / seconds_in_day <= 31) {
+      ranges = processRangeInDays(min, seconds_in_day);
+    } else if (difference / seconds_in_day <= 100) {
+      ranges = processRangeInWeeks(min, seconds_in_day);
+    } else {
+      ranges = processRangeInMonths(min, max);
+    }
+
+    return ranges;
+  },
+};

package/lib/utilitiy/date.js

@@ -0,0 +1,204 @@
+/** */
+const MONTH_MAP = ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"];
+const NUM_OF_MILLISECONDS_IN_ONE_DAY = 86400000;
+
+/** */
+const convertDateFromIsoToHTMLFormat = (iso_date) => {
+  const date = new Date(iso_date);
+  const day = padDateValue(date.getDate());
+  const month = padDateValue(date.getMonth() + 1);
+  const year = date.getFullYear();
+
+  const converted_date = `${year}-${month}-${day}`;
+  return iso_date ? converted_date : "";
+};
+
+/**
+ * Extracts day string of the given timestamp for graphs. Return ex. 'Jan 10'
+ * @param {Number} timestamp
+ */
+const extractDayStringForGraph = (timestamp) => {
+  const date = new Date(timestamp);
+  const month = MONTH_MAP[date.getMonth()];
+  const day = padDateValue(date.getDate());
+
+  return `${month} ${day}`;
+};
+
+const generateHTMLFormDateTimeDefaults = () => {
+  const date = new Date().toISOString();
+  const generated_date = `${convertDateFromIsoToHTMLFormat(date)}`;
+  return generated_date;
+};
+
+/**
+ * Generates a configuration of back-counted days starting from a base time.
+ *
+ * @param {*} base_timestamp The day to start back count
+ * @param {*} spread The numbers of days to count back.
+ */
+const generateDaysConfigurationForGraph = (base_timestamp, spread = 7, key_values) => {
+  let curr_timestamp = getDayTimestampForRawTimestamp(base_timestamp);
+  const config = {};
+  for (let i = 0; i < spread; i++) {
+    const date_string = extractDayStringForGraph(curr_timestamp);
+    // key_values = [subscribers , unsubscribers]; [opens, bounces]
+    config[date_string] = {
+      date: date_string,
+      [key_values[0]]: 0,
+      [key_values[1]]: 0,
+    };
+    curr_timestamp -= NUM_OF_MILLISECONDS_IN_ONE_DAY;
+  }
+  return config;
+};
+
+/**
+ * Generates the number of milliseconds at (12:00AM) for the date specified in the raw_timestamp.
+ *
+ * @param {Number} raw_timestamp number of milliseconds
+ */
+const getDayTimestampForRawTimestamp = (raw_timestamp) => {
+  const date = new Date(raw_timestamp);
+  const day = `${padDateValue(date.getMonth() + 1)}/${padDateValue(date.getDate())}/${date.getFullYear()}`;
+  return Date.parse(day);
+};
+
+/**
+ * Get the timestamp of the first and last days of the month
+ */
+
+const getMonthTimeRange = () => {
+  const year = new Date().getFullYear();
+  const current_month = new Date().getMonth();
+  const start = Date.parse(new Date(year, current_month, 1));
+  const end = Date.parse(new Date(year, current_month + 1, 1)) - 1000;
+
+  return { start, end };
+};
+
+/**
+ * Get today's midnight time stamp
+ */
+
+const getCurrentDayTimestamp = () => {
+  const date = new Date();
+  const year = date.getFullYear();
+  const month = padDateValue(date.getMonth() + 1);
+  const day = padDateValue(date.getDate());
+  const date_string = `${year}-${month}-${day}`;
+  return Date.parse(date_string);
+};
+
+/**
+ * prefixes 0 on numbers with single digits.
+ * @param {Number} value
+ */
+const padDateValue = (value) => {
+  return value < 10 ? `0${value}` : value;
+};
+
+const isCampaignSendDateValid = (chosen_date) => {
+  const today = new Date().toDateString();
+  return new Date(`${chosen_date}`) >= new Date(today);
+};
+
+const toDateString = (date = "") => {
+  if (!date) return "";
+  return new Date(date).toDateString();
+};
+
+const formatDateWithoutDayOfWeek = (date = "") => {
+  if (!date) return "";
+  const options = { year: "numeric", month: "short", day: "numeric" };
+  return new Date(date).toLocaleDateString(undefined, options);
+};
+
+const formatDateForDisplay = (raw_value) => {
+  const date = new Date(raw_value);
+  if (!raw_value || !date) return raw_value;
+  const [, mon, day, year, time] = date.toString().split(" ");
+  return [mon, `${day},`, year, time].join(" ");
+};
+
+const toTimeString = (date = "") => {
+  if (!date) return "";
+  const options = {
+    hour: "numeric",
+    minute: "numeric",
+    hour12: true,
+  };
+  return new Date(date).toLocaleTimeString("en-US", options);
+};
+
+const generateDefaultRange = () => {
+  const [today] = new Date().toISOString().split("T");
+  const [thirty_days_ago] = new Date(Date.parse(today) - 30 * 86400000).toISOString().split("T");
+  return [thirty_days_ago, today];
+};
+
+/**
+ *
+ * @param {Number} year
+ * @returns {startDate, endDate}
+ */
+const getYearRange = (year) => {
+  const startDate = new Date(year, 0, 1).getTime(); // January 1st
+  const endDate = new Date(year, 11, 31).getTime() + 86400000 - 1; // December 31st (23:59:59)
+  return { startDate, endDate };
+};
+
+const getMonthTimestamps = (year) => {
+  const timestamps = [];
+
+  for (let month = 0; month < 12; month++) {
+    const startDate = new Date(year, month, 1);
+    const endDate = new Date(year, month + 1, 0, 23, 59, 59, 999); // Last day of the month
+
+    timestamps.push({
+      start: startDate.getTime(),
+      end: endDate.getTime(),
+    });
+  }
+
+  return timestamps;
+};
+
+const getMonthNameFromTimestamp = (timestamp) => {
+  const date = new Date(timestamp);
+  const months = [
+    "January",
+    "February",
+    "March",
+    "April",
+    "May",
+    "June",
+    "July",
+    "August",
+    "September",
+    "October",
+    "November",
+    "December",
+  ];
+  return months[date.getMonth()];
+};
+
+module.exports = {
+  convertDateFromIsoToHTMLFormat,
+  extractDayStringForGraph,
+  formatDateForDisplay,
+  formatDateWithoutDayOfWeek,
+  generateDaysConfigurationForGraph,
+  generateHTMLFormDateTimeDefaults,
+  getCurrentDayTimestamp,
+  getDayTimestampForRawTimestamp,
+  generateDefaultRange,
+  getMonthTimeRange,
+  isCampaignSendDateValid,
+  padDateValue,
+  toDateString,
+  toTimeString,
+  getYearRange,
+  getMonthTimestamps,
+  getMonthNameFromTimestamp,
+};

package/lib/utilitiy/index.js

@@ -0,0 +1,9 @@
+const Chart = require("./chart");
+const Date = require("./date");
+const Number = require("./number");
+
+module.exports = {
+  Chart,
+  Date,
+  Number,
+};

package/lib/utilitiy/number.js

@@ -0,0 +1,7 @@
+module.exports = {
+  toReadableNumber: (value) => {
+    if (!value) return 0;
+    if (isNaN(value)) return value;
+    return Number(Number(value).toFixed(2)).toLocaleString();
+  },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@go-mailer/jarvis",
-  "version": "5.0.4",
+  "version": "5.0.5",
   "main": "index.js",
   "repository": "git@github.com:go-mailer-ltd/jarvis-node.git",
   "author": "Nathan Oguntuberu <nateoguns.work@gmail.com>",