posthog-js-lite 3.0.1 → 3.1.0

package/CHANGELOG.md

@@ -1,3 +1,23 @@
+# Next
+
+# 3.1.0 - 2024-11-21
+
+## Changed
+
+1. chore: default `captureMode` changed to `json`.
+    1. To keep using the `form` mode, just set the `captureMode` option to `form` when initializing the PostHog client.
+2. fix: identify method allows passing a $set_once object
+
+# 3.0.2 - 2024-06-15
+
+## Fixed
+
+1. Fixed and error that prevented localstorage from ever being used and instead falling back to sessionstorage for persistence
+
+## Changed
+
+1. chore: change host to new address.
+
 # 3.0.1 - 2024-04-25
 
 1. Prevent double JSON parsing of feature flag payloads, which would convert the payload [1] into 1.
@@ -56,8 +76,8 @@
 
 # 2.5.0 - 2023-12-04
 
-1.  Renamed `personProperties` to `setPersonPropertiesForFlags` to match `posthog-js` and more clearly indicated what it does
-2.  Renamed `groupProperties` to `setGroupPropertiesForFlags` to match `posthog-js` and more clearly indicated what it does
+1. Renamed `personProperties` to `setPersonPropertiesForFlags` to match `posthog-js` and more clearly indicated what it does
+2. Renamed `groupProperties` to `setGroupPropertiesForFlags` to match `posthog-js` and more clearly indicated what it does
 
 # 2.4.0 - 2023-04-20
 
@@ -88,4 +108,4 @@
 
 # 2.0.1 - 2023-01-25
 
-- Ensures the distinctId used in `.groupIdentify` is the same as the currently identified user
+1. Ensures the distinctId used in `.groupIdentify` is the same as the currently identified user

package/README.md

@@ -1,9 +1,11 @@
 # PostHog Web
 
-> 🚧 This is a WIP. Currently the only officially supported way of using PostHog on the web is [posthog-js](https://github.com/PostHog/posthog-js)
+> 🚧 This is a reduced feature set package. Currently the only officially supported feature complete way of using PostHog on the web is [posthog-js](https://github.com/PostHog/posthog-js)
 
 This package is currently published to npm as [posthog-js-lite](https://www.npmjs.com/package/posthog-js-lite) and is a simplified version of the recommended and offically supported `posthog-js`.
 
+You'd want to use this only if you're very conscious about package sizes, and this reduced feature set (only analytics and feature flags) works for your use case. The most common use case is in chrome extensions.
+
 ## Installation
 
 ```bash
@@ -27,6 +29,8 @@ 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' })
+// ...or with Set Once additional properties
+posthog.identify('my-unique-user-id', { $set: { email: 'exampke@posthog.com', name: 'Jane Doe' }, $set_once: { vip: true } })
 
 // Reset a user (e.g. on logout)
 posthog.reset()