posthog-js-lite 3.4.1 → 3.5.0

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Next
 
+# 3.5.0 – 2025-04-17
+
+## Added
+
+1. chore: roll out new flag evaluation backend to majority of customers
+
+# 3.4.2 - 2025-02-27
+
+## Added
+
+1. Added `captureHistoryEvents` option to automatically capture navigation events in single-page applications using the History API.
+
+## Fixed
+
+1. apiKey cannot be empty.
+
+# 3.4.2 - 2025-02-27
+
+## Fixed
+
+1. Supports gracefully handling quotaLimited responses from the PostHog API for feature flags.
+
 # 3.4.1 - 2025-02-20
 
 ## Fixed

package/README.md

@@ -28,9 +28,9 @@ const posthog = new PostHog('my-api-key', {
 posthog.capture('my-event', { myProperty: 'foo' })
 
 // Identify a user (e.g. on login)
-posthog.identify('my-unique-user-id', { email: 'exampke@posthog.com', name: 'Jane Doe' })
+posthog.identify('my-unique-user-id', { email: 'example@posthog.com', name: 'Jane Doe' })
 // ...or with Set Once additional properties
-posthog.identify('my-unique-user-id', { $set: { email: 'exampke@posthog.com', name: 'Jane Doe' }, $set_once: { vip: true } })
+posthog.identify('my-unique-user-id', { $set: { email: 'example@posthog.com', name: 'Jane Doe' }, $set_once: { vip: true } })
 
 // Reset a user (e.g. on logout)
 posthog.reset()
@@ -72,4 +72,23 @@ posthog.onFeatureFlag('my-feature-flag', (value) => {
 // Opt users in or out, persisting across sessions (default is they are opted in)
 posthog.optOut() // Will stop tracking
 posthog.optIn() // Will start tracking
+
+## History API Navigation Tracking
+
+Single-page applications (SPAs) typically use the History API (`pushState`, `replaceState`) for navigation instead of full page loads. By default, PostHog only tracks the initial page load.
+
+To automatically track navigation events in SPAs, enable the `captureHistoryEvents` option:
+
+```ts
+const posthog = new PostHog('my-api-key', {
+  captureHistoryEvents: true
+})
 ```
+
+When enabled, PostHog will:
+- Track calls to `history.pushState()` and `history.replaceState()`
+- Track `popstate` events (browser back/forward navigation)
+- Send these as `$pageview` events with the current URL and pathname
+- Include the navigation type (`pushState`, `replaceState`, or `popstate`) as a property
+
+This ensures accurate page tracking in modern web applications without requiring manual pageview capture calls.