@splendidlabz/tracking 0.1.20

package/lib/fb/utils.js

@@ -0,0 +1,372 @@
+import { isEmpty } from '@splendidlabz/utils'
+import { sha256Hash } from '@splendidlabz/utils/dom'
+
+export async function formatUserData(data) {
+  if (isEmpty(data)) return {}
+
+  // Lowercase all the values
+  for (const [key, value] of Object.entries(data)) {
+    data[key] = value.toLowerCase()
+  }
+
+  const {
+    email,
+    phone,
+    firstName,
+    lastName,
+    birthdate,
+    gender,
+    city,
+    state,
+    zip,
+    country,
+  } = data
+
+  const ret = {}
+
+  if (email) ret.em = await sha256Hash(email)
+  if (phone) ret.ph = await sha256Hash(phone)
+  if (firstName) ret.fn = await sha256Hash(firstName)
+  if (lastName) ret.ln = await sha256Hash(lastName)
+  if (birthdate) ret.db = await sha256Hash(birthdate)
+  if (gender) ret.ge = await sha256Hash(gender)
+  if (city) ret.ct = await sha256Hash(city.replace(' ', ''))
+
+  if (country) {
+    const c = COUNTRY_CODES[country]
+    ret.country = await sha256Hash(c)
+
+    if (c === 'us' && state) {
+      ret.st = await sha256Hash(US_STATE_CODES[state])
+    }
+    if (c !== 'us' && state) {
+      ret.st = await sha256Hash(state.replace(' ', '').replace('-', ''))
+    }
+  }
+  if (zip) ret.zp = await sha256Hash(zip)
+  return ret
+}
+
+const US_STATE_CODES = {
+  alabama: 'al',
+  alaska: 'ak',
+  'american samoa': 'as',
+  arizona: 'az',
+  arkansas: 'ar',
+  'baker island': 'bi',
+  california: 'ca',
+  colorado: 'co',
+  connecticut: 'ct',
+  delaware: 'de',
+  'district of columbia': 'dc',
+  florida: 'fl',
+  'federated states of micronesia': 'fm',
+  georgia: 'ga',
+  guam: 'gu',
+  hawaii: 'hi',
+  'howland island': 'hi',
+  idaho: 'id',
+  illinois: 'il',
+  indiana: 'in',
+  iowa: 'ia',
+  'jarvis island': 'ji',
+  'johnston atoll': 'ja',
+  kansas: 'ks',
+  kentucky: 'ky',
+  'kingman reef': 'kr',
+  louisiana: 'la',
+  maine: 'me',
+  'marshall islands': 'mh',
+  maryland: 'md',
+  massachusetts: 'ma',
+  michigan: 'mi',
+  'midway islands': 'mi',
+  minnesota: 'mn',
+  mississippi: 'ms',
+  missouri: 'mo',
+  montana: 'mt',
+  'navassa island': 'ni',
+  nebraska: 'ne',
+  nevada: 'nv',
+  'new hampshire': 'nh',
+  'new jersey': 'nj',
+  'new mexico': 'nm',
+  'new york': 'ny',
+  'north carolina': 'nc',
+  'north dakota': 'nd',
+  'northern mariana islands': 'mp',
+  ohio: 'oh',
+  oklahoma: 'ok',
+  oregon: 'or',
+  palau: 'pw',
+  'palmyra atoll': 'pa',
+  pennsylvania: 'pa',
+  'puerto rico': 'pr',
+  'rhode island': 'ri',
+  'south carolina': 'sc',
+  'south dakota': 'sd',
+  tennessee: 'tn',
+  texas: 'tx',
+  'u.s. minor outlying islands': 'um',
+  utah: 'ut',
+  vermont: 'vt',
+  virginia: 'va',
+  'virgin islands of the u.s.': 'vi',
+  'wake island': 'wi',
+  washington: 'wa',
+  'west virginia': 'wv',
+  wisconsin: 'wi',
+  wyoming: 'wy',
+}
+
+const COUNTRY_CODES = {
+  afghanistan: 'af',
+  'åland islands': 'ax',
+  albania: 'al',
+  algeria: 'dz',
+  'american samoa': 'as',
+  andorra: 'ad',
+  angola: 'ao',
+  anguilla: 'ai',
+  antarctica: 'aq',
+  'antigua and barbuda': 'ag',
+  argentina: 'ar',
+  armenia: 'am',
+  aruba: 'aw',
+  australia: 'au',
+  austria: 'at',
+  azerbaijan: 'az',
+  bahamas: 'bs',
+  bahrain: 'bh',
+  bangladesh: 'bd',
+  barbados: 'bb',
+  belarus: 'by',
+  belgium: 'be',
+  belize: 'bz',
+  benin: 'bj',
+  bermuda: 'bm',
+  bhutan: 'bt',
+  'bolivia (plurinational state of)': 'bo',
+  'bonaire, sint eustatius and saba': 'bq',
+  'bosnia and herzegovina': 'ba',
+  botswana: 'bw',
+  'bouvet island': 'bv',
+  brazil: 'br',
+  'british indian ocean territory': 'io',
+  'brunei darussalam': 'bn',
+  brunei: 'bn',
+  bulgaria: 'bg',
+  'burkina faso': 'bf',
+  burundi: 'bi',
+  'cabo verde': 'cv',
+  cambodia: 'kh',
+  cameroon: 'cm',
+  canada: 'ca',
+  'cayman islands': 'ky',
+  'central african republic': 'cf',
+  chad: 'td',
+  chile: 'cl',
+  china: 'cn',
+  'christmas island': 'cx',
+  'cocos (keeling) islands': 'cc',
+  colombia: 'co',
+  comoros: 'km',
+  'democratic republic of the congo': 'cd',
+  'cook islands': 'ck',
+  'costa rica': 'cr',
+  "côte d'ivoire": 'ci',
+  croatia: 'hr',
+  cuba: 'cu',
+  curaçao: 'cw',
+  cyprus: 'cy',
+  czechia: 'cz',
+  denmark: 'dk',
+  djibouti: 'dj',
+  dominica: 'dm',
+  'dominican republic': 'do',
+  ecuador: 'ec',
+  egypt: 'eg',
+  'el salvador': 'sv',
+  'equatorial guinea': 'gq',
+  eritrea: 'er',
+  estonia: 'ee',
+  eswatini: 'sz',
+  ethiopia: 'et',
+  'falkland islands': 'fk',
+  'faroe islands': 'fo',
+  fiji: 'fj',
+  finland: 'fi',
+  france: 'fr',
+  'french guiana': 'gf',
+  'french polynesia': 'pf',
+  'french southern territories': 'tf',
+  gabon: 'ga',
+  gambia: 'gm',
+  georgia: 'ge',
+  germany: 'de',
+  ghana: 'gh',
+  gibraltar: 'gi',
+  greece: 'gr',
+  greenland: 'gl',
+  grenada: 'gd',
+  guadeloupe: 'gp',
+  guam: 'gu',
+  guatemala: 'gt',
+  guernsey: 'gg',
+  guinea: 'gn',
+  'guinea-bissau': 'gw',
+  guyana: 'gy',
+  haiti: 'ht',
+  'heard island and mcdonald islands': 'hm',
+  'holy see': 'va',
+  honduras: 'hn',
+  'hong kong': 'hk',
+  hungary: 'hu',
+  iceland: 'is',
+  india: 'in',
+  indonesia: 'id',
+  iran: 'ir',
+  iraq: 'iq',
+  ireland: 'ie',
+  'isle of man': 'im',
+  israel: 'il',
+  italy: 'it',
+  jamaica: 'jm',
+  japan: 'jp',
+  jersey: 'je',
+  jordan: 'jo',
+  kazakhstan: 'kz',
+  kenya: 'ke',
+  kiribati: 'ki',
+  'north korea': 'kp',
+  'south korea': 'kr',
+  kuwait: 'kw',
+  kyrgyzstan: 'kg',
+  laos: 'la',
+  latvia: 'lv',
+  lebanon: 'lb',
+  lesotho: 'ls',
+  liberia: 'lr',
+  libya: 'ly',
+  liechtenstein: 'li',
+  lithuania: 'lt',
+  luxembourg: 'lu',
+  macao: 'mo',
+  madagascar: 'mg',
+  malawi: 'mw',
+  malaysia: 'my',
+  maldives: 'mv',
+  mali: 'ml',
+  malta: 'mt',
+  'marshall islands': 'mh',
+  martinique: 'mq',
+  mauritania: 'mr',
+  mauritius: 'mu',
+  mayotte: 'yt',
+  mexico: 'mx',
+  micronesia: 'fm',
+  moldova: 'md',
+  monaco: 'mc',
+  mongolia: 'mn',
+  montenegro: 'me',
+  montserrat: 'ms',
+  morocco: 'ma',
+  mozambique: 'mz',
+  myanmar: 'mm',
+  namibia: 'na',
+  nauru: 'nr',
+  nepal: 'np',
+  netherlands: 'nl',
+  'new caledonia': 'nc',
+  'new zealand': 'nz',
+  nicaragua: 'ni',
+  niger: 'ne',
+  nigeria: 'ng',
+  niue: 'nu',
+  'norfolk island': 'nf',
+  'north macedonia': 'mk',
+  'northern mariana islands': 'mp',
+  norway: 'no',
+  oman: 'om',
+  pakistan: 'pk',
+  palau: 'pw',
+  palestine: 'ps',
+  panama: 'pa',
+  'papua new guinea': 'pg',
+  paraguay: 'py',
+  peru: 'pe',
+  philippines: 'ph',
+  pitcairn: 'pn',
+  poland: 'pl',
+  portugal: 'pt',
+  'puerto rico': 'pr',
+  qatar: 'qa',
+  réunion: 're',
+  romania: 'ro',
+  'russian federation': 'ru',
+  rwanda: 'rw',
+  'saint barthélemy': 'bl',
+  'saint helena': 'sh',
+  'saint kitts and nevis': 'kn',
+  'saint lucia': 'lc',
+  'saint martin': 'mf',
+  'saint pierre and miquelon': 'pm',
+  'saint vincent and the grenadines': 'vc',
+  samoa: 'ws',
+  'san marino': 'sm',
+  'sao tome and principe': 'st',
+  'saudi arabia': 'sa',
+  senegal: 'sn',
+  serbia: 'rs',
+  seychelles: 'sc',
+  'sierra leone': 'sl',
+  singapore: 'sg',
+  'sint maarten': 'sx',
+  slovakia: 'sk',
+  slovenia: 'si',
+  'solomon islands': 'sb',
+  somalia: 'so',
+  'south africa': 'za',
+  'south georgia and the south sandwich islands': 'gs',
+  'south sudan': 'ss',
+  spain: 'es',
+  'sri lanka': 'lk',
+  sudan: 'sd',
+  suriname: 'sr',
+  'svalbard and jan mayen': 'sj',
+  sweden: 'se',
+  switzerland: 'ch',
+  'syrian arab republic': 'sy',
+  taiwan: 'tw',
+  tajikistan: 'tj',
+  tanzania: 'tz',
+  thailand: 'th',
+  'timor-leste': 'tl',
+  togo: 'tg',
+  tokelau: 'tk',
+  tonga: 'to',
+  'trinidad and tobago': 'tt',
+  tunisia: 'tn',
+  türkiye: 'tr',
+  turkmenistan: 'tm',
+  'turks and caicos islands': 'tc',
+  tuvalu: 'tv',
+  uganda: 'ug',
+  ukraine: 'ua',
+  'united arab emirates': 'ae',
+  'united kingdom': 'gb',
+  'united states minor outlying islands': 'um',
+  'united states': 'us',
+  uruguay: 'uy',
+  uzbekistan: 'uz',
+  vanuatu: 'vu',
+  venezuela: 've',
+  'viet nam': 'vn',
+  'british virgin islands': 'vg',
+  'u.s. virgin islands': 'vi',
+  'wallis and futuna': 'wf',
+  'western sahara': 'eh',
+  yemen: 'ye',
+  zambia: 'zm',
+  zimbabwe: 'zw',
+}

package/lib/posthog/CrossDomainTracking.svelte

@@ -0,0 +1,10 @@
+<script>
+  import { tracking } from './cross-domain'
+  import { onMount } from 'svelte'
+  export let domains = []
+  const rest = { ...$$restProps }
+
+  onMount(_ => {
+    tracking(domains)
+  })
+</script>

package/lib/posthog/cross-domain.js

@@ -0,0 +1,50 @@
+import { cookies, localStore } from '@splendidlabz/utils/dom'
+
+import posthog from 'posthog-js'
+
+function PH(apiKey, options) {
+  posthog.init(apiKey, options)
+
+  return {
+    getDistinctID() {
+      const key = `ph_${apiKey}_posthog`
+      return localStore.get(key) || cookies.get(key)
+    },
+
+    crossDomainTracking(domains) {
+      // Converts domains into array
+      if (typeof domains === 'string') domains = [domains]
+
+      // Adds phid to the link before sending.
+      document.addEventListener('click', event => {
+        const link = event.target.closest('a')
+        if (link === null) return
+
+        // Checks if we should add the posthogID to the URL
+        let href = link.getAttribute('href')
+        const shouldModify = domains.some(domain => href.includes(domain))
+        if (!shouldModify) return
+
+        // If phid is already in the URL, skip
+        const url = new URL(href)
+        if (url.searchParams.has('phid')) return
+
+        // Append phid to the URL
+        const posthogID = this.getDistinctID()
+        url.searchParams.append('phid', posthogID)
+        link.href = url.href
+      })
+    },
+  }
+}
+
+export function identify() {
+  const url = new URL(window.location.href)
+  const phid = url.searchParams.get('phid')
+
+  if (phid) {
+    posthog.identify(phid)
+    url.searchParams.delete('phid')
+    window.history.replaceState({}, '', url.href)
+  }
+}

package/lib/posthog/index.js

@@ -0,0 +1 @@
+export * from './cross-domain.js'

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@splendidlabz/tracking",
+  "version": "0.1.20",
+  "description": "Simple Tracking Helper",
+  "type": "module",
+  "files": [
+    "dist",
+    "lib/fb",
+    "lib/posthog",
+    "lib/convertkit"
+  ],
+  "exports": {
+    "./*": "./lib/*"
+  },
+  "scripts": {
+    "test": "vitest",
+    "test:watch": "vitest --watch",
+    "build": "rollup -c",
+    "release": "npm run build && np"
+  },
+  "author": "Zell Liew <zellwk@gmail.com> (https://zellwk.com/)",
+  "dependencies": {
+    "@splendidlabz/utils": "*",
+    "posthog-js": "^1.114.2",
+    "posthog-node": "^3.6.3",
+    "zl-fetch": "^6.0.2"
+  },
+  "devDependencies": {
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-terser": "^0.4.4",
+    "jsdom": "^24.0.0",
+    "np": "^10.0.0",
+    "rollup": "^4.12.0",
+    "rollup-plugin-commonjs": "^10.1.0",
+    "rollup-plugin-filesize": "^10.0.0",
+    "vitest": "^1.3.1"
+  }
+}