@capillarytech/cap-ui-utils 3.0.7-alpha.1 → 3.0.7-alpha.3

package/index.js

@@ -11,3 +11,4 @@ export { default as compileHandlebars } from './utils/compileHandlebars';
 export { default as sanitizeTemplateWithRegexp } from "./utils/contentSanitizationHelper";
 export { default as decompressJsonObject } from "./utils/zlibDataDecompress";
 export { default as getEnvVariable } from "./utils/getEnvVariables";
+export { formatDateWithTimezone, getTimezoneTooltip } from "./utils/timezone";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@capillarytech/cap-ui-utils",
-  "version": "3.0.7-alpha.1",
+  "version": "3.0.7-alpha.3",
   "description": "Utility functions shared accross all the modules",
   "main": "index.js",
   "scripts": {

package/utils/timezone.js

@@ -0,0 +1,91 @@
+import moment from "moment-timezone";
+import * as utilsLocalStorageApi from "./utilsLocalStorageApi";
+
+export const DATE_FORMAT = "DD MMM YYYY h:mm A";
+
+/**
+ * Formats a date into "DD MMM YYYY h:mm A <TZ>" format.
+ * Handles ISO strings and epoch timestamps.
+ *
+ * - ISO input:
+ *    - orgTZ=false → keep ISO timezone info
+ *    - orgTZ=true  → convert to org timezone 
+ * - Epoch input:
+ *    - Always converts to org timezone 
+ *
+ * @param {string|number|Date} date - ISO string, epoch (sec/ms), or Date object.
+ * @param {boolean} orgTZ - Whether to force conversion into org timezone.
+ * @returns {string} Formatted date string with strict TZ abbreviation or '-'.
+ */
+export const formatDateWithTimezone = (date, orgTZ = false) => {
+  if (!date) return "-";
+
+  let momentDate;
+  const orgTimezone = utilsLocalStorageApi.loadItem("orgTZ") || "Asia/Kolkata";
+
+  // Epoch (number or numeric string)
+  if (typeof date === "number" || (typeof date === "string" && /^\d+$/.test(date))) {
+    const timestamp = typeof date === "string" ? parseInt(date, 10) : date;
+    const timestampMs = timestamp < 1e12 ? timestamp * 1000 : timestamp; 
+    momentDate = moment.tz(timestampMs, orgTimezone);
+  } 
+  // ISO string or Date object
+  else {
+    momentDate = moment(date);
+    if (orgTZ) {
+      momentDate = momentDate.tz(orgTimezone);
+    }
+  }
+
+  if (!momentDate.isValid()) return "-";
+
+  // Get strict timezone abbreviation (no offsets like GMT+05:30)
+  let tzAbbr = momentDate.format("z");
+  if (/GMT[+-]\d+/.test(tzAbbr)) {
+    const tz = momentDate.tz() || orgTimezone || "UTC";
+    tzAbbr = moment.tz.zone(tz)?.abbr(momentDate.valueOf()) || "UTC";
+  }
+
+  return `${momentDate.format(DATE_FORMAT)} ${tzAbbr}`;
+}
+
+/**
+ * Returns a tooltip string with the timezone and offset for a given date.
+ * 
+ * - Epoch input:
+ *    - Always uses orgTZ
+ * - ISO input:
+ *    - orgTZ=false → keep ISO timezone info
+ *    - orgTZ=true  → convert to org timezone (orgTZ)
+ *
+ * @param {string|number|Date} date - ISO string, epoch (sec/ms), or Date object.
+ * @param {boolean} orgTZ - Whether to force conversion into org timezone.
+ * @returns {string} Tooltip string with timezone and offset.
+ */
+export const getTimezoneTooltip = (date, orgTZ = false) => {
+  const orgTimezone = utilsLocalStorageApi.loadItem("orgTZ") || "Asia/Kolkata";
+
+  // Case 1: Epoch number or numeric string
+  if (typeof date === "number" || (typeof date === "string" && /^\d+$/.test(date))) {
+    return `Timezone: ${orgTimezone} (UTC${moment.tz(orgTimezone).format("Z")})`;
+  }
+
+  // Case 2: orgTZ = true → always use orgTZ
+  if (orgTZ) {
+    return `Timezone: ${orgTimezone} (UTC${moment.tz(orgTimezone).format("Z")})`;
+  }
+
+  // Case 3: Try parsing ISO or custom string
+  let m = moment.parseZone(date); // handles ISO strings like 2025-08-12T23:59:59.000Z
+
+  if (!m.isValid()) {
+    m = moment.tz(date, "DD MMM YYYY h:mm A z");
+  }
+
+  // If still invalid → fallback to orgTZ
+  if (!m.isValid()) {
+    return `Timezone: ${orgTimezone} (UTC${moment.tz(orgTimezone).format("Z")})`;
+  }
+
+  return `Timezone: ${m.tz() || orgTimezone} (UTC${m.format("Z")})`;
+};