@cuemath/web-utils 0.0.1-beta.6 → 0.0.2-beta.0

package/.husky/pre-commit

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

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cuemath/web-utils",
-  "version": "0.0.1-beta.6",
+  "version": "0.0.2-beta.0",
   "description": "Shareable utils package",
   "main": "dist/index.js",
   "scripts": {
@@ -8,8 +8,7 @@
     "build": "tsc",
     "build-watch": "tsc -w",
     "prepublishOnly": "rm -rf dist && yarn build",
-    "prepare": "husky install",
-    "precommit": "lint-staged"
+    "prepare": "husky install"
   },
   "repository": {
     "type": "git",
@@ -25,28 +24,19 @@
     "@cuemath/eslint-config": "1.0.9",
     "@cuemath/prettier-config": "1.0.3",
     "@cuemath/ts-config": "0.0.5",
-    "@react-native-community/eslint-config": "^3.2.0",
+    "@react-native-community/eslint-config": "3.2.0",
     "@types/uuid": "9.0.0",
     "@typescript-eslint/eslint-plugin": "5.47.0",
     "@typescript-eslint/parser": "5.47.0",
-    "eslint": "^7.32.0",
+    "eslint": "8.1.0",
     "eslint-config-prettier": "8.5.0",
     "eslint-plugin-import": "2.26.0",
+    "eslint-plugin-jest": "^27.2.1",
     "eslint-plugin-prettier": "4.2.1",
     "husky": "8.0.2",
-    "lint-staged": ">=10",
-    "prettier": "^2.8.1",
+    "prettier": "2.4.1",
     "typescript": "4.9.4"
   },
-  "dependencies": {
-    "@types/node": "^18.11.18",
-    "dayjs": "^1.11.7",
-    "typescript": "4.9.4"
-  },
-  "lint-staged": {
-    "*.{js,json,css,scss,html,md,ts}": [
-      "prettier --write",
-      "git add"
-    ]
-  }
+  "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 ? '; .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,172 @@
+import type {
+  SourceDetails,
+  Platform,
+  SignupFlow,
+  UTMParams,
+  Experiments,
+  RevenueChannel,
+  UTMParamsKeys,
+} from './types';
+
+import { createCookie, getCookie } from '../cookie';
+
+const SOURCE_DETAILS_COOKIE = 'source_details_v1';
+const UTM_PARAMS: UTMParamsKeys[] = [
+  'utm_source',
+  'utm_medium',
+  'utm_campaign',
+  'utm_term',
+];
+
+const readSourceCookie = () => {
+  const sourceDetails = getCookie(SOURCE_DETAILS_COOKIE);
+
+  return sourceDetails && JSON.parse(sourceDetails);
+};
+
+const writeSourceCookie = (sourceDetails: SourceDetails) => {
+  createCookie(SOURCE_DETAILS_COOKIE, JSON.stringify(sourceDetails), 365, true);
+};
+
+const updateSourceCookie = (sourceDetail: Partial<SourceDetails>) => {
+  const sourceDetails: SourceDetails = readSourceCookie();
+  const updatedDetails: SourceDetails = {
+    ...sourceDetails,
+    ...sourceDetail,
+  };
+
+  writeSourceCookie(updatedDetails);
+};
+
+const getRevenueChannel = (platform: Platform, utmParams?: UTMParams) => {
+  let revenueChannel: RevenueChannel = 'UNKNOWN';
+
+  if (platform === 'ASTRO' && 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):
+      default:
+        revenueChannel = 'PERFORMANCE';
+    }
+  }
+
+  if (platform === 'WEBSITE') {
+    revenueChannel = 'ORGANIC';
+  }
+
+  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) => {
+  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' ? 'ECNA' : 'REGULAR';
+    }
+  }
+
+  return flow;
+};
+
+const getUTMParams = () => {
+  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 = () => {
+  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) => {
+  // 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,
+  utmParams,
+  flow,
+  affiliateChannel,
+  offlineChannel,
+  organicChannel,
+  performanceChannel,
+  revenueChannel,
+}: SourceDetails) => {
+  if (!readSourceCookie()) {
+    const leadChannel = getChannel(utmParams);
+
+    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),
+      firstPage: getFirstPage(),
+    };
+
+    writeSourceCookie(sourceDetails);
+  }
+};
+
+// Last Page which user visited signup before
+export const setLastPage = async (pagePath: string) => {
+  updateSourceCookie({ lastPage: pagePath });
+};
+
+// set Entry point where user clicked to Signup
+export const setFlowEntryPoint = async (flowEntry: string) => {
+  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' | 'ECNA' | 'ESALES';
+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"}

package/dist/constants/country/iso-country-code.d.ts

@@ -1,248 +0,0 @@
-export declare const COUNTRY_NAME_COUNTRY_CODE_MAP: {
-    AFGHANISTAN: string;
-    'ALAND ISLANDS': string;
-    ALBANIA: string;
-    ALGERIA: string;
-    'AMERICAN SAMOA': string;
-    ANDORRA: string;
-    ANGOLA: string;
-    ANGUILLA: string;
-    ANTARCTICA: string;
-    'ANTIGUA AND BARBUDA': string;
-    ARGENTINA: string;
-    ARMENIA: string;
-    ARUBA: string;
-    AUSTRALIA: string;
-    AUSTRIA: string;
-    AZERBAIJAN: string;
-    BAHAMAS: string;
-    BAHRAIN: string;
-    BANGLADESH: string;
-    BARBADOS: string;
-    BELARUS: string;
-    BELGIUM: string;
-    BELIZE: string;
-    BENIN: string;
-    BERMUDA: string;
-    BHUTAN: string;
-    BOLIVIA: string;
-    'BOSNIA AND HERZEGOVINA': string;
-    BOTSWANA: string;
-    'BOUVET ISLAND': string;
-    BRAZIL: string;
-    'BRITISH INDIAN OCEAN TERRITORY': string;
-    'BRUNEI DARUSSALAM': string;
-    BULGARIA: string;
-    'BURKINA FASO': string;
-    BURUNDI: string;
-    CAMBODIA: string;
-    CAMEROON: string;
-    CANADA: string;
-    'CAPE VERDE': string;
-    'CAYMAN ISLANDS': string;
-    'CENTRAL AFRICAN REPUBLIC': string;
-    CHAD: string;
-    CHILE: string;
-    CHINA: string;
-    'CHRISTMAS ISLAND': string;
-    'COCOS (KEELING) ISLANDS': string;
-    COLOMBIA: string;
-    COMOROS: string;
-    CONGO: string;
-    'CONGO, DEMOCRATIC REPUBLIC': string;
-    'COOK ISLANDS': string;
-    'COSTA RICA': string;
-    'COTE D"IVOIRE': string;
-    CROATIA: string;
-    CUBA: string;
-    CYPRUS: string;
-    'CZECH REPUBLIC': string;
-    DENMARK: string;
-    DJIBOUTI: string;
-    DOMINICA: string;
-    'DOMINICAN REPUBLIC': string;
-    ECUADOR: string;
-    EGYPT: string;
-    'EL SALVADOR': string;
-    'EQUATORIAL GUINEA': string;
-    ERITREA: string;
-    ESTONIA: string;
-    ETHIOPIA: string;
-    'FALKLAND ISLANDS (MALVINAS)': string;
-    'FAROE ISLANDS': string;
-    FIJI: string;
-    FINLAND: string;
-    FRANCE: string;
-    'FRENCH GUIANA': string;
-    'FRENCH POLYNESIA': string;
-    'FRENCH SOUTHERN TERRITORIES': string;
-    GABON: string;
-    GAMBIA: string;
-    GEORGIA: string;
-    GERMANY: string;
-    GHANA: string;
-    GIBRALTAR: string;
-    GREECE: string;
-    GREENLAND: string;
-    GRENADA: string;
-    GUADELOUPE: string;
-    GUAM: string;
-    GUATEMALA: string;
-    GUERNSEY: string;
-    GUINEA: string;
-    'GUINEA-BISSAU': string;
-    GUYANA: string;
-    HAITI: string;
-    'HEARD ISLAND & MCDONALD ISLANDS': string;
-    'HOLY SEE (VATICAN CITY STATE)': string;
-    HONDURAS: string;
-    'HONG KONG': string;
-    HUNGARY: string;
-    ICELAND: string;
-    INDIA: string;
-    INDONESIA: string;
-    'IRAN, ISLAMIC REPUBLIC OF': string;
-    IRAQ: string;
-    IRELAND: string;
-    'ISLE OF MAN': string;
-    ISRAEL: string;
-    ITALY: string;
-    JAMAICA: string;
-    JAPAN: string;
-    JERSEY: string;
-    JORDAN: string;
-    KAZAKHSTAN: string;
-    KENYA: string;
-    KIRIBATI: string;
-    KOREA: string;
-    'NORTH KOREA': string;
-    KUWAIT: string;
-    KYRGYZSTAN: string;
-    'LAO PEOPLE"S DEMOCRATIC REPUBLIC': string;
-    LATVIA: string;
-    LEBANON: string;
-    LESOTHO: string;
-    LIBERIA: string;
-    'LIBYAN ARAB JAMAHIRIYA': string;
-    LIECHTENSTEIN: string;
-    LITHUANIA: string;
-    LUXEMBOURG: string;
-    MACAO: string;
-    MACEDONIA: string;
-    MADAGASCAR: string;
-    MALAWI: string;
-    MALAYSIA: string;
-    MALDIVES: string;
-    MALI: string;
-    MALTA: string;
-    'MARSHALL ISLANDS': string;
-    MARTINIQUE: string;
-    MAURITANIA: string;
-    MAURITIUS: string;
-    MAYOTTE: string;
-    MEXICO: string;
-    'MICRONESIA, FEDERATED STATES OF': string;
-    MOLDOVA: string;
-    MONACO: string;
-    MONGOLIA: string;
-    MONTENEGRO: string;
-    MONTSERRAT: string;
-    MOROCCO: string;
-    MOZAMBIQUE: string;
-    MYANMAR: string;
-    NAMIBIA: string;
-    NAURU: string;
-    NEPAL: string;
-    NETHERLANDS: string;
-    'NETHERLANDS ANTILLES': string;
-    'NEW CALEDONIA': string;
-    'NEW ZEALAND': string;
-    NICARAGUA: string;
-    NIGER: string;
-    NIGERIA: string;
-    NIUE: string;
-    'NORFOLK ISLAND': string;
-    'NORTHERN MARIANA ISLANDS': string;
-    NORWAY: string;
-    OMAN: string;
-    PAKISTAN: string;
-    PALAU: string;
-    'PALESTINIAN TERRITORY, OCCUPIED': string;
-    PANAMA: string;
-    'PAPUA NEW GUINEA': string;
-    PARAGUAY: string;
-    PERU: string;
-    PHILIPPINES: string;
-    PITCAIRN: string;
-    POLAND: string;
-    PORTUGAL: string;
-    'PUERTO RICO': string;
-    QATAR: string;
-    REUNION: string;
-    ROMANIA: string;
-    'RUSSIAN FEDERATION': string;
-    RWANDA: string;
-    'SAINT BARTHELEMY': string;
-    'SAINT HELENA': string;
-    'SAINT KITTS AND NEVIS': string;
-    'SAINT LUCIA': string;
-    'SAINT MARTIN': string;
-    'SAINT PIERRE AND MIQUELON': string;
-    'SAINT VINCENT AND GRENADINES': string;
-    SAMOA: string;
-    'SAN MARINO': string;
-    'SAO TOME AND PRINCIPE': string;
-    'SAUDI ARABIA': string;
-    SENEGAL: string;
-    SERBIA: string;
-    SEYCHELLES: string;
-    'SIERRA LEONE': string;
-    SINGAPORE: string;
-    SLOVAKIA: string;
-    SLOVENIA: string;
-    'SOLOMON ISLANDS': string;
-    SOMALIA: string;
-    'SOUTH AFRICA': string;
-    'SOUTH GEORGIA AND SANDWICH ISL.': string;
-    SPAIN: string;
-    'SRI LANKA': string;
-    SUDAN: string;
-    SURINAME: string;
-    'SVALBARD AND JAN MAYEN': string;
-    SWAZILAND: string;
-    SWEDEN: string;
-    SWITZERLAND: string;
-    'SYRIAN ARAB REPUBLIC': string;
-    TAIWAN: string;
-    TAJIKISTAN: string;
-    TANZANIA: string;
-    THAILAND: string;
-    'TIMOR-LESTE': string;
-    TOGO: string;
-    TOKELAU: string;
-    TONGA: string;
-    'TRINIDAD AND TOBAGO': string;
-    TUNISIA: string;
-    TURKEY: string;
-    TURKMENISTAN: string;
-    'TURKS AND CAICOS ISLANDS': string;
-    TUVALU: string;
-    UGANDA: string;
-    UKRAINE: string;
-    'UNITED ARAB EMIRATES': string;
-    'UNITED KINGDOM': string;
-    'UNITED STATES': string;
-    'UNITED STATES OUTLYING ISLANDS': string;
-    URUGUAY: string;
-    UZBEKISTAN: string;
-    VANUATU: string;
-    VENEZUELA: string;
-    VIETNAM: string;
-    'VIRGIN ISLANDS, BRITISH': string;
-    'VIRGIN ISLANDS, U.S.': string;
-    'WALLIS AND FUTUNA': string;
-    'WESTERN SAHARA': string;
-    YEMEN: string;
-    ZAMBIA: string;
-    ZIMBABWE: string;
-};