posthog-js-lite 0.0.3 → 2.0.0-alpha1

package/src/__tests__/index.js

@@ -1,47 +0,0 @@
-import { createInternalPostHogInstance } from '../index'
-import { LZString } from '../utils/lz-string'
-
-const testWindow = {
-    navigator: {
-        userAgent: 'not me / Mozilla',
-    },
-    document: {
-        referrer: '',
-    },
-    location: {
-        href: 'http://example.com/',
-        host: 'example.com',
-        pathname: '/',
-    },
-    screen: {
-        width: 640,
-        height: 480,
-    },
-}
-
-test('capture makes a window.fetch call', () => {
-    expect(true).toBe(true)
-
-    const fetchCalled = []
-
-    const postHog = createInternalPostHogInstance(
-        'API_KEY_WAS_HERE',
-        {
-            fetch: async (url, options) => {
-                fetchCalled.push({ url, options })
-            },
-        },
-        testWindow
-    )
-
-    postHog.capture('hi there!')
-
-    expect(fetchCalled.length).toBe(1)
-    expect(fetchCalled[0].url).toMatch(/^https:\/\/app\.posthog\.com\/e\/\?ip=1&_=[0-9]+&v=[0-9\.a-z\-]+$/)
-    expect(fetchCalled[0].options.method).toBe('POST')
-    const bodyText = decodeURIComponent(fetchCalled[0].options.body.split('&')[0].split('=')[1])
-    const body = JSON.parse(LZString.decompressFromBase64(bodyText))
-
-    expect(body.api_key).toBe('API_KEY_WAS_HERE')
-    expect(body.batch[0].event).toBe('hi there!')
-})

package/src/index.ts

@@ -1,127 +0,0 @@
-import { version } from '../package.json'
-import { PostHogAPIRequest, PostHogOptions, PostHogSession } from './types'
-import { currentISOTime, currentTimestamp, generateUUID } from './utils/utils'
-import { getContext } from './utils/context'
-
-import { LZString } from './utils/lz-string.js'
-
-const defaultOptions: PostHogOptions = {
-    apiHost: 'https://app.posthog.com',
-    maxQueueLength: 1,
-    optedIn: true,
-}
-
-export function createInternalPostHogInstance(apiKey: string, options: PostHogOptions, globalThis: any) {
-    const session = {} as Partial<PostHogSession> // getDataFromCookiesAndLocalStorage
-    const anonymousId = generateUUID()
-
-    let postHogInstance = {
-        options: { ...defaultOptions, ...options, apiKey } as Required<PostHogOptions>,
-
-        session: {
-            anonymousId: anonymousId,
-            distinctId: anonymousId,
-            ...session,
-        } as PostHogSession,
-
-        getDistinctId() {
-            return postHogInstance.session.distinctId
-        },
-
-        getContextProperties() {
-            return {
-                $lib: 'posthog-js-lite',
-                $lib_version: version,
-            }
-        },
-
-        optedIn() {
-            return postHogInstance.options.optedIn
-        },
-
-        optIn() {
-            postHogInstance.options.optedIn = true
-            postHogInstance.flush()
-        },
-
-        optOut() {
-            postHogInstance.options.optedIn = false
-        },
-
-        capture(event: string, properties = {}) {
-            postHogInstance.enqueue({
-                event,
-                distinct_id: postHogInstance.getDistinctId(),
-                timestamp: currentISOTime(),
-                properties: {
-                    ...getContext(globalThis), // TODO: debounce this, no need to do every event
-                    ...properties,
-                },
-            })
-        },
-
-        identify(distinctId: string | null, userProperties = {}) {
-            postHogInstance.enqueue({
-                event: '$identify',
-                distinct_id: distinctId || postHogInstance.session.anonymousId,
-                timestamp: currentISOTime(),
-                $set: {
-                    ...userProperties,
-                },
-                properties: {
-                    ...getContext(globalThis),
-                    $anon_distinct_id: postHogInstance.session.anonymousId,
-                },
-            })
-            if (distinctId) {
-                postHogInstance.session.distinctId = distinctId
-            }
-        },
-
-        queue: [] as PostHogAPIRequest[],
-        enqueue(apiRequest: PostHogAPIRequest) {
-            postHogInstance.queue.push(apiRequest)
-
-            if (postHogInstance.optedIn() && postHogInstance.queue.length >= postHogInstance.options.maxQueueLength) {
-                postHogInstance.flush()
-            }
-        },
-
-        flush() {
-            let queue = postHogInstance.queue
-            postHogInstance.queue = []
-            postHogInstance.makeRequest(queue)
-        },
-
-        makeRequest: async function (events: PostHogAPIRequest[]) {
-            const requestData = {
-                api_key: postHogInstance.options.apiKey,
-                batch: events,
-                sent_at: currentISOTime(),
-            }
-
-            const url = `${postHogInstance.options.apiHost}/e/?ip=1&_=${currentTimestamp()}&v=${version}`
-
-            const payload = JSON.stringify(requestData)
-            const compressedPayload = LZString.compressToBase64(payload)
-
-            const fetchOptions = {
-                method: 'POST',
-                mode: 'no-cors',
-                credentials: 'omit',
-                headers: { 'Content-Type': 'application/x-www-form-urlencoded' },
-                body: `data=${encodeURIComponent(compressedPayload)}&compression=lz64`,
-            }
-
-            try {
-                const rawResponse = await postHogInstance.options.fetch(url, fetchOptions)
-                const body = await rawResponse.text()
-            } catch (error) {
-                // TODO: retry if fails?
-                throw error
-            }
-        },
-    }
-
-    return postHogInstance
-}

package/src/targets/browser.ts

@@ -1,17 +0,0 @@
-/* global window */
-import { createInternalPostHogInstance } from '../index'
-import { PostHogOptions } from '../types'
-
-function autoCapturePlugin() {}
-
-export function browserPostHog(apiKey: string, options: PostHogOptions = {}) {
-    return createInternalPostHogInstance(
-        apiKey,
-        {
-            ...options,
-            fetch: window.fetch.bind(window),
-            plugins: [...(options.plugins || []), autoCapturePlugin()],
-        },
-        window
-    )
-}

package/src/targets/node.ts

@@ -1,6 +0,0 @@
-import { PostHogOptions } from '../types'
-import { createInternalPostHogInstance } from '../index'
-
-export function nodePostHog(apiKey: string, options: PostHogOptions = {}) {
-    return createInternalPostHogInstance(apiKey, options, globalThis)
-}

package/src/types.ts

@@ -1,22 +0,0 @@
-export type PostHogOptions = {
-    plugins?: any[]
-    apiHost?: string
-    loaded?: () => any
-    fetch?: any
-    apiKey?: string
-    maxQueueLength?: number
-    optedIn?: boolean
-}
-
-export type PostHogSession = {
-    distinctId: string
-    anonymousId: string
-}
-
-export type PostHogAPIRequest = {
-    event: string
-    distinct_id: string
-    timestamp: string
-    properties?: Record<string, unknown>
-    $set?: Record<string, unknown>
-}

package/src/utils/context.ts

@@ -1,158 +0,0 @@
-import { version } from '../../package.json'
-import { currentTimestamp } from './utils'
-
-export function getContext(window: Window) {
-    const userAgent = window.navigator.userAgent
-    const context = {
-        $os: os(window),
-        $browser: browser(userAgent, 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,
-        $lib: 'js',
-        $lib_version: version,
-        $insert_id: Math.random().toString(36).substring(2, 10) + Math.random().toString(36).substring(2, 10),
-        $time: currentTimestamp() / 1000, // epoch time in seconds
-    }
-    return context // TODO: strip empty props?
-}
-
-function includes(haystack: string, needle: string) {
-    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) {
-    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
-    }
-    var matches = userAgent.match(regex)
-    if (!matches) {
-        return null
-    }
-    return parseFloat(matches[matches.length - 2])
-}
-
-function os(window: Window) {
-    var 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 ''
-    }
-}
-
-function device(userAgent: 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) {
-    var split = referrer.split('/')
-    if (split.length >= 3) {
-        return split[2]
-    }
-    return ''
-}