posthog-js-lite 4.1.0 → 4.1.1

package/src/context.ts

@@ -1,170 +0,0 @@
-import { utils } from 'posthog-core'
-import { version } from '../package.json'
-
-export function getContext(window: Window | undefined): any {
-  let context = {}
-  if (window?.navigator) {
-    const userAgent = window.navigator.userAgent
-    const osValue = os(window)
-    context = {
-      ...context,
-      ...(osValue !== undefined && { $os: osValue }),
-      $browser: browser(userAgent, window.navigator.vendor, !!(window as any).opera),
-      $referrer: window.document.referrer,
-      $referring_domain: referringDomain(window.document.referrer),
-      $device: device(userAgent),
-      $current_url: window.location.href,
-      $host: window.location.host,
-      $pathname: window.location.pathname,
-      $browser_version: browserVersion(userAgent, window.navigator.vendor, !!(window as any).opera),
-      $screen_height: window.screen.height,
-      $screen_width: window.screen.width,
-      $screen_dpr: window.devicePixelRatio,
-    }
-  }
-
-  context = {
-    ...context,
-    $lib: 'js',
-    $lib_version: version,
-    $insert_id: Math.random().toString(36).substring(2, 10) + Math.random().toString(36).substring(2, 10),
-    $time: utils.currentTimestamp() / 1000, // epoch time in seconds
-  }
-  return context // TODO: strip empty props?
-}
-
-function includes(haystack: string, needle: string): boolean {
-  return haystack.indexOf(needle) >= 0
-}
-
-function browser(userAgent: string, vendor: string, opera: boolean): string {
-  vendor = vendor || '' // vendor is undefined for at least IE9
-  if (opera || includes(userAgent, ' OPR/')) {
-    if (includes(userAgent, 'Mini')) {
-      return 'Opera Mini'
-    }
-    return 'Opera'
-  } else if (/(BlackBerry|PlayBook|BB10)/i.test(userAgent)) {
-    return 'BlackBerry'
-  } else if (includes(userAgent, 'IEMobile') || includes(userAgent, 'WPDesktop')) {
-    return 'Internet Explorer Mobile'
-  } else if (includes(userAgent, 'SamsungBrowser/')) {
-    // https://developer.samsung.com/internet/user-agent-string-format
-    return 'Samsung Internet'
-  } else if (includes(userAgent, 'Edge') || includes(userAgent, 'Edg/')) {
-    return 'Microsoft Edge'
-  } else if (includes(userAgent, 'FBIOS')) {
-    return 'Facebook Mobile'
-  } else if (includes(userAgent, 'Chrome')) {
-    return 'Chrome'
-  } else if (includes(userAgent, 'CriOS')) {
-    return 'Chrome iOS'
-  } else if (includes(userAgent, 'UCWEB') || includes(userAgent, 'UCBrowser')) {
-    return 'UC Browser'
-  } else if (includes(userAgent, 'FxiOS')) {
-    return 'Firefox iOS'
-  } else if (includes(vendor, 'Apple')) {
-    if (includes(userAgent, 'Mobile')) {
-      return 'Mobile Safari'
-    }
-    return 'Safari'
-  } else if (includes(userAgent, 'Android')) {
-    return 'Android Mobile'
-  } else if (includes(userAgent, 'Konqueror')) {
-    return 'Konqueror'
-  } else if (includes(userAgent, 'Firefox')) {
-    return 'Firefox'
-  } else if (includes(userAgent, 'MSIE') || includes(userAgent, 'Trident/')) {
-    return 'Internet Explorer'
-  } else if (includes(userAgent, 'Gecko')) {
-    return 'Mozilla'
-  } else {
-    return ''
-  }
-}
-
-function browserVersion(userAgent: string, vendor: string, opera: boolean): number | null {
-  const regexList = {
-    'Internet Explorer Mobile': /rv:(\d+(\.\d+)?)/,
-    'Microsoft Edge': /Edge?\/(\d+(\.\d+)?)/,
-    Chrome: /Chrome\/(\d+(\.\d+)?)/,
-    'Chrome iOS': /CriOS\/(\d+(\.\d+)?)/,
-    'UC Browser': /(UCBrowser|UCWEB)\/(\d+(\.\d+)?)/,
-    Safari: /Version\/(\d+(\.\d+)?)/,
-    'Mobile Safari': /Version\/(\d+(\.\d+)?)/,
-    Opera: /(Opera|OPR)\/(\d+(\.\d+)?)/,
-    Firefox: /Firefox\/(\d+(\.\d+)?)/,
-    'Firefox iOS': /FxiOS\/(\d+(\.\d+)?)/,
-    Konqueror: /Konqueror:(\d+(\.\d+)?)/,
-    BlackBerry: /BlackBerry (\d+(\.\d+)?)/,
-    'Android Mobile': /android\s(\d+(\.\d+)?)/,
-    'Samsung Internet': /SamsungBrowser\/(\d+(\.\d+)?)/,
-    'Internet Explorer': /(rv:|MSIE )(\d+(\.\d+)?)/,
-    Mozilla: /rv:(\d+(\.\d+)?)/,
-  }
-
-  const browserString = browser(userAgent, vendor, opera) as keyof typeof regexList
-  const regex: RegExp = regexList[browserString] || undefined
-
-  if (regex === undefined) {
-    return null
-  }
-  const matches = userAgent.match(regex)
-  if (!matches) {
-    return null
-  }
-  return parseFloat(matches[matches.length - 2])
-}
-
-function os(window: Window | undefined): string | undefined {
-  if (!window?.navigator) {
-    return undefined
-  }
-  const a = window.navigator.userAgent
-  if (/Windows/i.test(a)) {
-    if (/Phone/.test(a) || /WPDesktop/.test(a)) {
-      return 'Windows Phone'
-    }
-    return 'Windows'
-  } else if (/(iPhone|iPad|iPod)/.test(a)) {
-    return 'iOS'
-  } else if (/Android/.test(a)) {
-    return 'Android'
-  } else if (/(BlackBerry|PlayBook|BB10)/i.test(a)) {
-    return 'BlackBerry'
-  } else if (/Mac/i.test(a)) {
-    return 'Mac OS X'
-  } else if (/Linux/.test(a)) {
-    return 'Linux'
-  } else if (/CrOS/.test(a)) {
-    return 'Chrome OS'
-  } else {
-    return undefined
-  }
-}
-
-function device(userAgent: string): string {
-  if (/Windows Phone/i.test(userAgent) || /WPDesktop/.test(userAgent)) {
-    return 'Windows Phone'
-  } else if (/iPad/.test(userAgent)) {
-    return 'iPad'
-  } else if (/iPod/.test(userAgent)) {
-    return 'iPod Touch'
-  } else if (/iPhone/.test(userAgent)) {
-    return 'iPhone'
-  } else if (/(BlackBerry|PlayBook|BB10)/i.test(userAgent)) {
-    return 'BlackBerry'
-  } else if (/Android/.test(userAgent)) {
-    return 'Android'
-  } else {
-    return ''
-  }
-}
-
-function referringDomain(referrer: string): string {
-  const split = referrer.split('/')
-  if (split.length >= 3) {
-    return split[2]
-  }
-  return ''
-}

package/src/patch.ts

@@ -1,50 +0,0 @@
-// import { patch } from 'rrweb/typings/utils'
-// copied from: https://github.com/PostHog/posthog-js/blob/main/src/extensions/replay/rrweb-plugins/patch.ts
-// which was copied from https://github.com/rrweb-io/rrweb/blob/8aea5b00a4dfe5a6f59bd2ae72bb624f45e51e81/packages/rrweb/src/utils.ts#L129
-// which was copied from https://github.com/getsentry/sentry-javascript/blob/b2109071975af8bf0316d3b5b38f519bdaf5dc15/packages/utils/src/object.ts
-
-// copied from: https://github.com/PostHog/posthog-js/blob/main/react/src/utils/type-utils.ts#L4
-export const isFunction = function (f: any): f is (...args: any[]) => any {
-  return typeof f === 'function'
-}
-
-export function patch(
-  source: { [key: string]: any },
-  name: string,
-  replacement: (...args: unknown[]) => unknown
-): () => void {
-  try {
-    if (!(name in source)) {
-      return () => {
-        //
-      }
-    }
-
-    const original = source[name] as () => unknown
-    const wrapped = replacement(original)
-
-    // Make sure it's a function first, as we need to attach an empty prototype for `defineProperties` to work
-    // otherwise it'll throw "TypeError: Object.defineProperties called on non-object"
-    if (isFunction(wrapped)) {
-      wrapped.prototype = wrapped.prototype || {}
-      Object.defineProperties(wrapped, {
-        __posthog_wrapped__: {
-          enumerable: false,
-          value: true,
-        },
-      })
-    }
-
-    source[name] = wrapped
-
-    return () => {
-      source[name] = original
-    }
-  } catch {
-    return () => {
-      //
-    }
-    // This can throw if multiple fill happens on a global object like XMLHttpRequest
-    // Fixes https://github.com/getsentry/sentry-javascript/issues/2043
-  }
-}

package/src/posthog-web.ts

@@ -1,141 +0,0 @@
-import { version } from '../package.json'
-
-import { PostHogCore, getFetch } from 'posthog-core'
-import type {
-  PostHogEventProperties,
-  PostHogFetchOptions,
-  PostHogFetchResponse,
-  PostHogPersistedProperty,
-} from 'posthog-core'
-
-import { getContext } from './context'
-import { PostHogStorage, getStorage } from './storage'
-import { PostHogOptions } from './types'
-import { patch } from './patch'
-
-export class PostHog extends PostHogCore {
-  private _storage: PostHogStorage
-  private _storageCache: any
-  private _storageKey: string
-  private _lastPathname: string = ''
-
-  constructor(apiKey: string, options?: PostHogOptions) {
-    super(apiKey, options)
-
-    // posthog-js stores options in one object on
-    this._storageKey = options?.persistence_name ? `ph_${options.persistence_name}` : `ph_${apiKey}_posthog`
-
-    this._storage = getStorage(options?.persistence || 'localStorage', this.getWindow())
-    this.setupBootstrap(options)
-
-    if (options?.preloadFeatureFlags !== false) {
-      this.reloadFeatureFlags()
-    }
-
-    if (options?.captureHistoryEvents && typeof window !== 'undefined') {
-      this._lastPathname = window?.location?.pathname || ''
-      this.setupHistoryEventTracking()
-    }
-  }
-
-  private getWindow(): Window | undefined {
-    return typeof window !== 'undefined' ? window : undefined
-  }
-
-  getPersistedProperty<T>(key: PostHogPersistedProperty): T | undefined {
-    if (!this._storageCache) {
-      this._storageCache = JSON.parse(this._storage.getItem(this._storageKey) || '{}') || {}
-    }
-
-    return this._storageCache[key]
-  }
-
-  setPersistedProperty<T>(key: PostHogPersistedProperty, value: T | null): void {
-    if (!this._storageCache) {
-      this._storageCache = JSON.parse(this._storage.getItem(this._storageKey) || '{}') || {}
-    }
-
-    if (value === null) {
-      delete this._storageCache[key]
-    } else {
-      this._storageCache[key] = value
-    }
-
-    this._storage.setItem(this._storageKey, JSON.stringify(this._storageCache))
-  }
-
-  fetch(url: string, options: PostHogFetchOptions): Promise<PostHogFetchResponse> {
-    const fetchFn = getFetch()
-
-    if (!fetchFn) {
-      // error will be handled by the caller (fetchWithRetry)
-      return Promise.reject(new Error('Fetch API is not available in this environment.'))
-    }
-
-    return fetchFn(url, options)
-  }
-
-  getLibraryId(): string {
-    return 'posthog-js-lite'
-  }
-
-  getLibraryVersion(): string {
-    return version
-  }
-
-  getCustomUserAgent(): void {
-    return
-  }
-
-  getCommonEventProperties(): PostHogEventProperties {
-    return {
-      ...super.getCommonEventProperties(),
-      ...getContext(this.getWindow()),
-    }
-  }
-
-  private setupHistoryEventTracking(): void {
-    const window = this.getWindow()
-    if (!window) {
-      return
-    }
-
-    // Old fashioned, we could also use arrow functions but I think the closure for a patch is more reliable
-    // eslint-disable-next-line @typescript-eslint/no-this-alias
-    const self = this
-
-    patch(window.history, 'pushState', (originalPushState) => {
-      return function patchedPushState(this: History, state: any, title: string, url?: string | URL | null): void {
-        ;(originalPushState as History['pushState']).call(this, state, title, url)
-        self.captureNavigationEvent('pushState')
-      }
-    })
-
-    patch(window.history, 'replaceState', (originalReplaceState) => {
-      return function patchedReplaceState(this: History, state: any, title: string, url?: string | URL | null): void {
-        ;(originalReplaceState as History['replaceState']).call(this, state, title, url)
-        self.captureNavigationEvent('replaceState')
-      }
-    })
-
-    // For popstate we need to listen to the event instead of overriding a method
-    window.addEventListener('popstate', () => {
-      this.captureNavigationEvent('popstate')
-    })
-  }
-
-  private captureNavigationEvent(navigationType: 'pushState' | 'replaceState' | 'popstate'): void {
-    const window = this.getWindow()
-    if (!window) {
-      return
-    }
-
-    const currentPathname = window.location.pathname
-
-    // Only capture pageview if the pathname has changed
-    if (currentPathname !== this._lastPathname) {
-      this.capture('$pageview', { navigation_type: navigationType })
-      this._lastPathname = currentPathname
-    }
-  }
-}

package/src/storage.ts

@@ -1,168 +0,0 @@
-import { PostHogOptions } from './types'
-
-export type PostHogStorage = {
-  getItem: (key: string) => string | null | undefined
-  setItem: (key: string, value: string) => void
-  removeItem: (key: string) => void
-  clear: () => void
-  getAllKeys: () => readonly string[]
-}
-
-// Methods partially borrowed from quirksmode.org/js/cookies.html
-export const cookieStore: PostHogStorage = {
-  getItem(key) {
-    try {
-      const nameEQ = key + '='
-      const ca = document.cookie.split(';')
-      for (let i = 0; i < ca.length; i++) {
-        let c = ca[i]
-        while (c.charAt(0) == ' ') {
-          c = c.substring(1, c.length)
-        }
-        if (c.indexOf(nameEQ) === 0) {
-          return decodeURIComponent(c.substring(nameEQ.length, c.length))
-        }
-      }
-    } catch (err) {}
-    return null
-  },
-
-  setItem(key: string, value: string) {
-    try {
-      const cdomain = '',
-        expires = '',
-        secure = ''
-
-      const new_cookie_val = key + '=' + encodeURIComponent(value) + expires + '; path=/' + cdomain + secure
-      document.cookie = new_cookie_val
-    } catch (err) {
-      return
-    }
-  },
-
-  removeItem(name) {
-    try {
-      cookieStore.setItem(name, '')
-    } catch (err) {
-      return
-    }
-  },
-  clear() {
-    document.cookie = ''
-  },
-  getAllKeys() {
-    const ca = document.cookie.split(';')
-    const keys = []
-
-    for (let i = 0; i < ca.length; i++) {
-      let c = ca[i]
-      while (c.charAt(0) == ' ') {
-        c = c.substring(1, c.length)
-      }
-      keys.push(c.split('=')[0])
-    }
-
-    return keys
-  },
-}
-
-const createStorageLike = (store: any): PostHogStorage => {
-  return {
-    getItem(key) {
-      return store.getItem(key)
-    },
-
-    setItem(key, value) {
-      store.setItem(key, value)
-    },
-
-    removeItem(key) {
-      store.removeItem(key)
-    },
-    clear() {
-      store.clear()
-    },
-    getAllKeys() {
-      const keys = []
-      for (const key in localStorage) {
-        keys.push(key)
-      }
-      return keys
-    },
-  }
-}
-
-const checkStoreIsSupported = (storage: PostHogStorage, key = '__mplssupport__'): boolean => {
-  try {
-    const val = 'xyz'
-    storage.setItem(key, val)
-    if (storage.getItem(key) !== val) {
-      return false
-    }
-    storage.removeItem(key)
-    return true
-  } catch (err) {
-    return false
-  }
-}
-
-let localStore: PostHogStorage | undefined = undefined
-let sessionStore: PostHogStorage | undefined = undefined
-
-const createMemoryStorage = (): PostHogStorage => {
-  const _cache: { [key: string]: any | undefined } = {}
-
-  const store: PostHogStorage = {
-    getItem(key) {
-      return _cache[key]
-    },
-
-    setItem(key, value) {
-      _cache[key] = value !== null ? value : undefined
-    },
-
-    removeItem(key) {
-      delete _cache[key]
-    },
-    clear() {
-      for (const key in _cache) {
-        delete _cache[key]
-      }
-    },
-    getAllKeys() {
-      const keys = []
-      for (const key in _cache) {
-        keys.push(key)
-      }
-      return keys
-    },
-  }
-  return store
-}
-
-export const getStorage = (type: PostHogOptions['persistence'], window: Window | undefined): PostHogStorage => {
-  if (window) {
-    if (!localStore) {
-      const _localStore = createStorageLike(window.localStorage)
-      localStore = checkStoreIsSupported(_localStore) ? _localStore : undefined
-    }
-
-    if (!sessionStore) {
-      const _sessionStore = createStorageLike(window.sessionStorage)
-      sessionStore = checkStoreIsSupported(_sessionStore) ? _sessionStore : undefined
-    }
-  }
-
-  switch (type) {
-    case 'cookie':
-      return cookieStore || localStore || sessionStore || createMemoryStorage()
-    case 'localStorage':
-      return localStore || sessionStore || createMemoryStorage()
-    case 'sessionStorage':
-      return sessionStore || createMemoryStorage()
-    case 'memory':
-      return createMemoryStorage()
-    default:
-      return createMemoryStorage()
-  }
-}

package/src/types.ts

@@ -1,8 +0,0 @@
-import type { PostHogCoreOptions } from 'posthog-core'
-
-export type PostHogOptions = {
-  autocapture?: boolean
-  persistence?: 'localStorage' | 'sessionStorage' | 'cookie' | 'memory'
-  persistence_name?: string
-  captureHistoryEvents?: boolean
-} & PostHogCoreOptions