posthog-js-lite 2.2.1 → 2.4.0

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

@@ -11,6 +11,9 @@ export declare abstract class PostHogCoreStateless {
     private requestTimeout;
     private captureMode;
     private removeDebugCallback?;
+    private debugMode;
+    private pendingPromises;
+    private disableGeoip;
     private _optoutOverride;
     protected _events: SimpleEventEmitter;
     protected _flushTimer?: any;
@@ -38,7 +41,7 @@ export declare abstract class PostHogCoreStateless {
     }, options?: PosthogCaptureOptions): this;
     protected aliasStateless(alias: string, distinctId: string, properties?: {
         [key: string]: any;
-    }): this;
+    }, options?: PosthogCaptureOptions): this;
     /***
      *** GROUPS
      ***/
@@ -47,12 +50,12 @@ export declare abstract class PostHogCoreStateless {
      *** FEATURE FLAGS
      ***/
     protected getDecide(distinctId: string, groups?: Record<string, string | number>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, extraPayload?: Record<string, any>): Promise<PostHogDecideResponse | undefined>;
-    protected getFeatureFlagStateless(key: string, distinctId: string, groups?: Record<string, string>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>): Promise<boolean | string | undefined>;
-    protected getFeatureFlagPayloadStateless(key: string, distinctId: string, groups?: Record<string, string>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>): Promise<JsonType | undefined>;
-    protected getFeatureFlagPayloadsStateless(distinctId: string, groups?: Record<string, string>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>): Promise<PostHogDecideResponse['featureFlagPayloads'] | undefined>;
+    protected getFeatureFlagStateless(key: string, distinctId: string, groups?: Record<string, string>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean): Promise<boolean | string | undefined>;
+    protected getFeatureFlagPayloadStateless(key: string, distinctId: string, groups?: Record<string, string>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean): Promise<JsonType | undefined>;
+    protected getFeatureFlagPayloadsStateless(distinctId: string, groups?: Record<string, string>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean): Promise<PostHogDecideResponse['featureFlagPayloads'] | undefined>;
     protected _parsePayload(response: any): any;
-    protected getFeatureFlagsStateless(distinctId: string, groups?: Record<string, string | number>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>): Promise<PostHogDecideResponse['featureFlags'] | undefined>;
-    protected getFeatureFlagsAndPayloadsStateless(distinctId: string, groups?: Record<string, string | number>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>): Promise<{
+    protected getFeatureFlagsStateless(distinctId: string, groups?: Record<string, string | number>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean): Promise<PostHogDecideResponse['featureFlags'] | undefined>;
+    protected getFeatureFlagsAndPayloadsStateless(distinctId: string, groups?: Record<string, string | number>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean): Promise<{
         flags: PostHogDecideResponse['featureFlags'] | undefined;
         payloads: PostHogDecideResponse['featureFlagPayloads'] | undefined;
     }>;

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

@@ -16,6 +16,7 @@ export declare type PosthogCoreOptions = {
     requestTimeout?: number;
     sessionExpirationTimeSeconds?: number;
     captureMode?: 'json' | 'form';
+    disableGeoip?: boolean;
 };
 export declare enum PostHogPersistedProperty {
     AnonymousId = "anonymous_id",
@@ -43,6 +44,7 @@ export declare type PostHogFetchOptions = {
 };
 export declare type PosthogCaptureOptions = {
     timestamp?: Date;
+    disableGeoip?: boolean;
 };
 export declare type PostHogFetchResponse = {
     status: number;

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

@@ -3,7 +3,7 @@ export declare function removeTrailingSlash(url: string): string;
 export interface RetriableOptions {
     retryCount?: number;
     retryDelay?: number;
-    retryCheck?: (err: any) => true;
+    retryCheck?: (err: any) => boolean;
 }
 export declare function retriable<T>(fn: () => Promise<T>, props?: RetriableOptions): Promise<T>;
 export declare function generateUUID(globalThis?: any): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "posthog-js-lite",
-  "version": "2.2.1",
+  "version": "2.4.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,
+      })
     })
   })
 })

package/tsconfig.json

@@ -1,6 +1,6 @@
 {
   "extends": "../tsconfig.json",
   "compilerOptions": {
-    "lib": ["DOM"]
+    "lib": ["DOM", "ES2015", "ES2022.Error"]
   }
 }