posthog-js 1.84.2 → 1.84.4

package/dist/module.d.ts

@@ -49,18 +49,6 @@ type serializedNode = (documentNode | documentTypeNode | elementNode | textNode
 type serializedNodeWithId = serializedNode & {
     id: number;
 };
-interface IMirror<TNode> {
-    getId(n: TNode | undefined | null): number;
-    getNode(id: number): TNode | null;
-    getIds(): number[];
-    getMeta(n: TNode): serializedNodeWithId | null;
-    removeNodeFromMap(n: TNode): void;
-    has(id: number): boolean;
-    hasNode(node: TNode): boolean;
-    add(n: TNode, meta: serializedNodeWithId): void;
-    replace(id: number, n: TNode): void;
-    reset(): void;
-}
 type MaskInputOptions = Partial<{
     color: boolean;
     date: boolean;
@@ -91,27 +79,6 @@ type SlimDOMOptions = Partial<{
     headMetaAuthorship: boolean;
     headMetaVerification: boolean;
 }>;
-type DataURLOptions = Partial<{
-    type: string;
-    quality: number;
-}>;
-type MaskTextFn = (text: string) => string;
-type MaskInputFn = (text: string, element: HTMLElement) => string;
-
-declare class Mirror implements IMirror<Node> {
-    private idNodeMap;
-    private nodeMetaMap;
-    getId(n: Node | undefined | null): number;
-    getNode(id: number): Node | null;
-    getIds(): number[];
-    getMeta(n: Node): serializedNodeWithId | null;
-    removeNodeFromMap(n: Node): void;
-    has(id: number): boolean;
-    hasNode(node: Node): boolean;
-    add(n: Node, meta: serializedNodeWithId): void;
-    replace(id: number, n: Node): void;
-    reset(): void;
-}
 
 declare class RequestQueueScaffold {
     isPolling: boolean;
@@ -355,6 +322,9 @@ interface DecideResponse {
         endpoint?: string;
         consoleLogRecordingEnabled?: boolean;
         recorderVersion?: 'v1' | 'v2';
+        sampleRate?: string | null;
+        minimumDurationMilliseconds?: number;
+        linkedFlag?: string | null;
     };
     surveys?: boolean;
     toolbarParams: ToolbarParams;
@@ -686,49 +656,6 @@ type eventWithTime = event & {
     timestamp: number;
     delay?: number;
 };
-type blockClass = string | RegExp;
-type maskTextClass = string | RegExp;
-type SamplingStrategy = Partial<{
-    mousemove: boolean | number;
-    mousemoveCallback: number;
-    mouseInteraction: boolean | Record<string, boolean | undefined>;
-    scroll: number;
-    media: number;
-    input: 'all' | 'last';
-    canvas: 'all' | number;
-}>;
-interface ICrossOriginIframeMirror {
-    getId(iframe: HTMLIFrameElement, remoteId: number, parentToRemoteMap?: Map<number, number>, remoteToParentMap?: Map<number, number>): number;
-    getIds(iframe: HTMLIFrameElement, remoteId: number[]): number[];
-    getRemoteId(iframe: HTMLIFrameElement, parentId: number, map?: Map<number, number>): number;
-    getRemoteIds(iframe: HTMLIFrameElement, parentId: number[]): number[];
-    reset(iframe?: HTMLIFrameElement): void;
-}
-type RecordPlugin<TOptions = unknown> = {
-    name: string;
-    observer?: (cb: (...args: Array<unknown>) => void, win: IWindow, options: TOptions) => listenerHandler;
-    eventProcessor?: <TExtend>(event: eventWithTime) => eventWithTime & TExtend;
-    getMirror?: (mirrors: {
-        nodeMirror: Mirror;
-        crossOriginIframeMirror: ICrossOriginIframeMirror;
-        crossOriginIframeStyleMirror: ICrossOriginIframeMirror;
-    }) => void;
-    options: TOptions;
-};
-type hooksParam = {
-    mutation?: mutationCallBack;
-    mousemove?: mousemoveCallBack;
-    mouseInteraction?: mouseInteractionCallBack;
-    scroll?: scrollCallback;
-    viewportResize?: viewportResizeCallback;
-    input?: inputCallback;
-    mediaInteaction?: mediaInteractionCallback;
-    styleSheetRule?: styleSheetRuleCallback;
-    styleDeclaration?: styleDeclarationCallback;
-    canvasMutation?: canvasMutationCallback;
-    font?: fontCallback;
-    selection?: selectionCallback;
-};
 type textMutation = {
     id: number;
     value: string | null;
@@ -761,8 +688,6 @@ type mutationCallbackParam = {
     adds: addedNodeMutation[];
     isAttachIframe?: true;
 };
-type mutationCallBack = (m: mutationCallbackParam) => void;
-type mousemoveCallBack = (p: mousePosition[], source: IncrementalSource.MouseMove | IncrementalSource.TouchMove | IncrementalSource.Drag) => void;
 type mousePosition = {
     x: number;
     y: number;
@@ -799,13 +724,11 @@ type mouseInteractionParam = {
     y: number;
     pointerType?: PointerTypes;
 };
-type mouseInteractionCallBack = (d: mouseInteractionParam) => void;
 type scrollPosition = {
     id: number;
     x: number;
     y: number;
 };
-type scrollCallback = (p: scrollPosition) => void;
 type styleSheetAddRule = {
     rule: string;
     index?: number | number[];
@@ -821,7 +744,6 @@ type styleSheetRuleParam = {
     replace?: string;
     replaceSync?: string;
 };
-type styleSheetRuleCallback = (s: styleSheetRuleParam) => void;
 type adoptedStyleSheetParam = {
     id: number;
     styles?: {
@@ -843,7 +765,6 @@ type styleDeclarationParam = {
         property: string;
     };
 };
-type styleDeclarationCallback = (s: styleDeclarationParam) => void;
 type canvasMutationCommand = {
     property: string;
     args: Array<unknown>;
@@ -857,27 +778,21 @@ type canvasMutationParam = {
     id: number;
     type: CanvasContext;
 } & canvasMutationCommand);
-type canvasMutationCallback = (p: canvasMutationParam) => void;
 type fontParam = {
     family: string;
     fontSource: string;
     buffer: boolean;
     descriptors?: FontFaceDescriptors;
 };
-type fontCallback = (p: fontParam) => void;
 type viewportResizeDimension = {
     width: number;
     height: number;
 };
-type viewportResizeCallback = (d: viewportResizeDimension) => void;
 type inputValue = {
     text: string;
     isChecked: boolean;
     userTriggered?: boolean;
 };
-type inputCallback = (v: inputValue & {
-    id: number;
-}) => void;
 declare const enum MediaInteractions {
     Play = 0,
     Pause = 1,
@@ -893,7 +808,6 @@ type mediaInteractionParam = {
     muted?: boolean;
     playbackRate?: number;
 };
-type mediaInteractionCallback = (p: mediaInteractionParam) => void;
 type SelectionRange = {
     start: number;
     startOffset: number;
@@ -903,57 +817,15 @@ type SelectionRange = {
 type selectionParam = {
     ranges: Array<SelectionRange>;
 };
-type selectionCallback = (p: selectionParam) => void;
-type listenerHandler = () => void;
-type KeepIframeSrcFn = (src: string) => boolean;
 declare global {
     interface Window {
         FontFace: typeof FontFace;
     }
 }
-type IWindow = Window & typeof globalThis;
-
-declare type rrwebRecord = {
-    (options: recordOptions<eventWithTime>): listenerHandler;
-    addCustomEvent: (tag: string, payload: any) => void;
-    takeFullSnapshot: () => void;
-    mirror: Mirror;
-};
-declare type recordOptions<T> = {
-    emit?: (e: T, isCheckout?: boolean) => void;
-    checkoutEveryNth?: number;
-    checkoutEveryNms?: number;
-    blockClass?: blockClass;
-    blockSelector?: string;
-    ignoreClass?: string;
-    maskTextClass?: maskTextClass;
-    maskTextSelector?: string;
-    maskAllInputs?: boolean;
-    maskInputOptions?: MaskInputOptions;
-    maskInputFn?: MaskInputFn;
-    maskTextFn?: MaskTextFn;
-    slimDOMOptions?: SlimDOMOptions | 'all' | true;
-    ignoreCSSAttributes?: Set<string>;
-    inlineStylesheet?: boolean;
-    hooks?: hooksParam;
-    sampling?: SamplingStrategy;
-    dataURLOptions?: DataURLOptions;
-    recordCanvas?: boolean;
-    recordCrossOriginIframes?: boolean;
-    recordAfter?: 'DOMContentLoaded' | 'load';
-    userTriggeredOnInput?: boolean;
-    collectFonts?: boolean;
-    inlineImages?: boolean;
-    plugins?: RecordPlugin[];
-    mousemoveWait?: number;
-    keepIframeSrcFn?: KeepIframeSrcFn;
-};
 
 declare class SessionRecording {
-    get lastActivityTimestamp(): number;
-    get endpoint(): string;
+    private _linkedFlagSeen;
     private instance;
-    private emit;
     private _endpoint;
     private windowId;
     private sessionId;
@@ -961,21 +833,30 @@ declare class SessionRecording {
     private flushBufferTimer?;
     private buffer?;
     private mutationRateLimiter?;
-    captureStarted: boolean;
-    snapshots: any[];
-    stopRrweb: listenerHandler | undefined;
-    receivedDecide: boolean;
-    rrwebRecord: rrwebRecord | undefined;
-    recorderVersion?: string;
-    isIdle: boolean;
+    private _captureStarted;
+    private stopRrweb;
+    private receivedDecide;
+    private rrwebRecord;
+    private isIdle;
+    private _linkedFlag;
+    private _sampleRate;
+    private _minimumDuration;
+    get started(): boolean;
+    private get sessionManager();
+    private get isSampled();
+    private get sessionDuration();
+    private get isRecordingEnabled();
+    private get isConsoleLogCaptureEnabled();
+    private get recordingVersion();
+    /**
+     * defaults to buffering mode until a decide response is received
+     * once a decide response is received status can be disabled, active or sampled
+     */
+    private get status();
     constructor(instance: PostHog);
-    private getSessionManager;
     startRecordingIfEnabled(): void;
-    started(): boolean;
     stopRecording(): void;
-    isRecordingEnabled(): boolean;
-    isConsoleLogCaptureEnabled(): boolean;
-    getRecordingVersion(): any;
+    private makeSamplingDecision;
     afterDecideResponse(response: DecideResponse): void;
     log(message: string, level?: 'log' | 'warn' | 'error'): void;
     private startCaptureAndTrySendingQueuedSnapshots;
@@ -986,6 +867,7 @@ declare class SessionRecording {
     private _onScriptLoaded;
     onRRwebEmit(rawEvent: eventWithTime): void;
     private _maskUrl;
+    private clearBuffer;
     private _flushBuffer;
     private _captureSnapshotBuffered;
     private _captureSnapshot;
@@ -1037,17 +919,19 @@ declare class RequestQueue extends RequestQueueScaffold {
 }
 
 declare class SessionIdManager {
+    private readonly _sessionIdGenerator;
+    private readonly _windowIdGenerator;
     private config;
     private persistence;
     private _windowId;
     private _sessionId;
-    private _window_id_storage_key;
-    private _primary_window_exists_storage_key;
+    private readonly _window_id_storage_key;
+    private readonly _primary_window_exists_storage_key;
     private _sessionStartTimestamp;
     private _sessionActivityTimestamp;
-    private _sessionTimeoutMs;
+    private readonly _sessionTimeoutMs;
     private _sessionIdChangedHandlers;
-    constructor(config: Partial<PostHogConfig>, persistence: PostHogPersistence);
+    constructor(config: Partial<PostHogConfig>, persistence: PostHogPersistence, sessionIdGenerator?: () => string, windowIdGenerator?: () => string);
     onSessionId(callback: SessionIdChangedCallback): () => void;
     private _canUseSessionStorage;
     private _setWindowId;