@capillarytech/cap-ui-utils 3.0.9-alpha.1 → 3.0.9-alpha.2

package/package.json

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

package/utils/constants.js

@@ -105,4 +105,10 @@ export const TMPL_SANITIZE_FORBIDDEN_JS_TAGS = [
   "vbscript:",
   "livescript:",
   "xss:",
-];
+];
+
+/**
+ * Constants for timezone feature
+ */
+export const TIMEZONE_ENABLED = "TIMEZONE_ENABLED";
+export const DATE_FORMAT = "DD MMM YYYY h:mm A";

package/utils/timezone.js

@@ -1,62 +1,62 @@
 import moment from "moment-timezone";
 import * as utilsLocalStorageApi from "./utilsLocalStorageApi";
+import { DATE_FORMAT,TIMEZONE_ENABLED } from "./constants";
+import hasFeatureAccess from "../auth/hasFeatureAccess";
 
-export const DATE_FORMAT = "DD MMM YYYY h:mm A";
+const getTimezoneFormattedDate = (date,orgTZ = false,serverTZ = false,customTZ = null) => {
+  const orgTimezone = utilsLocalStorageApi.loadItem("orgTZ") || "Asia/Kolkata";
+  const serverTimezone = utilsLocalStorageApi.loadItem("serverTZ") || "Asia/Kolkata";
+  const targetTimezone = customTZ || (serverTZ ? serverTimezone : orgTZ ? orgTimezone : orgTimezone);
+  let momentDate;
+
+  // If date is 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.utc(timestampMs).tz(targetTimezone);
+  } else {
+    momentDate = moment.tz(date, targetTimezone);
+  }
+
+  return momentDate;
+}
 
 /**
  * Formats a date into "DD MMM YYYY h:mm A <TZ>" format.
- * Handles ISO strings and epoch timestamps.
+ * Handles epoch timestamps and ISO date strings with timezone offsets.
+ *
+ * Timezone Selection Priority:
+ *   1. customTZ (if provided) - overrides all others
+ *   2. serverTZ=true → uses server timezone from localStorage
+ *   3. orgTZ=true → uses organization timezone from localStorage  
+ *   4. Default → uses organization timezone from localStorage
  *
- * - ISO input:
- *    - orgTZ=false → keep ISO timezone info
- *    - orgTZ=true  → convert to org timezone 
- * - Epoch input:
- *    - Always converts to org timezone 
+ * Input Handling:
+ * - Epoch input (number or numeric string):
+ *    - Treated as UTC timestamp (seconds or milliseconds)
+ *    - Always converts to target timezone
+ * - ISO input (e.g., "2025-01-09T00:00:00+05:30"):
+ *    - Parses timezone offset correctly
+ *    - Converts to target timezone (doesn't preserve original timezone)
+ * - Date object:
+ *    - Converts to target 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 '-'.
+ * @param {string|number|Date} date - Epoch timestamp, ISO string with timezone, or Date object.
+ * @param {boolean} orgTZ - Whether to force conversion into organization timezone.
+ * @param {boolean} serverTZ - Whether to force conversion into server timezone.
+ * @param {string|null} customTZ - Custom timezone override (e.g., "Asia/Kolkata").
+ * @returns {string} Formatted date string with timezone abbreviation or '-'.
  */
-export const formatDateWithTimezone = (date, orgTZ = false, onlyAbbr = false) => {
-  try{
+export const formatDateWithTimezone = (date, orgTZ = false, serverTZ = false, customTZ = null) => {
+  try {
     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(momentDate.isUTC() || orgTZ){
-        momentDate = momentDate.tz(orgTimezone);
-      }
-    }
-
+    const momentDate = getTimezoneFormattedDate(date,orgTZ,serverTZ,customTZ);
     if (!momentDate.isValid()) return "-";
 
-    // Get strict timezone abbreviation (no offsets like GMT+05:30)
-    let tzAbbr;
-    if (momentDate.isValid()) {
-      const tz = momentDate.tz() || orgTimezone;
-      tzAbbr = moment.tz.zone(tz)?.abbr(momentDate.valueOf()) || "UTC";
-    } else {
-      tzAbbr = "UTC"; // fallback
-    }
-
-    if(onlyAbbr){
-      return tzAbbr;
-    }
-    else{
-      return `${momentDate.format(DATE_FORMAT)} ${tzAbbr}`;
-    }
-  }
-  catch(error){
+    const tzAbbr = momentDate.format("z"); // e.g., IST, PST
+    return `${momentDate.format(DATE_FORMAT)} ${tzAbbr}`;
+  } catch (error) {
     console.error(error);
     return "-";
   }
@@ -65,38 +65,51 @@ export const formatDateWithTimezone = (date, orgTZ = false, onlyAbbr = false) =>
 /**
  * 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)
+ * Timezone Selection Priority:
+ *   1. customTZ (if provided) - overrides all others
+ *   2. serverTZ=true → uses server timezone from localStorage
+ *   3. orgTZ=true → uses organization timezone from localStorage  
+ *   4. Default → uses organization timezone from localStorage
+ *
+ * Input Handling:
+ * - Epoch input (number or numeric string):
+ *    - Treated as UTC timestamp (seconds or milliseconds)
+ *    - Returns timezone info for that specific date/time
+ * - ISO input (e.g., "2025-01-09T00:00:00+05:30"):
+ *    - Parses timezone offset correctly
+ *    - Returns timezone info for that specific date/time
+ * - Date object:
+ *    - Returns timezone info for that specific date/time
  *
- * @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.
+ * @param {string|number|Date} date - Epoch timestamp, ISO string with timezone, or Date object.
+ * @param {boolean} orgTZ - Whether to force conversion into organization timezone.
+ * @param {boolean} serverTZ - Whether to force conversion into server timezone.
+ * @param {string|null} customTZ - Custom timezone override (e.g., "Asia/Kolkata").
+ * @returns {string} Tooltip string with timezone abbreviation and UTC offset for the specific date.
  */
-export const getTimezoneTooltip = (date, orgTZ = false) => {
-  const orgTimezone = utilsLocalStorageApi.loadItem("orgTZ") || "Asia/Kolkata";
-  const serverTimezone = utilsLocalStorageApi.loadItem("serverTZ") || "Asia/Kolkata";
+export const getTimezoneTooltip = (date, orgTZ = false, serverTZ = false, customTZ = null) => {
+  try {
+    if (!date) return "-";
 
-  if(orgTZ){
-    return `${orgTimezone} (UTC${moment.tz(orgTimezone).format("Z")})`;
-  }
-  else{
-    // case 1: epoch number or numeric string
-    if(typeof date === "number" || (typeof date === "string" && /^\d+$/.test(date))){
-      return `${orgTimezone} (UTC${moment.tz(orgTimezone).format("Z")})`;
-    }
-    // case 2: ISO string or Date object
-    else{
-      let m = moment.parseZone(date); // handles ISO strings like 2025-08-12T23:59:59.000Z or 2025-08-12T23:59:59+05:30
-      if(!m.isValid()){
-        m = moment.tz(date, "DD MMM YYYY h:mm A z"); // handles strings like 17 Sep 2025 6:00 AM EDT
-      }
-      if(!m.isValid() || m.isUTC()){
-        return `${orgTimezone} (UTC${moment.tz(orgTimezone).format("Z")})`; // fallback to orgTZ
-      }
-      return `${serverTimezone} (UTC${m.format("Z")})`; // return the timezone and offset
-    }
+    const orgTimezone = utilsLocalStorageApi.loadItem("orgTZ") || "Asia/Kolkata";
+    const serverTimezone = utilsLocalStorageApi.loadItem("serverTZ") || "Asia/Kolkata";
+    const targetTimezone = customTZ || (serverTZ ? serverTimezone : orgTZ ? orgTimezone : orgTimezone);
+    const momentDate = getTimezoneFormattedDate(date,orgTZ,serverTZ,customTZ);
+    if (!momentDate.isValid()) return "-";
+
+    const tzAbbr = momentDate.format("z"); // e.g., IST, PST, EDT
+    const utcOffset = momentDate.format("Z"); // e.g., +05:30, -04:00
+    return `${targetTimezone} (${tzAbbr},UTC${utcOffset})`;
+  } catch (error) {
+    console.error(error);
+    return "-";
   }
 };
+
+/**
+ * checks if Timezone feature is enabled
+ * @returns {boolean}
+ */
+export const hasTimezoneFeatureAccess = () => {
+  return hasFeatureAccess(TIMEZONE_ENABLED);
+};