posthog-js-lite 3.0.2 → 3.1.0

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

@@ -4,9 +4,9 @@ export * as utils from './utils';
 import { LZString } from './lz-string';
 import { SimpleEventEmitter } from './eventemitter';
 export declare abstract class PostHogCoreStateless {
-    private apiKey;
-    host: string;
-    private flushAt;
+    readonly apiKey: string;
+    readonly host: string;
+    readonly flushAt: number;
     private maxBatchSize;
     private maxQueueSize;
     private flushInterval;
@@ -16,7 +16,8 @@ export declare abstract class PostHogCoreStateless {
     private captureMode;
     private removeDebugCallback?;
     private disableGeoip;
-    disabled: boolean;
+    private historicalMigration;
+    protected disabled: boolean;
     private defaultOptIn;
     private pendingPromises;
     protected _events: SimpleEventEmitter;
@@ -31,6 +32,7 @@ export declare abstract class PostHogCoreStateless {
     abstract getPersistedProperty<T>(key: PostHogPersistedProperty): T | undefined;
     abstract setPersistedProperty<T>(key: PostHogPersistedProperty, value: T | null): void;
     constructor(apiKey: string, options?: PostHogCoreOptions);
+    protected logMsgIfDebug(fn: () => void): void;
     protected wrap(fn: () => void): void;
     protected getCommonEventProperties(): any;
     get optedOut(): boolean;
@@ -39,6 +41,7 @@ export declare abstract class PostHogCoreStateless {
     on(event: string, cb: (...args: any[]) => void): () => void;
     debug(enabled?: boolean): void;
     get isDebug(): boolean;
+    get isDisabled(): boolean;
     private buildPayload;
     protected addPendingPromise<T>(promise: Promise<T>): Promise<T>;
     /***

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

@@ -1,4 +1,4 @@
-export declare type PostHogCoreOptions = {
+export type PostHogCoreOptions = {
     /** PostHog API host, usually 'https://us.i.posthog.com' or 'https://eu.i.posthog.com' */
     host?: string;
     /** The number of events to queue before sending to PostHog (flushing) */
@@ -36,9 +36,11 @@ export declare type PostHogCoreOptions = {
     featureFlagsRequestTimeoutMs?: number;
     /** For Session Analysis how long before we expire a session (defaults to 30 mins) */
     sessionExpirationTimeSeconds?: number;
-    /** Whether to post events to PostHog in JSON or compressed format. Defaults to 'form' */
+    /** Whether to post events to PostHog in JSON or compressed format. Defaults to 'json' */
     captureMode?: 'json' | 'form';
     disableGeoip?: boolean;
+    /** Special flag to indicate ingested data is for a historical migration. */
+    historicalMigration?: boolean;
 };
 export declare enum PostHogPersistedProperty {
     AnonymousId = "anonymous_id",
@@ -54,9 +56,10 @@ export declare enum PostHogPersistedProperty {
     PersonProperties = "person_properties",
     GroupProperties = "group_properties",
     InstalledAppBuild = "installed_app_build",
-    InstalledAppVersion = "installed_app_version"
+    InstalledAppVersion = "installed_app_version",
+    SessionReplay = "session_replay"
 }
-export declare type PostHogFetchOptions = {
+export type PostHogFetchOptions = {
     method: 'GET' | 'POST' | 'PUT' | 'PATCH';
     mode?: 'no-cors';
     credentials?: 'omit';
@@ -66,26 +69,26 @@ export declare type PostHogFetchOptions = {
     body?: string;
     signal?: AbortSignal;
 };
-export declare type PostHogCaptureOptions = {
+export type PostHogCaptureOptions = {
     /** If provided overrides the auto-generated event ID */
     uuid?: string;
     /** If provided overrides the auto-generated timestamp */
     timestamp?: Date;
     disableGeoip?: boolean;
 };
-export declare type PostHogFetchResponse = {
+export type PostHogFetchResponse = {
     status: number;
     text: () => Promise<string>;
     json: () => Promise<any>;
 };
-export declare type PostHogQueueItem = {
+export type PostHogQueueItem = {
     message: any;
     callback?: (err: any) => void;
 };
-export declare type PostHogEventProperties = {
+export type PostHogEventProperties = {
     [key: string]: any;
 };
-export declare type PostHogAutocaptureElement = {
+export type PostHogAutocaptureElement = {
     $el_text?: string;
     tag_name: string;
     href?: string;
@@ -95,7 +98,7 @@ export declare type PostHogAutocaptureElement = {
 } & {
     [key: string]: any;
 };
-export declare type PostHogDecideResponse = {
+export type PostHogDecideResponse = {
     config: {
         enable_collect_everything: boolean;
     };
@@ -112,12 +115,14 @@ export declare type PostHogDecideResponse = {
         [key: string]: JsonType;
     };
     errorsWhileComputingFlags: boolean;
-    sessionRecording: boolean;
+    sessionRecording?: boolean | {
+        [key: string]: JsonType;
+    };
 };
-export declare type PostHogFlagsAndPayloadsResponse = {
+export type PostHogFlagsAndPayloadsResponse = {
     featureFlags: PostHogDecideResponse['featureFlags'];
     featureFlagPayloads: PostHogDecideResponse['featureFlagPayloads'];
 };
-export declare type JsonType = string | number | boolean | null | {
+export type JsonType = string | number | boolean | null | {
     [key: string]: JsonType;
 } | Array<JsonType>;

package/lib/posthog-web/src/storage.d.ts

@@ -1,5 +1,5 @@
 import { PostHogOptions } from './types';
-export declare type PostHogStorage = {
+export type PostHogStorage = {
     getItem: (key: string) => string | null | undefined;
     setItem: (key: string, value: string) => void;
     removeItem: (key: string) => void;

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

@@ -1,5 +1,5 @@
 import { PostHogCoreOptions } from '../../posthog-core/src';
-export declare type PostHogOptions = {
+export type PostHogOptions = {
     autocapture?: boolean;
     persistence?: 'localStorage' | 'sessionStorage' | 'cookie' | 'memory';
     persistence_name?: string;

package/package.json

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