@cuemath/web-utils 1.0.0-beta.14 → 1.0.0

package/.husky/pre-commit

@@ -2,4 +2,3 @@
 . "$(dirname -- "$0")/_/husky.sh"
 
 yarn lint
-npx lint-staged

package/dist/cookie/index.d.ts

@@ -1,4 +1,4 @@
 export declare const getCookie: (name: string, cookie?: string) => string;
 export declare function removeCookie(name: string): void;
-export declare function createCookie(name: string, value: string, days: number): void;
+export declare function createCookie(name: string, value: string, days: number, subdomain: boolean): void;
 export declare function createCookieWithMidnightExp(name: string, value: string): void;

package/dist/cookie/index.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createCookieWithMidnightExp = exports.createCookie = exports.removeCookie = exports.getCookie = void 0;
-/* eslint-disable @typescript-eslint/no-explicit-any */
 const getCookie = (name, cookie = document.cookie) => {
     if (!cookie) {
         return '';
@@ -26,14 +25,14 @@ function removeCookie(name) {
     document.cookie = `${name}=; expires=${date.toUTCString()}; path=/`;
 }
 exports.removeCookie = removeCookie;
-function createCookie(name, value, days) {
+function createCookie(name, value, days, subdomain) {
     let expires = '';
     if (days) {
         const date = new Date();
         date.setTime(date.getTime() + days * 24 * 60 * 60 * 1000);
         expires = `; expires=${date.toUTCString()}`;
     }
-    document.cookie = `${name}=${encodeURIComponent(value)}${expires}; path=/`;
+    document.cookie = `${name}=${encodeURIComponent(value)}${expires}; path=/${subdomain ? '; domain=cuemath.com' : ''}`;
 }
 exports.createCookie = createCookie;
 function createCookieWithMidnightExp(name, value) {

package/dist/cookie/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/cookie/index.ts"],"names":[],"mappings":";;;AAAA,uDAAuD;AAChD,MAAM,SAAS,GAAG,CAAC,IAAY,EAAE,SAAiB,QAAQ,CAAC,MAAM,EAAU,EAAE;IAClF,IAAI,CAAC,MAAM,EAAE;QACX,OAAO,EAAE,CAAC;KACX;IAED,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAEnC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE;QAC1C,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE;YACd,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAE3C,IAAI,GAAG,KAAK,IAAI,EAAE;gBAChB,OAAO,KAAK,CAAC;aACd;SACF;KACF;IAED,OAAO,EAAE,CAAC;AACZ,CAAC,CAAC;AAlBW,QAAA,SAAS,aAkBpB;AAEF,SAAgB,YAAY,CAAC,IAAY;IACvC,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IAExB,2BAA2B;IAC3B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IAExD,SAAS;IACT,QAAQ,CAAC,MAAM,GAAG,GAAG,IAAI,cAAc,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC;AACtE,CAAC;AARD,oCAQC;AAED,SAAgB,YAAY,CAAC,IAAY,EAAE,KAAa,EAAE,IAAY;IACpE,IAAI,OAAO,GAAG,EAAE,CAAC;IAEjB,IAAI,IAAI,EAAE;QACR,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAExB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,IAAI,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;QAC1D,OAAO,GAAG,aAAa,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;KAC7C;IACD,QAAQ,CAAC,MAAM,GAAG,GAAG,IAAI,IAAI,kBAAkB,CAAC,KAAK,CAAC,GAAG,OAAO,UAAU,CAAC;AAC7E,CAAC;AAVD,oCAUC;AAED,SAAgB,2BAA2B,CAAC,IAAY,EAAE,KAAa;IACrE,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IAExB,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3B,MAAM,OAAO,GAAG,aAAa,IAAI,EAAE,CAAC;IAEpC,QAAQ,CAAC,MAAM,GAAG,GAAG,IAAI,IAAI,KAAK,GAAG,OAAO,UAAU,CAAC;AACzD,CAAC;AAPD,kEAOC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/cookie/index.ts"],"names":[],"mappings":";;;AAAO,MAAM,SAAS,GAAG,CAAC,IAAY,EAAE,SAAiB,QAAQ,CAAC,MAAM,EAAU,EAAE;IAClF,IAAI,CAAC,MAAM,EAAE;QACX,OAAO,EAAE,CAAC;KACX;IAED,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAEnC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE;QAC1C,IAAI,OAAO,CAAC,CAAC,CAAC,EAAE;YACd,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YAE3C,IAAI,GAAG,KAAK,IAAI,EAAE;gBAChB,OAAO,KAAK,CAAC;aACd;SACF;KACF;IAED,OAAO,EAAE,CAAC;AACZ,CAAC,CAAC;AAlBW,QAAA,SAAS,aAkBpB;AAEF,SAAgB,YAAY,CAAC,IAAY;IACvC,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IAExB,2BAA2B;IAC3B,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;IAExD,SAAS;IACT,QAAQ,CAAC,MAAM,GAAG,GAAG,IAAI,cAAc,IAAI,CAAC,WAAW,EAAE,UAAU,CAAC;AACtE,CAAC;AARD,oCAQC;AAED,SAAgB,YAAY,CAC1B,IAAY,EACZ,KAAa,EACb,IAAY,EACZ,SAAkB;IAElB,IAAI,OAAO,GAAG,EAAE,CAAC;IAEjB,IAAI,IAAI,EAAE;QACR,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAExB,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,IAAI,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;QAC1D,OAAO,GAAG,aAAa,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;KAC7C;IACD,QAAQ,CAAC,MAAM,GAAG,GAAG,IAAI,IAAI,kBAAkB,CAAC,KAAK,CAAC,GAAG,OAAO,WAC9D,SAAS,CAAC,CAAC,CAAC,sBAAsB,CAAC,CAAC,CAAC,EACvC,EAAE,CAAC;AACL,CAAC;AAjBD,oCAiBC;AAED,SAAgB,2BAA2B,CAAC,IAAY,EAAE,KAAa;IACrE,MAAM,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;IAExB,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAC3B,MAAM,OAAO,GAAG,aAAa,IAAI,EAAE,CAAC;IAEpC,QAAQ,CAAC,MAAM,GAAG,GAAG,IAAI,IAAI,KAAK,GAAG,OAAO,UAAU,CAAC;AACzD,CAAC;AAPD,kEAOC"}

package/dist/growth-source/index.d.ts

@@ -0,0 +1,6 @@
+import type { SourceDetails } from './types';
+export declare const readSourceCookie: () => SourceDetails;
+export declare const isSourcePresent: () => boolean;
+export declare const initSourceDetails: ({ platform, experiments, flow, affiliateChannel, offlineChannel, organicChannel, performanceChannel, revenueChannel, }: SourceDetails) => Promise<void>;
+export declare const setLastPage: (pagePath: string) => Promise<void>;
+export declare const setFlowEntryPoint: (flowEntry: string) => Promise<void>;

package/dist/growth-source/index.js

@@ -0,0 +1,151 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setFlowEntryPoint = exports.setLastPage = exports.initSourceDetails = exports.isSourcePresent = exports.readSourceCookie = void 0;
+const cookie_1 = require("../cookie");
+const SOURCE_DETAILS_COOKIE = 'source_details';
+const UTM_PARAMS = [
+    'utm_source',
+    'utm_medium',
+    'utm_campaign',
+    'utm_term',
+];
+const readSourceCookie = () => {
+    const sourceDetails = (0, cookie_1.getCookie)(SOURCE_DETAILS_COOKIE);
+    return sourceDetails ? JSON.parse(decodeURIComponent(sourceDetails)) : undefined;
+};
+exports.readSourceCookie = readSourceCookie;
+const writeSourceCookie = (sourceDetails) => {
+    (0, cookie_1.createCookie)(SOURCE_DETAILS_COOKIE, JSON.stringify(sourceDetails), 365, true);
+};
+const isSourcePresent = () => {
+    return !!(0, cookie_1.getCookie)(SOURCE_DETAILS_COOKIE);
+};
+exports.isSourcePresent = isSourcePresent;
+const updateSourceCookie = (sourceDetail) => {
+    if (!exports.isSourcePresent)
+        return;
+    const sourceDetails = (0, exports.readSourceCookie)();
+    const updatedDetails = {
+        ...sourceDetails,
+        ...sourceDetail,
+    };
+    writeSourceCookie(updatedDetails);
+};
+const getRevenueChannel = (platform, utmParams) => {
+    let revenueChannel = 'unknown';
+    // set defaults for WEBSITE and ASTRO
+    if (platform === 'website') {
+        revenueChannel = 'organic';
+    }
+    else if (platform === 'astro') {
+        revenueChannel = 'performance';
+    }
+    if (utmParams) {
+        const { utm_source: utmSource = '' } = utmParams;
+        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, experiments) => {
+    let flow = '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 = () => {
+    if (typeof window === undefined)
+        return;
+    const search = new URLSearchParams(window.location.search);
+    const utmParams = UTM_PARAMS.reduce((acc, param) => {
+        const utmParam = search.get(param);
+        if (utmParam) {
+            acc[param] = utmParam;
+        }
+        return acc;
+    }, {});
+    return utmParams;
+};
+const getFirstPage = () => {
+    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 = (utmParams) => {
+    // TODO: UTM source patter for FB, GOOGLE...
+    if (!utmParams)
+        return '';
+    const { utm_source: utmSource = '' } = utmParams;
+    return utmSource.split('-')[1];
+};
+/*
+  Set Static Source Details of user on Visit of Platform
+*/
+const initSourceDetails = async ({ platform, experiments, flow, affiliateChannel, offlineChannel, organicChannel, performanceChannel, revenueChannel, }) => {
+    if (!(0, exports.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 = {
+            platform,
+            experiments,
+            utmParams: getUTMParams(),
+            flow: flow || getFlow(platform, experiments),
+            affiliateChannel,
+            offlineChannel,
+            organicChannel,
+            performanceChannel,
+            revenueChannel: revenueChannel,
+            firstPage: getFirstPage(),
+        };
+        writeSourceCookie(sourceDetails);
+    }
+};
+exports.initSourceDetails = initSourceDetails;
+// Last Page which user visited signup before
+const setLastPage = async (pagePath) => {
+    updateSourceCookie({ lastPage: pagePath });
+};
+exports.setLastPage = setLastPage;
+// set Entry point where user clicked to Signup
+const setFlowEntryPoint = async (flowEntry) => {
+    updateSourceCookie({ flowEntry });
+};
+exports.setFlowEntryPoint = setFlowEntryPoint;
+//# sourceMappingURL=index.js.map

package/dist/growth-source/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/growth-source/index.ts"],"names":[],"mappings":";;;AAUA,sCAAoD;AAEpD,MAAM,qBAAqB,GAAG,gBAAgB,CAAC;AAC/C,MAAM,UAAU,GAAoB;IAClC,YAAY;IACZ,YAAY;IACZ,cAAc;IACd,UAAU;CACX,CAAC;AAEK,MAAM,gBAAgB,GAAG,GAAkB,EAAE;IAClD,MAAM,aAAa,GAAG,IAAA,kBAAS,EAAC,qBAAqB,CAAC,CAAC;IAEvD,OAAO,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;AACnF,CAAC,CAAC;AAJW,QAAA,gBAAgB,oBAI3B;AAEF,MAAM,iBAAiB,GAAG,CAAC,aAA4B,EAAQ,EAAE;IAC/D,IAAA,qBAAY,EAAC,qBAAqB,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;AAChF,CAAC,CAAC;AAEK,MAAM,eAAe,GAAG,GAAY,EAAE;IAC3C,OAAO,CAAC,CAAC,IAAA,kBAAS,EAAC,qBAAqB,CAAC,CAAC;AAC5C,CAAC,CAAC;AAFW,QAAA,eAAe,mBAE1B;AAEF,MAAM,kBAAkB,GAAG,CAAC,YAAoC,EAAQ,EAAE;IACxE,IAAI,CAAC,uBAAe;QAAE,OAAO;IAE7B,MAAM,aAAa,GAAkB,IAAA,wBAAgB,GAAE,CAAC;IACxD,MAAM,cAAc,GAAkB;QACpC,GAAG,aAAa;QAChB,GAAG,YAAY;KAChB,CAAC;IAEF,iBAAiB,CAAC,cAAc,CAAC,CAAC;AACpC,CAAC,CAAC;AAEF,MAAM,iBAAiB,GAAG,CAAC,QAAkB,EAAE,SAAqB,EAAkB,EAAE;IACtF,IAAI,cAAc,GAAmB,SAAS,CAAC;IAE/C,qCAAqC;IACrC,IAAI,QAAQ,KAAK,SAAS,EAAE;QAC1B,cAAc,GAAG,SAAS,CAAC;KAC5B;SAAM,IAAI,QAAQ,KAAK,OAAO,EAAE;QAC/B,cAAc,GAAG,aAAa,CAAC;KAChC;IAED,IAAI,SAAS,EAAE;QACb,MAAM,EAAE,UAAU,EAAE,SAAS,GAAG,EAAE,EAAE,GAAG,SAAS,CAAC;QAEjD,QAAQ,IAAI,EAAE;YACZ,KAAK,aAAa,CAAC,IAAI,CAAC,SAAS,CAAC;gBAChC,cAAc,GAAG,WAAW,CAAC;gBAC7B,MAAM;YACR,KAAK,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC;gBAC9B,cAAc,GAAG,SAAS,CAAC;gBAC3B,MAAM;YACR,KAAK,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC;gBAC/B,cAAc,GAAG,UAAU,CAAC;gBAC5B,MAAM;YACR,KAAK,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC;gBAClC,cAAc,GAAG,aAAa,CAAC;gBAC/B,MAAM;SACT;KACF;IAED,OAAO,cAAc,CAAC;AACxB,CAAC,CAAC;AAEF;;;;;EAKE;AACF,MAAM,OAAO,GAAG,CAAC,QAAkB,EAAE,WAAyB,EAAc,EAAE;IAC5E,IAAI,IAAI,GAAe,SAAS,CAAC;IAEjC,IAAI,QAAQ,KAAK,SAAS,EAAE;QAC1B,IAAI,WAAW,EAAE;YACf,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,IAAI,CAC3C,UAAU,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAChD,CAAC;YAEF,IAAI,GAAG,OAAO,IAAI,WAAW,CAAC,OAAO,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;SACtE;KACF;IAED,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,GAA0B,EAAE;IAC/C,IAAI,OAAO,MAAM,KAAK,SAAS;QAAE,OAAO;IAExC,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC3D,MAAM,SAAS,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,GAAc,EAAE,KAAK,EAAE,EAAE;QAC5D,MAAM,QAAQ,GAAG,MAAM,CAAC,GAAG,CAAC,KAAK,CAAW,CAAC;QAE7C,IAAI,QAAQ,EAAE;YACZ,GAAG,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAC;SACvB;QAED,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAE,CAAC,CAAC;IAEP,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,GAAW,EAAE;IAChC,IAAI,OAAO,MAAM,KAAK,SAAS;QAAE,OAAO,EAAE,CAAC;IAE3C,OAAO,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC;AAClC,CAAC,CAAC;AAEF;;;;;EAKE;AACF,MAAM,UAAU,GAAG,CAAC,SAAgC,EAAU,EAAE;IAC9D,4CAA4C;IAC5C,IAAI,CAAC,SAAS;QAAE,OAAO,EAAE,CAAC;IAE1B,MAAM,EAAE,UAAU,EAAE,SAAS,GAAG,EAAE,EAAE,GAAG,SAAS,CAAC;IAEjD,OAAO,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;AACjC,CAAC,CAAC;AAEF;;EAEE;AACK,MAAM,iBAAiB,GAAG,KAAK,EAAE,EACtC,QAAQ,EACR,WAAW,EACX,IAAI,EACJ,gBAAgB,EAChB,cAAc,EACd,cAAc,EACd,kBAAkB,EAClB,cAAc,GACA,EAAiB,EAAE;IACjC,IAAI,CAAC,IAAA,uBAAe,GAAE,EAAE;QACtB,MAAM,SAAS,GAAG,YAAY,EAAE,CAAC;QACjC,MAAM,WAAW,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC;QAE1C,cAAc,GAAG,cAAc,IAAI,iBAAiB,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QAC1E,gBAAgB;YACd,cAAc,KAAK,WAAW,CAAC,CAAC,CAAC,gBAAgB,IAAI,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;QAC/E,cAAc;YACZ,cAAc,KAAK,SAAS,CAAC,CAAC,CAAC,cAAc,IAAI,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;QAC3E,cAAc;YACZ,cAAc,KAAK,SAAS,CAAC,CAAC,CAAC,cAAc,IAAI,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;QAC3E,kBAAkB;YAChB,cAAc,KAAK,aAAa,CAAC,CAAC,CAAC,kBAAkB,IAAI,WAAW,CAAC,CAAC,CAAC,SAAS,CAAC;QAEnF,MAAM,aAAa,GAAkB;YACnC,QAAQ;YACR,WAAW;YACX,SAAS,EAAE,YAAY,EAAE;YACzB,IAAI,EAAE,IAAI,IAAI,OAAO,CAAC,QAAQ,EAAE,WAAW,CAAC;YAC5C,gBAAgB;YAChB,cAAc;YACd,cAAc;YACd,kBAAkB;YAClB,cAAc,EAAE,cAAc;YAC9B,SAAS,EAAE,YAAY,EAAE;SAC1B,CAAC;QAEF,iBAAiB,CAAC,aAAa,CAAC,CAAC;KAClC;AACH,CAAC,CAAC;AAvCW,QAAA,iBAAiB,qBAuC5B;AAEF,6CAA6C;AACtC,MAAM,WAAW,GAAG,KAAK,EAAE,QAAgB,EAAiB,EAAE;IACnE,kBAAkB,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,CAAC,CAAC;AAC7C,CAAC,CAAC;AAFW,QAAA,WAAW,eAEtB;AAEF,+CAA+C;AACxC,MAAM,iBAAiB,GAAG,KAAK,EAAE,SAAiB,EAAiB,EAAE;IAC1E,kBAAkB,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;AACpC,CAAC,CAAC;AAFW,QAAA,iBAAiB,qBAE5B"}

package/dist/growth-source/types.d.ts

@@ -0,0 +1,25 @@
+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 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;
+};

package/dist/growth-source/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/growth-source/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/growth-source/types.ts"],"names":[],"mappings":""}

package/dist/index.d.ts

@@ -1,7 +1,2 @@
 export * from './cookie';
-export * from './constants';
-export * from './local-storage';
-export * from './e-cna';
-export * from './date-time-helper';
-export * from './country';
-export * from './object';
+export * from './growth-source';

package/dist/index.js

@@ -15,10 +15,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./cookie"), exports);
-__exportStar(require("./constants"), exports);
-__exportStar(require("./local-storage"), exports);
-__exportStar(require("./e-cna"), exports);
-__exportStar(require("./date-time-helper"), exports);
-__exportStar(require("./country"), exports);
-__exportStar(require("./object"), exports);
+__exportStar(require("./growth-source"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,8CAA4B;AAC5B,kDAAgC;AAChC,0CAAwB;AACxB,qDAAmC;AACnC,4CAA0B;AAC1B,2CAA0B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAyB;AACzB,kDAAgC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cuemath/web-utils",
-  "version": "1.0.0-beta.14",
+  "version": "1.0.0",
   "description": "Shared web utils package",
   "main": "dist/index.js",
   "scripts": {
@@ -8,9 +8,7 @@
     "build": "tsc",
     "build-watch": "tsc -w",
     "prepublishOnly": "rm -rf dist && yarn build",
-    "prepare": "husky install",
-    "precommit": "lint-staged",
-    "release": "lerna publish from-package"
+    "prepare": "husky install"
   },
   "repository": {
     "type": "git",
@@ -39,8 +37,6 @@
     "prettier": "2.4.1",
     "typescript": "4.9.4"
   },
-  "dependencies": {
-    "dayjs": "^1.11.7"
-  },
+  "dependencies": {},
   "side-effects": false
 }

package/src/cookie/index.ts

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
 export const getCookie = (name: string, cookie: string = document.cookie): string => {
   if (!cookie) {
     return '';
@@ -29,7 +28,12 @@ export function removeCookie(name: string): void {
   document.cookie = `${name}=; expires=${date.toUTCString()}; path=/`;
 }
 
-export function createCookie(name: string, value: string, days: number): void {
+export function createCookie(
+  name: string,
+  value: string,
+  days: number,
+  subdomain: boolean,
+): void {
   let expires = '';
 
   if (days) {
@@ -38,7 +42,9 @@ export function createCookie(name: string, value: string, days: number): void {
     date.setTime(date.getTime() + days * 24 * 60 * 60 * 1000);
     expires = `; expires=${date.toUTCString()}`;
   }
-  document.cookie = `${name}=${encodeURIComponent(value)}${expires}; path=/`;
+  document.cookie = `${name}=${encodeURIComponent(value)}${expires}; path=/${
+    subdomain ? '; domain=cuemath.com' : ''
+  }`;
 }
 
 export function createCookieWithMidnightExp(name: string, value: string): void {
@@ -48,4 +54,4 @@ export function createCookieWithMidnightExp(name: string, value: string): void {
   const expires = `; expires=${date}`;
 
   document.cookie = `${name}=${value}${expires}; path=/`;
-}
+}

package/src/growth-source/index.ts

@@ -0,0 +1,191 @@
+import type {
+  SourceDetails,
+  Platform,
+  SignupFlow,
+  UTMParams,
+  Experiments,
+  RevenueChannel,
+  UTMParamsKeys,
+} from './types';
+
+import { createCookie, getCookie } from '../cookie';
+
+const SOURCE_DETAILS_COOKIE = 'source_details';
+const UTM_PARAMS: UTMParamsKeys[] = [
+  'utm_source',
+  'utm_medium',
+  'utm_campaign',
+  'utm_term',
+];
+
+export const readSourceCookie = (): SourceDetails => {
+  const sourceDetails = getCookie(SOURCE_DETAILS_COOKIE);
+
+  return sourceDetails ? JSON.parse(decodeURIComponent(sourceDetails)) : undefined;
+};
+
+const writeSourceCookie = (sourceDetails: SourceDetails): void => {
+  createCookie(SOURCE_DETAILS_COOKIE, JSON.stringify(sourceDetails), 365, true);
+};
+
+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,
+    ...sourceDetail,
+  };
+
+  writeSourceCookie(updatedDetails);
+};
+
+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 (utmParams) {
+    const { utm_source: utmSource = '' } = utmParams;
+
+    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 = (): UTMParams | undefined => {
+  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 = (utmParams: UTMParams | undefined): string => {
+  // TODO: UTM source patter for FB, GOOGLE...
+  if (!utmParams) return '';
+
+  const { utm_source: utmSource = '' } = utmParams;
+
+  return utmSource.split('-')[1];
+};
+
+/* 
+  Set Static Source Details of user on Visit of Platform
+*/
+export const initSourceDetails = async ({
+  platform,
+  experiments,
+  flow,
+  affiliateChannel,
+  offlineChannel,
+  organicChannel,
+  performanceChannel,
+  revenueChannel,
+}: 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,
+      offlineChannel,
+      organicChannel,
+      performanceChannel,
+      revenueChannel: revenueChannel,
+      firstPage: getFirstPage(),
+    };
+
+    writeSourceCookie(sourceDetails);
+  }
+};
+
+// Last Page which user visited signup before
+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): Promise<void> => {
+  updateSourceCookie({ flowEntry });
+};

package/src/growth-source/types.ts

@@ -0,0 +1,33 @@
+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 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;
+};

package/src/index.ts

@@ -1,7 +1,2 @@
 export * from './cookie';
-export * from './constants';
-export * from './local-storage';
-export * from './e-cna';
-export * from './date-time-helper';
-export * from './country';
-export * from  './object';
+export * from './growth-source';

package/.eslintignore

@@ -1,2 +0,0 @@
-.next
-/dist

package/.huskyrc

@@ -1,5 +0,0 @@
-{
-  "hooks": {
-    "pre-commit": "lint-staged"
-  }
-}

package/.lintstagedrc.yml

@@ -1,5 +0,0 @@
-linters:
-  ./**/*.ts:
-    - prettier --write
-    - eslint
-    - git add

package/dist/constants/country/index.d.ts

@@ -1,2 +0,0 @@
-export { COUNTRY_NAME_COUNTRY_CODE_MAP as ISO_COUNTRY_CODE } from './iso-country-code';
-export declare const CUE_COUNTRY_CODE_KEY = "cue_country_code";

package/dist/constants/country/index.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CUE_COUNTRY_CODE_KEY = exports.ISO_COUNTRY_CODE = void 0;
-var iso_country_code_1 = require("./iso-country-code");
-Object.defineProperty(exports, "ISO_COUNTRY_CODE", { enumerable: true, get: function () { return iso_country_code_1.COUNTRY_NAME_COUNTRY_CODE_MAP; } });
-exports.CUE_COUNTRY_CODE_KEY = 'cue_country_code';
-//# sourceMappingURL=index.js.map

package/dist/constants/country/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/constants/country/index.ts"],"names":[],"mappings":";;;AAAA,uDAAuF;AAA9E,oHAAA,6BAA6B,OAAoB;AAC7C,QAAA,oBAAoB,GAAG,kBAAkB,CAAC"}