@cuemath/web-utils 0.0.2-beta.2 → 0.0.2-beta.3

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@cuemath/web-utils",
-  "version": "0.0.2-beta.2",
-  "description": "Shareable utils package",
+  "version": "0.0.2-beta.3",
+  "description": "Shared web utils package",
   "main": "dist/index.js",
   "scripts": {
     "lint": "tsc --noEmit && eslint 'src/**/*.{js,jsx,ts,tsx,json}'",
@@ -12,12 +12,12 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/cuemath/ui-utils.git"
+    "url": "git+https://github.com/cuemath/web-utils.git"
   },
   "bugs": {
-    "url": "https://github.com/cuemath/ui-utils/issues"
+    "url": "https://github.com/cuemath/web-utils/issues"
   },
-  "homepage": "https://github.com/cuemath/ui-utils#readme",
+  "homepage": "https://github.com/cuemath/web-utils#readme",
   "author": "santosh k <santosh.k@cuemath.com>",
   "license": "ISC",
   "devDependencies": {

package/src/growth-source/index.ts

@@ -18,17 +18,23 @@ const UTM_PARAMS: UTMParamsKeys[] = [
   'utm_term',
 ];
 
-export const readSourceCookie = () => {
+export const readSourceCookie = (): SourceDetails => {
   const sourceDetails = getCookie(SOURCE_DETAILS_COOKIE);
 
-  return sourceDetails && JSON.parse(decodeURIComponent(sourceDetails));
+  return sourceDetails ? JSON.parse(decodeURIComponent(sourceDetails)) : undefined;
 };
 
-const writeSourceCookie = (sourceDetails: SourceDetails) => {
+const writeSourceCookie = (sourceDetails: SourceDetails): void => {
   createCookie(SOURCE_DETAILS_COOKIE, JSON.stringify(sourceDetails), 365, true);
 };
 
-const updateSourceCookie = (sourceDetail: Partial<SourceDetails>) => {
+export const isSourcePresent = (): boolean => {
+  return !!getCookie(SOURCE_DETAILS_COOKIE);
+};
+
+const updateSourceCookie = (sourceDetail: Partial<SourceDetails>): void => {
+  if (!isSourcePresent) return;
+
   const sourceDetails: SourceDetails = readSourceCookie();
   const updatedDetails: SourceDetails = {
     ...sourceDetails,
@@ -38,32 +44,35 @@ const updateSourceCookie = (sourceDetail: Partial<SourceDetails>) => {
   writeSourceCookie(updatedDetails);
 };
 
-const getRevenueChannel = (platform: Platform, utmParams?: UTMParams) => {
-  let revenueChannel: RevenueChannel = 'UNKNOWN';
+const getRevenueChannel = (platform: Platform, utmParams?: UTMParams): RevenueChannel => {
+  let revenueChannel: RevenueChannel = 'unknown';
+
+  // set defaults for WEBSITE and ASTRO
+  if (platform === 'website') {
+    revenueChannel = 'organic';
+  } else if (platform === 'astro') {
+    revenueChannel = 'performance';
+  }
 
-  if (platform === 'ASTRO' && utmParams) {
+  if (utmParams) {
     const { utm_source: utmSource = '' } = utmParams;
 
     switch (true) {
       case /^affiliate-/.test(utmSource):
-        revenueChannel = 'AFFILIATE';
+        revenueChannel = 'affiliate';
         break;
       case /^offline-/.test(utmSource):
-        revenueChannel = 'OFFLINE';
+        revenueChannel = 'offline';
         break;
       case /^referral-/.test(utmSource):
-        revenueChannel = 'REFERRAL';
+        revenueChannel = 'referral';
         break;
       case /^performance-/.test(utmSource):
-      default:
-        revenueChannel = 'PERFORMANCE';
+        revenueChannel = 'performance';
+        break;
     }
   }
 
-  if (platform === 'WEBSITE') {
-    revenueChannel = 'ORGANIC';
-  }
-
   return revenueChannel;
 };
 
@@ -73,23 +82,23 @@ const getRevenueChannel = (platform: Platform, utmParams?: UTMParams) => {
   if Platform = APP, decide logic
   if Platform = chatbot, decide based on chatbot experiment key
 */
-const getFlow = (platform: Platform, experiments?: Experiments) => {
-  let flow: SignupFlow = 'REGULAR';
+const getFlow = (platform: Platform, experiments?: Experiments): SignupFlow => {
+  let flow: SignupFlow = 'regular';
 
-  if (platform === 'WEBSITE') {
+  if (platform === 'website') {
     if (experiments) {
       const ecnaExp = Object.keys(experiments).find(
         experiment => experiment.indexOf('ecna') !== -1,
       );
 
-      flow = ecnaExp && experiments[ecnaExp] === 'b' ? 'ECNA' : 'REGULAR';
+      flow = ecnaExp && experiments[ecnaExp] === 'b' ? 'e-cna' : 'regular';
     }
   }
 
   return flow;
 };
 
-const getUTMParams = () => {
+const getUTMParams = (): UTMParams | undefined => {
   if (typeof window === undefined) return;
 
   const search = new URLSearchParams(window.location.search);
@@ -106,7 +115,7 @@ const getUTMParams = () => {
   return utmParams;
 };
 
-const getFirstPage = () => {
+const getFirstPage = (): string => {
   if (typeof window === undefined) return '';
 
   return window.location.pathname;
@@ -118,7 +127,7 @@ const getFirstPage = () => {
   organic-<channel>
   offline-<channel>
 */
-const getChannel = (utmParams: UTMParams | undefined) => {
+const getChannel = (utmParams: UTMParams | undefined): string => {
   // TODO: UTM source patter for FB, GOOGLE...
   if (!utmParams) return '';
 
@@ -133,27 +142,37 @@ const getChannel = (utmParams: UTMParams | undefined) => {
 export const initSourceDetails = async ({
   platform,
   experiments,
-  utmParams,
   flow,
   affiliateChannel,
   offlineChannel,
   organicChannel,
   performanceChannel,
   revenueChannel,
-}: SourceDetails) => {
-  if (!readSourceCookie()) {
+}: SourceDetails): Promise<void> => {
+  if (!isSourcePresent()) {
+    const utmParams = getUTMParams();
     const leadChannel = getChannel(utmParams);
 
+    revenueChannel = revenueChannel || getRevenueChannel(platform, utmParams);
+    affiliateChannel =
+      revenueChannel === 'affiliate' ? affiliateChannel || leadChannel : undefined;
+    offlineChannel =
+      revenueChannel === 'offline' ? offlineChannel || leadChannel : undefined;
+    organicChannel =
+      revenueChannel === 'organic' ? organicChannel || leadChannel : undefined;
+    performanceChannel =
+      revenueChannel === 'performance' ? performanceChannel || leadChannel : undefined;
+
     const sourceDetails: SourceDetails = {
       platform,
       experiments,
       utmParams: getUTMParams(),
       flow: flow || getFlow(platform, experiments),
-      affiliateChannel: affiliateChannel || leadChannel,
-      offlineChannel: offlineChannel || leadChannel,
-      organicChannel: organicChannel || leadChannel,
-      performanceChannel: performanceChannel || leadChannel,
-      revenueChannel: revenueChannel || getRevenueChannel(platform, utmParams),
+      affiliateChannel,
+      offlineChannel,
+      organicChannel,
+      performanceChannel,
+      revenueChannel: revenueChannel,
       firstPage: getFirstPage(),
     };
 
@@ -162,11 +181,11 @@ export const initSourceDetails = async ({
 };
 
 // Last Page which user visited signup before
-export const setLastPage = async (pagePath: string) => {
+export const setLastPage = async (pagePath: string): Promise<void> => {
   updateSourceCookie({ lastPage: pagePath });
 };
 
 // set Entry point where user clicked to Signup
-export const setFlowEntryPoint = async (flowEntry: string) => {
+export const setFlowEntryPoint = async (flowEntry: string): Promise<void> => {
   updateSourceCookie({ flowEntry });
 };

package/src/growth-source/types.ts

@@ -1,12 +1,12 @@
-export type Platform = 'WEBSITE' | 'APP' | 'ASTRO' | 'LEAP_TEACHER' | 'LEAP_ADMIN';
+export type Platform = 'website' | 'app' | 'astro' | 'leap-teacher' | 'leap-admin';
 export type RevenueChannel =
-  | 'ORGANIC'
-  | 'PERFORMANCE'
-  | 'AFFILIATE'
-  | 'OFFLINE'
-  | 'REFERRAL'
-  | 'UNKNOWN';
-export type SignupFlow = 'REGULAR' | 'ECNA' | 'ESALES';
+  | '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;
@@ -24,7 +24,7 @@ export type SourceDetails = {
   utmParams?: UTMParams;
   affiliateChannel?: string;
   offlineChannel?: string;
-  performanceChannel: string;
+  performanceChannel?: string;
   revenueChannel: RevenueChannel;
   organicChannel?: string;
   flowEntry?: string;