posthog-js-lite 2.3.0 → 2.5.0

package/lib/posthog-core/src/index.d.ts

@@ -74,6 +74,7 @@ export declare abstract class PostHogCore extends PostHogCoreStateless {
     private flagCallReported;
     protected _decideResponsePromise?: Promise<PostHogDecideResponse | undefined>;
     protected _sessionExpirationTimeSeconds: number;
+    protected sessionProps: PostHogEventProperties;
     constructor(apiKey: string, options?: PosthogCoreOptions);
     protected setupBootstrap(options?: Partial<PosthogCoreOptions>): void;
     private get props();
@@ -83,15 +84,19 @@ export declare abstract class PostHogCore extends PostHogCoreStateless {
     on(event: string, cb: (...args: any[]) => void): () => void;
     reset(propertiesToKeep?: PostHogPersistedProperty[]): void;
     protected getCommonEventProperties(): any;
-    private enrichProperties;
+    enrichProperties(properties?: PostHogEventProperties): any;
     getSessionId(): string | undefined;
     resetSessionId(): void;
     getAnonymousId(): string;
     getDistinctId(): string;
+    unregister(property: string): void;
     register(properties: {
         [key: string]: any;
     }): void;
-    unregister(property: string): void;
+    registerForSession(properties: {
+        [key: string]: any;
+    }): void;
+    unregisterForSession(property: string): void;
     /***
      *** TRACKING
      ***/
@@ -112,9 +117,19 @@ export declare abstract class PostHogCore extends PostHogCoreStateless {
     /***
      * PROPERTIES
      ***/
+    setPersonPropertiesForFlags(properties: {
+        [type: string]: string;
+    }): this;
+    resetPersonPropertiesForFlags(): void;
+    /** @deprecated - Renamed to setPersonPropertiesForFlags */
     personProperties(properties: {
         [type: string]: string;
     }): this;
+    setGroupPropertiesForFlags(properties: {
+        [type: string]: Record<string, string>;
+    }): this;
+    resetGroupPropertiesForFlags(): void;
+    /** @deprecated - Renamed to setGroupPropertiesForFlags */
     groupProperties(properties: {
         [type: string]: Record<string, string>;
     }): this;

package/lib/posthog-core/src/types.d.ts

@@ -30,7 +30,9 @@ export declare enum PostHogPersistedProperty {
     SessionId = "session_id",
     SessionLastTimestamp = "session_timestamp",
     PersonProperties = "person_properties",
-    GroupProperties = "group_properties"
+    GroupProperties = "group_properties",
+    InstalledAppBuild = "installed_app_build",
+    InstalledAppVersion = "installed_app_version"
 }
 export declare type PostHogFetchOptions = {
     method: 'GET' | 'POST' | 'PUT' | 'PATCH';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "posthog-js-lite",
-  "version": "2.3.0",
+  "version": "2.5.0",
   "main": "lib/index.cjs.js",
   "module": "lib/index.esm.js",
   "types": "lib/index.d.ts",

package/src/posthog-web.ts

@@ -21,6 +21,10 @@ export class PostHog extends PostHogCore {
     this._storageKey = options?.persistence_name ? `ph_${options.persistence_name}` : `ph_${apiKey}_posthog`
     this._storage = getStorage(options?.persistence || 'localStorage', window)
     this.setupBootstrap(options)
+
+    if (options?.preloadFeatureFlags !== false) {
+      this.reloadFeatureFlags()
+    }
   }
 
   getPersistedProperty<T>(key: PostHogPersistedProperty): T | undefined {

package/test/posthog-web.spec.ts

@@ -6,27 +6,89 @@ import { PostHog } from '..'
 
 describe('PosthogWeb', () => {
   let fetch: jest.Mock
-  jest.useFakeTimers()
+  jest.useRealTimers()
 
   beforeEach(() => {
-    ;(global as any).window.fetch = fetch = jest.fn(() =>
-      Promise.resolve({
+    ;(global as any).window.fetch = fetch = jest.fn(async (url) => {
+      let res: any = { status: 'ok' }
+      if (url.includes('decide')) {
+        res = {
+          featureFlags: {
+            'feature-1': true,
+            'feature-2': true,
+            'json-payload': true,
+            'feature-variant': 'variant',
+          },
+          // NOTE: Aren't these supposed to be strings?
+
+          featureFlagPayloads: {
+            'feature-1': {
+              color: 'blue',
+            },
+            'json-payload': {
+              a: 'payload',
+            },
+            'feature-variant': 5,
+          },
+        }
+      }
+
+      return {
         status: 200,
-        json: () => Promise.resolve({ status: 'ok' }),
-      })
-    ) as any
+        json: () => Promise.resolve(res),
+      }
+    })
   })
 
   describe('init', () => {
     it('should initialise', () => {
-      const postHog = new PostHog('TEST_API_KEY', {
+      const posthog = new PostHog('TEST_API_KEY', {
+        flushAt: 1,
+      })
+      expect(posthog.optedOut).toEqual(false)
+
+      posthog.capture('test')
+
+      expect(fetch).toHaveBeenCalledTimes(2)
+    })
+
+    it('should load feature flags on init', async () => {
+      const posthog = new PostHog('TEST_API_KEY', {
         flushAt: 1,
       })
-      expect(postHog.optedOut).toEqual(false)
 
-      postHog.capture('test')
+      expect(fetch).toHaveBeenCalledWith('https://app.posthog.com/decide/?v=3', {
+        body: JSON.stringify({
+          token: 'TEST_API_KEY',
+          distinct_id: posthog.getDistinctId(),
+          groups: {},
+          person_properties: {},
+          group_properties: {},
+          $anon_distinct_id: posthog.getAnonymousId(),
+        }),
+        method: 'POST',
+        headers: {
+          'Content-Type': 'application/json',
+        },
+        signal: expect.anything(),
+      })
 
-      expect(fetch).toHaveBeenCalledTimes(1)
+      expect(posthog.getFeatureFlags()).toEqual({
+        'feature-1': true,
+        'feature-2': true,
+        'json-payload': true,
+        'feature-variant': 'variant',
+      })
+
+      expect(posthog.getFeatureFlagPayloads()).toEqual({
+        'feature-1': {
+          color: 'blue',
+        },
+        'json-payload': {
+          a: 'payload',
+        },
+        'feature-variant': 5,
+      })
     })
   })
 })