@cuemath/web-utils 1.0.6 → 1.0.7-beta.1

package/src/growth-source/index.ts

@@ -1,235 +0,0 @@
-import type {
-  SourceDetails,
-  SourceDetailsCookie,
-  Platform,
-  SignupFlow,
-  UTMParams,
-  Experiments,
-  RevenueChannel,
-  UTMParamsKeys,
-} from './types';
-
-import { createCookie, getCookie, removeCookie } from '../cookie';
-
-const SOURCE_DETAILS_COOKIE = 'source_details';
-const UTM_PARAMS: UTMParamsKeys[] = [
-  'utm_source',
-  'utm_medium',
-  'utm_campaign',
-  'utm_term',
-];
-
-export const readSourceCookie = (): SourceDetailsCookie => {
-  const sourceDetails = getCookie(SOURCE_DETAILS_COOKIE);
-
-  return sourceDetails ? JSON.parse(decodeURIComponent(sourceDetails)) : undefined;
-};
-
-const writeSourceCookie = (sourceDetails: SourceDetailsCookie): void => {
-  createCookie(SOURCE_DETAILS_COOKIE, JSON.stringify(sourceDetails), 365);
-};
-
-export const isSourcePresent = (): boolean => {
-  return !!getCookie(SOURCE_DETAILS_COOKIE);
-};
-
-const updateSourceCookie = (sourceDetail: Partial<SourceDetailsCookie>): void => {
-  if (!isSourcePresent) return;
-
-  const sourceDetails: SourceDetailsCookie = readSourceCookie();
-  const updatedDetails: SourceDetailsCookie = {
-    ...sourceDetails,
-    ...sourceDetail,
-  };
-
-  writeSourceCookie(updatedDetails);
-};
-
-const getRevenueChannel = (platform: Platform, utmSource?: string): RevenueChannel => {
-  let revenueChannel: RevenueChannel = 'unknown';
-
-  // set defaults for WEBSITE and ASTRO
-  if (platform === 'website') {
-    revenueChannel = 'organic';
-  } else if (platform === 'astro') {
-    revenueChannel = 'performance';
-  }
-
-  if (utmSource) {
-    switch (true) {
-      case /^affiliate-/.test(utmSource):
-        revenueChannel = 'affiliate';
-        break;
-      case /^offline-/.test(utmSource):
-        revenueChannel = 'offline';
-        break;
-      case /^referral-/.test(utmSource):
-        revenueChannel = 'referral';
-        break;
-      case /^performance-/.test(utmSource):
-        revenueChannel = 'performance';
-        break;
-    }
-  }
-
-  return revenueChannel;
-};
-
-/*
-  if Platform = website, then decide based on experiment key
-  if Platform = Astro, decide logic once BAU is started
-  if Platform = APP, decide logic
-  if Platform = chatbot, decide based on chatbot experiment key
-*/
-const getFlow = (platform: Platform, experiments?: Experiments): SignupFlow => {
-  let flow: SignupFlow = 'regular';
-
-  if (platform === 'website') {
-    if (experiments) {
-      const ecnaExp = Object.keys(experiments).find(
-        experiment => experiment.indexOf('ecna') !== -1,
-      );
-
-      flow = ecnaExp && experiments[ecnaExp] === 'b' ? 'e-cna' : 'regular';
-    }
-  }
-
-  return flow;
-};
-
-const getUTMParams = (): Partial<UTMParams> => {
-  if (typeof window === undefined) return {};
-
-  const search = new URLSearchParams(window.location.search);
-  const utmParams = UTM_PARAMS.reduce((acc: UTMParams, param) => {
-    const utmParam = search.get(param) as string;
-
-    if (utmParam) {
-      acc[param] = utmParam;
-    }
-
-    return acc;
-  }, {});
-
-  return utmParams;
-};
-
-const getFirstPage = (): string => {
-  if (typeof window === undefined) return '';
-
-  return window.location.pathname;
-};
-
-/* TODO: Align Marketing Team on UTM source convention
-  affiliate-<channel>
-  performance-<channel>
-  organic-<channel>
-  offline-<channel>
-*/
-const getChannel = (utmSource?: string): string => {
-  // TODO: UTM source patter for FB, GOOGLE...
-  if (!utmSource) return '';
-
-  let channel = '';
-
-  if (utmSource) {
-    switch (true) {
-      case /^affiliate-/.test(utmSource):
-      case /^offline-/.test(utmSource):
-      case /^referral-/.test(utmSource):
-      case /^performance-/.test(utmSource):
-        channel = utmSource.split('-')[1];
-        break;
-      default:
-        break;
-    }
-  }
-
-  return channel;
-};
-
-/* 
-  Set Static Source Details of user on Visit of Platform
-*/
-export const initSourceDetails = async ({
-  platform,
-  experiments,
-  flow,
-  affiliateChannel,
-  offlineChannel,
-  organicChannel,
-  performanceChannel,
-  revenueChannel,
-  guestId,
-}: SourceDetails): Promise<void> => {
-  const utmParams: Partial<UTMParams> = getUTMParams();
-  const { utm_source: utmSource } = utmParams;
-  const leadChannel = getChannel(utmSource);
-
-  /*
-    source cookie was added in cross subdomain for few days initially,
-    which was later changed to subdomain specific. Now to sending older cookie to backend, removing older cookie
-  */
-  removeCookie(SOURCE_DETAILS_COOKIE, true);
-
-  revenueChannel = revenueChannel || getRevenueChannel(platform, utmSource);
-
-  if (utmSource) {
-    affiliateChannel =
-      revenueChannel === 'affiliate' ? affiliateChannel || leadChannel : undefined;
-    offlineChannel =
-      revenueChannel === 'offline' ? offlineChannel || leadChannel : undefined;
-    organicChannel =
-      revenueChannel === 'organic' ? organicChannel || leadChannel : undefined;
-    performanceChannel =
-      revenueChannel === 'performance' ? performanceChannel || leadChannel : undefined;
-  }
-
-  if (!isSourcePresent()) {
-    const sourceDetails: SourceDetailsCookie = {
-      platform_channel: platform,
-      experiment_dict: experiments,
-      utm_params: utmParams,
-      flow: flow || getFlow(platform, experiments),
-      affiliate_channel: affiliateChannel,
-      offline_channel: offlineChannel,
-      organic_channel: organicChannel,
-      performance_channel: performanceChannel,
-      revenue_channel: revenueChannel,
-      first_page: getFirstPage(),
-      guest_id: guestId,
-    };
-
-    writeSourceCookie(sourceDetails);
-  } else {
-    let updatedSource: Partial<SourceDetailsCookie> = {
-      experiment_dict: experiments,
-      flow: flow || getFlow(platform, experiments),
-      guest_id: guestId,
-    };
-
-    if (utmSource) {
-      updatedSource = {
-        ...updatedSource,
-        utm_params: utmParams,
-        affiliate_channel: affiliateChannel,
-        offline_channel: offlineChannel,
-        organic_channel: organicChannel,
-        performance_channel: performanceChannel,
-        revenue_channel: revenueChannel,
-      };
-    }
-
-    updateSourceCookie(updatedSource);
-  }
-};
-
-// Last Page which user visited signup before
-export const setLastPage = async (pagePath: string): Promise<void> => {
-  updateSourceCookie({ last_page: pagePath });
-};
-
-// set Entry point where user clicked to Signup
-export const setFlowEntryPoint = async (flowEntry: string): Promise<void> => {
-  updateSourceCookie({ flow_entry: flowEntry });
-};

package/src/growth-source/types.ts

@@ -1,50 +0,0 @@
-export type Platform = 'website' | 'app' | 'astro' | 'leap-teacher' | 'leap-admin';
-export type RevenueChannel =
-  | 'organic'
-  | 'performance'
-  | 'affiliate'
-  | 'offline'
-  | 'referral'
-  | 'unknown';
-export type SignupFlow = 'regular' | 'e-cna' | 'e-sales';
-export type Experiments = Record<string, unknown>;
-export type UTMParams = {
-  utm_source?: string;
-  utm_medium?: string;
-  utm_campaign?: string;
-  utm_term?: string;
-};
-
-export type UTMParamsKeys = keyof UTMParams;
-
-export type SourceDetailsCookie = {
-  platform_channel: Platform;
-  experiment_dict?: Experiments;
-  flow?: SignupFlow;
-  utm_params?: UTMParams;
-  affiliate_channel?: string;
-  offline_channel?: string;
-  performance_channel?: string;
-  revenue_channel: RevenueChannel;
-  organic_channel?: string;
-  flow_entry?: string;
-  first_page?: string;
-  last_page?: string;
-  guest_id?: string;
-};
-
-export type SourceDetails = {
-  platform: Platform;
-  experiments: Experiments;
-  flow?: SignupFlow;
-  utmParams?: UTMParams;
-  affiliateChannel?: string;
-  offlineChannel?: string;
-  performanceChannel?: string;
-  revenueChannel: RevenueChannel;
-  organicChannel?: string;
-  flowEntry?: string;
-  firstPage?: string;
-  lastPage?: string;
-  guestId?: string;
-};

package/src/local-storage/index.ts

@@ -1,196 +0,0 @@
-import { TWENTY_FOUR_HOURS_IN_SECONDS } from '../constants/date-time';
-
-/* eslint-disable @typescript-eslint/no-explicit-any */
-export const LOCAL_STORAGE_PRIMARY_KEY = 'CUEMATH_WEB';
-
-export const checkLocalStorageSupport = (): boolean => {
-  try {
-    return 'localStorage' in window && window.localStorage !== null;
-  } catch (e) {
-    return false;
-  }
-};
-
-export const removeKeyFromObject = (
-  obj: { [x: string]: any },
-  keyToRemove: string,
-): null | { [x: string]: any } => {
-  if (obj) {
-    delete obj[keyToRemove];
-
-    return obj;
-  }
-
-  return null;
-};
-
-// Default expiry set to 24 hours
-export const localStorageSet = (
-  key: string | number,
-  value: any,
-  ttl = TWENTY_FOUR_HOURS_IN_SECONDS,
-): boolean => {
-  if (checkLocalStorageSupport()) {
-    try {
-      let dbData: any = window.localStorage.getItem(LOCAL_STORAGE_PRIMARY_KEY);
-      const now = new Date();
-
-      const item = {
-        value,
-        expiry: now.getTime() + ttl,
-      };
-
-      if (dbData) {
-        dbData = JSON.parse(dbData);
-        dbData[key] = item;
-      } else {
-        dbData = { [key]: item };
-      }
-
-      window.localStorage.setItem(LOCAL_STORAGE_PRIMARY_KEY, JSON.stringify(dbData));
-
-      return true;
-    } catch (e) {
-      return false;
-    } // case when localStorage space quota is exceeded
-  } else {
-    return false;
-  }
-};
-
-export const localStorageGet = (key: string): null | string => {
-  if (checkLocalStorageSupport()) {
-    try {
-      const primaryLocalStorageValue = window.localStorage.getItem(
-        LOCAL_STORAGE_PRIMARY_KEY,
-      );
-      let dbData =
-        primaryLocalStorageValue != null
-          ? JSON.parse(primaryLocalStorageValue)
-          : primaryLocalStorageValue;
-      const requestedData = dbData[key];
-      const now = new Date();
-
-      if (now.getTime() > requestedData.expiry) {
-        dbData = removeKeyFromObject(dbData, key);
-        window.localStorage.setItem(LOCAL_STORAGE_PRIMARY_KEY, JSON.stringify(dbData));
-
-        return null;
-      }
-
-      return requestedData.value;
-    } catch (e) {
-      return null;
-    }
-  } else {
-    return null;
-  }
-};
-
-export const localStorageGetAll = (): null | string => {
-  if (checkLocalStorageSupport()) {
-    try {
-      const primaryLocalStorageValue = window.localStorage.getItem(
-        LOCAL_STORAGE_PRIMARY_KEY,
-      );
-
-      return primaryLocalStorageValue != null
-        ? JSON.parse(primaryLocalStorageValue)
-        : primaryLocalStorageValue;
-    } catch (e) {
-      return null;
-    }
-  } else {
-    return null;
-  }
-};
-
-export const localStorageRemove = (key: string): boolean => {
-  if (checkLocalStorageSupport()) {
-    try {
-      const primaryLocalStorageValue = window.localStorage.getItem(
-        LOCAL_STORAGE_PRIMARY_KEY,
-      );
-      let dbData =
-        primaryLocalStorageValue != null
-          ? JSON.parse(primaryLocalStorageValue)
-          : primaryLocalStorageValue;
-
-      if (dbData[key]) {
-        dbData = removeKeyFromObject(dbData, key);
-        window.localStorage.setItem(LOCAL_STORAGE_PRIMARY_KEY, JSON.stringify(dbData));
-
-        return true;
-      }
-
-      return false;
-    } catch (e) {
-      return false;
-    }
-  } else {
-    return false;
-  }
-};
-
-export const localStorageRemoveAll = (): boolean => {
-  if (checkLocalStorageSupport()) {
-    try {
-      const primaryLocalStorageValue = window.localStorage.getItem(
-        LOCAL_STORAGE_PRIMARY_KEY,
-      );
-      const dbData =
-        primaryLocalStorageValue != null
-          ? JSON.parse(primaryLocalStorageValue)
-          : primaryLocalStorageValue;
-
-      if (dbData) {
-        window.localStorage.removeItem(LOCAL_STORAGE_PRIMARY_KEY);
-
-        return true;
-      }
-
-      return false;
-    } catch (e) {
-      return false;
-    }
-  } else {
-    return false;
-  }
-};
-
-export const removeExpiredKeysOnMount = (): boolean => {
-  if (checkLocalStorageSupport()) {
-    try {
-      const primaryLocalStorageValue = window.localStorage.getItem(
-        LOCAL_STORAGE_PRIMARY_KEY,
-      );
-      let dbData =
-        primaryLocalStorageValue != null
-          ? JSON.parse(primaryLocalStorageValue)
-          : primaryLocalStorageValue;
-      const now = new Date();
-
-      if (dbData) {
-        dbData = Object.keys(dbData).reduce((accumulator: any, key) => {
-          if (now.getTime() < dbData[key].expiry) {
-            accumulator[key] = dbData[key];
-          }
-
-          return accumulator;
-        }, {});
-      }
-
-      if (Object.keys(dbData).length) {
-        window.localStorage.setItem(LOCAL_STORAGE_PRIMARY_KEY, JSON.stringify(dbData));
-      } else {
-        localStorageRemoveAll();
-      }
-
-      return true;
-    } catch (e) {
-      return false;
-    }
-  } else {
-    return false;
-  }
-};

package/src/object/index.ts

@@ -1,21 +0,0 @@
-export function isEmpty(obj: object): boolean {
-  return Object.keys(obj).length === 0;
-}
-
-export function nestedMapsAreEqual(map1: Map<any, any>, map2: Map<any, any>): boolean {
-  // First, check if the maps have the same size
-  if (map1.size !== map2.size) {
-    return false;
-  }
-
-  // Then, iterate over each key-value pair in map1 and check if the corresponding key-value pair exists in map2
-  for (const [key, value] of map1) {
-    if (!map2.has(key) || map2.get(key) !== value) {
-      // If the key doesn't exist in map2, or the value for the key is different, the maps are not equal
-      return false;
-    }
-  }
-
-  // If we haven't returned false by now, the maps are equal
-  return true;
-}

package/tsconfig.json

@@ -1,8 +0,0 @@
-{
-  "extends": "@cuemath/ts-config/tsconfig.json",
-  "compilerOptions": {
-    "outDir": "./dist",
-    "module": "CommonJS"
-  },
-  "include": ["src/**/*"]
-}