@highlight-run/rrweb 1.2.0 → 2.0.1

package/dist/plugins/types.d.ts

@@ -1,509 +0,0 @@
-import { serializedNodeWithId, idNodeMap, INode, MaskInputOptions, SlimDOMOptions, MaskInputFn, MaskTextFn } from './snapshot';
-import { PackFn, UnpackFn } from './packer/base';
-import { FontFaceDescriptors } from 'css-font-loading-module';
-import { IframeManager } from './record/iframe-manager';
-import { ShadowDomManager } from './record/shadow-dom-manager';
-import type { Replayer } from './replay';
-import { CanvasManager } from './record/observers/canvas/canvas-manager';
-export declare enum EventType {
-    DomContentLoaded = 0,
-    Load = 1,
-    FullSnapshot = 2,
-    IncrementalSnapshot = 3,
-    Meta = 4,
-    Custom = 5,
-    Plugin = 6
-}
-export declare type SessionInterval = {
-    startTime: number;
-    endTime: number;
-    duration: number;
-    active: boolean;
-};
-export declare type domContentLoadedEvent = {
-    type: EventType.DomContentLoaded;
-    data: {};
-};
-export declare type loadedEvent = {
-    type: EventType.Load;
-    data: {};
-};
-export declare type fullSnapshotEvent = {
-    type: EventType.FullSnapshot;
-    data: {
-        node: serializedNodeWithId;
-        initialOffset: {
-            top: number;
-            left: number;
-        };
-    };
-};
-export declare type incrementalSnapshotEvent = {
-    type: EventType.IncrementalSnapshot;
-    data: incrementalData;
-};
-export declare type metaEvent = {
-    type: EventType.Meta;
-    data: {
-        href: string;
-        width: number;
-        height: number;
-    };
-};
-export declare type customEvent<T = unknown> = {
-    type: EventType.Custom;
-    data: {
-        tag: string;
-        payload: T;
-    };
-};
-export declare type pluginEvent<T = unknown> = {
-    type: EventType.Plugin;
-    data: {
-        plugin: string;
-        payload: T;
-    };
-};
-export declare type styleSheetEvent = {};
-export declare enum IncrementalSource {
-    Mutation = 0,
-    MouseMove = 1,
-    MouseInteraction = 2,
-    Scroll = 3,
-    ViewportResize = 4,
-    Input = 5,
-    TouchMove = 6,
-    MediaInteraction = 7,
-    StyleSheetRule = 8,
-    CanvasMutation = 9,
-    Font = 10,
-    Log = 11,
-    Drag = 12,
-    StyleDeclaration = 13
-}
-export declare type mutationData = {
-    source: IncrementalSource.Mutation;
-} & mutationCallbackParam;
-export declare type mousemoveData = {
-    source: IncrementalSource.MouseMove | IncrementalSource.TouchMove | IncrementalSource.Drag;
-    positions: mousePosition[];
-};
-export declare type mouseInteractionData = {
-    source: IncrementalSource.MouseInteraction;
-} & mouseInteractionParam;
-export declare type scrollData = {
-    source: IncrementalSource.Scroll;
-} & scrollPosition;
-export declare type viewportResizeData = {
-    source: IncrementalSource.ViewportResize;
-} & viewportResizeDimension;
-export declare type inputData = {
-    source: IncrementalSource.Input;
-    id: number;
-} & inputValue;
-export declare type mediaInteractionData = {
-    source: IncrementalSource.MediaInteraction;
-} & mediaInteractionParam;
-export declare type styleSheetRuleData = {
-    source: IncrementalSource.StyleSheetRule;
-} & styleSheetRuleParam;
-export declare type styleDeclarationData = {
-    source: IncrementalSource.StyleDeclaration;
-} & styleDeclarationParam;
-export declare type canvasMutationData = {
-    source: IncrementalSource.CanvasMutation;
-} & canvasMutationParam;
-export declare type fontData = {
-    source: IncrementalSource.Font;
-} & fontParam;
-export declare type incrementalData = mutationData | mousemoveData | mouseInteractionData | scrollData | viewportResizeData | inputData | mediaInteractionData | styleSheetRuleData | canvasMutationData | fontData | styleDeclarationData;
-export declare type event = domContentLoadedEvent | loadedEvent | fullSnapshotEvent | incrementalSnapshotEvent | metaEvent | customEvent | pluginEvent;
-export declare type eventWithTime = event & {
-    timestamp: number;
-    delay?: number;
-};
-export declare type blockClass = string | RegExp;
-export declare type maskTextClass = string | RegExp;
-export declare type SamplingStrategy = Partial<{
-    mousemove: boolean | number;
-    mousemoveCallback: number;
-    mouseInteraction: boolean | Record<string, boolean | undefined>;
-    scroll: number;
-    media: number;
-    input: 'all' | 'last';
-}>;
-export declare type RecordPlugin<TOptions = unknown> = {
-    name: string;
-    observer?: (cb: Function, win: IWindow, options: TOptions) => listenerHandler;
-    eventProcessor?: <TExtend>(event: eventWithTime) => eventWithTime & TExtend;
-    options: TOptions;
-};
-export 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;
-    inlineStylesheet?: boolean;
-    hooks?: hooksParam;
-    packFn?: PackFn;
-    sampling?: SamplingStrategy;
-    recordCanvas?: boolean;
-    userTriggeredOnInput?: boolean;
-    collectFonts?: boolean;
-    plugins?: RecordPlugin[];
-    mousemoveWait?: number;
-    keepIframeSrcFn?: KeepIframeSrcFn;
-    enableStrictPrivacy?: boolean;
-};
-export declare type observerParam = {
-    mutationCb: mutationCallBack;
-    mousemoveCb: mousemoveCallBack;
-    mouseInteractionCb: mouseInteractionCallBack;
-    scrollCb: scrollCallback;
-    viewportResizeCb: viewportResizeCallback;
-    inputCb: inputCallback;
-    mediaInteractionCb: mediaInteractionCallback;
-    blockClass: blockClass;
-    blockSelector: string | null;
-    ignoreClass: string;
-    maskTextClass: maskTextClass;
-    maskTextSelector: string | null;
-    maskInputOptions: MaskInputOptions;
-    maskInputFn?: MaskInputFn;
-    maskTextFn?: MaskTextFn;
-    inlineStylesheet: boolean;
-    styleSheetRuleCb: styleSheetRuleCallback;
-    styleDeclarationCb: styleDeclarationCallback;
-    canvasMutationCb: canvasMutationCallback;
-    fontCb: fontCallback;
-    sampling: SamplingStrategy;
-    recordCanvas: boolean;
-    userTriggeredOnInput: boolean;
-    collectFonts: boolean;
-    slimDOMOptions: SlimDOMOptions;
-    doc: Document;
-    mirror: Mirror;
-    iframeManager: IframeManager;
-    shadowDomManager: ShadowDomManager;
-    canvasManager: CanvasManager;
-    plugins: Array<{
-        observer: Function;
-        callback: Function;
-        options: unknown;
-    }>;
-    enableStrictPrivacy: boolean;
-};
-export declare type hooksParam = {
-    mutation?: mutationCallBack;
-    mousemove?: mousemoveCallBack;
-    mouseInteraction?: mouseInteractionCallBack;
-    scroll?: scrollCallback;
-    viewportResize?: viewportResizeCallback;
-    input?: inputCallback;
-    mediaInteaction?: mediaInteractionCallback;
-    styleSheetRule?: styleSheetRuleCallback;
-    styleDeclaration?: styleDeclarationCallback;
-    canvasMutation?: canvasMutationCallback;
-    font?: fontCallback;
-};
-export declare type mutationRecord = {
-    type: string;
-    target: Node;
-    oldValue: string | null;
-    addedNodes: NodeList;
-    removedNodes: NodeList;
-    attributeName: string | null;
-};
-export declare type textCursor = {
-    node: Node;
-    value: string | null;
-};
-export declare type textMutation = {
-    id: number;
-    value: string | null;
-};
-export declare type styleAttributeValue = {
-    [key: string]: styleValueWithPriority | string | false;
-};
-export declare type styleValueWithPriority = [string, string];
-export declare type attributeCursor = {
-    node: Node;
-    attributes: {
-        [key: string]: string | styleAttributeValue | null;
-    };
-};
-export declare type attributeMutation = {
-    id: number;
-    attributes: {
-        [key: string]: string | styleAttributeValue | null;
-    };
-};
-export declare type removedNodeMutation = {
-    parentId: number;
-    id: number;
-    isShadow?: boolean;
-};
-export declare type addedNodeMutation = {
-    parentId: number;
-    previousId?: number | null;
-    nextId: number | null;
-    node: serializedNodeWithId;
-};
-export declare type mutationCallbackParam = {
-    texts: textMutation[];
-    attributes: attributeMutation[];
-    removes: removedNodeMutation[];
-    adds: addedNodeMutation[];
-    isAttachIframe?: true;
-};
-export declare type mutationCallBack = (m: mutationCallbackParam) => void;
-export declare type mousemoveCallBack = (p: mousePosition[], source: IncrementalSource.MouseMove | IncrementalSource.TouchMove | IncrementalSource.Drag) => void;
-export declare type mousePosition = {
-    x: number;
-    y: number;
-    id: number;
-    timeOffset: number;
-};
-export declare type mouseMovePos = {
-    x: number;
-    y: number;
-    id: number;
-    debugData: incrementalData;
-};
-export declare enum MouseInteractions {
-    MouseUp = 0,
-    MouseDown = 1,
-    Click = 2,
-    ContextMenu = 3,
-    DblClick = 4,
-    Focus = 5,
-    Blur = 6,
-    TouchStart = 7,
-    TouchMove_Departed = 8,
-    TouchEnd = 9,
-    TouchCancel = 10
-}
-export declare enum CanvasContext {
-    '2D' = 0,
-    WebGL = 1,
-    WebGL2 = 2
-}
-export declare type SerializedWebGlArg = {
-    rr_type: 'ArrayBuffer';
-    base64: string;
-} | {
-    rr_type: string;
-    src: string;
-} | {
-    rr_type: string;
-    args: Array<SerializedWebGlArg>;
-} | {
-    rr_type: string;
-    index: number;
-} | string | number | boolean | null | SerializedWebGlArg[];
-declare type mouseInteractionParam = {
-    type: MouseInteractions;
-    id: number;
-    x: number;
-    y: number;
-};
-export declare type mouseInteractionCallBack = (d: mouseInteractionParam) => void;
-export declare type scrollPosition = {
-    id: number;
-    x: number;
-    y: number;
-};
-export declare type scrollCallback = (p: scrollPosition) => void;
-export declare type styleSheetAddRule = {
-    rule: string;
-    index?: number | number[];
-};
-export declare type styleSheetDeleteRule = {
-    index: number | number[];
-};
-export declare type styleSheetRuleParam = {
-    id: number;
-    removes?: styleSheetDeleteRule[];
-    adds?: styleSheetAddRule[];
-};
-export declare type styleSheetRuleCallback = (s: styleSheetRuleParam) => void;
-export declare type styleDeclarationParam = {
-    id: number;
-    index: number[];
-    set?: {
-        property: string;
-        value: string | null;
-        priority: string | undefined;
-    };
-    remove?: {
-        property: string;
-    };
-};
-export declare type styleDeclarationCallback = (s: styleDeclarationParam) => void;
-export declare type canvasMutationCommand = {
-    property: string;
-    args: Array<unknown>;
-    setter?: true;
-};
-export declare type canvasMutationParam = {
-    id: number;
-    type: CanvasContext;
-    commands: canvasMutationCommand[];
-} | ({
-    id: number;
-    type: CanvasContext;
-} & canvasMutationCommand);
-export declare type canvasMutationWithType = {
-    type: CanvasContext;
-} & canvasMutationCommand;
-export declare type canvasMutationCallback = (p: canvasMutationParam) => void;
-export declare type canvasManagerMutationCallback = (target: HTMLCanvasElement, p: canvasMutationWithType) => void;
-export declare type fontParam = {
-    family: string;
-    fontSource: string;
-    buffer: boolean;
-    descriptors?: FontFaceDescriptors;
-};
-export declare type fontCallback = (p: fontParam) => void;
-export declare type viewportResizeDimension = {
-    width: number;
-    height: number;
-};
-export declare type viewportResizeCallback = (d: viewportResizeDimension) => void;
-export declare type inputValue = {
-    text: string;
-    isChecked: boolean;
-    userTriggered?: boolean;
-};
-export declare type inputCallback = (v: inputValue & {
-    id: number;
-}) => void;
-export declare const enum MediaInteractions {
-    Play = 0,
-    Pause = 1,
-    Seeked = 2,
-    VolumeChange = 3
-}
-export declare type mediaInteractionParam = {
-    type: MediaInteractions;
-    id: number;
-    currentTime?: number;
-    volume?: number;
-    muted?: boolean;
-};
-export declare type mediaInteractionCallback = (p: mediaInteractionParam) => void;
-export declare type DocumentDimension = {
-    x: number;
-    y: number;
-    relativeScale: number;
-    absoluteScale: number;
-};
-export declare type Mirror = {
-    map: idNodeMap;
-    getId: (n: INode) => number;
-    getNode: (id: number) => INode | null;
-    removeNodeFromMap: (n: INode) => void;
-    has: (id: number) => boolean;
-    reset: () => void;
-};
-export declare type throttleOptions = {
-    leading?: boolean;
-    trailing?: boolean;
-};
-export declare type listenerHandler = () => void;
-export declare type hookResetter = () => void;
-export declare type ReplayPlugin = {
-    handler: (event: eventWithTime, isSync: boolean, context: {
-        replayer: Replayer;
-    }) => void;
-};
-export declare type playerConfig = {
-    speed: number;
-    maxSpeed: number;
-    root: Element;
-    loadTimeout: number;
-    skipInactive: boolean;
-    showWarning: boolean;
-    showDebug: boolean;
-    blockClass: string;
-    liveMode: boolean;
-    insertStyleRules: string[];
-    triggerFocus: boolean;
-    UNSAFE_replayCanvas: boolean;
-    pauseAnimation?: boolean;
-    mouseTail: boolean | {
-        duration?: number;
-        lineCap?: string;
-        lineWidth?: number;
-        strokeStyle?: string;
-    };
-    unpackFn?: UnpackFn;
-    plugins?: ReplayPlugin[];
-    inactiveThreshold: number;
-    inactiveSkipTime: number;
-};
-export declare type playerMetaData = {
-    startTime: number;
-    endTime: number;
-    totalTime: number;
-};
-export declare type missingNode = {
-    node: Node;
-    mutation: addedNodeMutation;
-};
-export declare type missingNodeMap = {
-    [id: number]: missingNode;
-};
-export declare type actionWithDelay = {
-    doAction: () => void;
-    delay: number;
-};
-export declare type Handler = (event?: unknown) => void;
-export declare type Emitter = {
-    on(type: string, handler: Handler): void;
-    emit(type: string, event?: unknown): void;
-    off(type: string, handler: Handler): void;
-};
-export declare type Arguments<T> = T extends (...payload: infer U) => unknown ? U : unknown;
-export declare enum ReplayerEvents {
-    Start = "start",
-    Pause = "pause",
-    Resume = "resume",
-    Resize = "resize",
-    Finish = "finish",
-    FullsnapshotRebuilded = "fullsnapshot-rebuilded",
-    LoadStylesheetStart = "load-stylesheet-start",
-    LoadStylesheetEnd = "load-stylesheet-end",
-    SkipStart = "skip-start",
-    SkipEnd = "skip-end",
-    MouseInteraction = "mouse-interaction",
-    EventCast = "event-cast",
-    CustomEvent = "custom-event",
-    Flush = "flush",
-    StateChange = "state-change",
-    PlayBack = "play-back"
-}
-export declare type ElementState = {
-    scroll?: [number, number];
-};
-export declare type KeepIframeSrcFn = (src: string) => boolean;
-export interface HighlightConfiguration {
-    enableOnHoverClass?: boolean;
-}
-declare global {
-    interface Window {
-        HIG_CONFIGURATION: HighlightConfiguration;
-        FontFace: typeof FontFace;
-    }
-}
-export declare type IWindow = Window & typeof globalThis;
-export {};

package/dist/plugins/utils.d.ts

@@ -1,71 +0,0 @@
-import { Mirror, throttleOptions, listenerHandler, hookResetter, blockClass, addedNodeMutation, removedNodeMutation, textMutation, attributeMutation, mutationData, scrollData, inputData, DocumentDimension, IWindow } from './types';
-import { INode, serializedNodeWithId } from './snapshot';
-export declare function on(type: string, fn: EventListenerOrEventListenerObject, target?: Document | IWindow): listenerHandler;
-export declare function createMirror(): Mirror;
-export declare let _mirror: Mirror;
-export declare function throttle<T>(func: (arg: T) => void, wait: number, options?: throttleOptions): (arg: T) => void;
-export declare function hookSetter<T>(target: T, key: string | number | symbol, d: PropertyDescriptor, isRevoked?: boolean, win?: IWindow): hookResetter;
-export declare function patch(source: {
-    [key: string]: any;
-}, name: string, replacement: (...args: any[]) => any): () => void;
-export declare function getWindowHeight(): number;
-export declare function getWindowWidth(): number;
-export declare const isCanvasNode: (node: Node | null) => boolean;
-export declare function isBlocked(node: Node | null, blockClass: blockClass): boolean;
-export declare function isIgnored(n: Node | INode): boolean;
-export declare function isAncestorRemoved(target: INode, mirror: Mirror): boolean;
-export declare function isTouchEvent(event: MouseEvent | TouchEvent): event is TouchEvent;
-export declare function polyfill(win?: IWindow): void;
-export declare type TreeNode = {
-    id: number;
-    mutation: addedNodeMutation;
-    parent?: TreeNode;
-    children: Record<number, TreeNode>;
-    texts: textMutation[];
-    attributes: attributeMutation[];
-};
-export declare class TreeIndex {
-    tree: Record<number, TreeNode>;
-    private removeNodeMutations;
-    private textMutations;
-    private attributeMutations;
-    private indexes;
-    private removeIdSet;
-    private scrollMap;
-    private inputMap;
-    constructor();
-    add(mutation: addedNodeMutation): void;
-    remove(mutation: removedNodeMutation, mirror: Mirror): void;
-    text(mutation: textMutation): void;
-    attribute(mutation: attributeMutation): void;
-    scroll(d: scrollData): void;
-    input(d: inputData): void;
-    flush(): {
-        mutationData: mutationData;
-        scrollMap: TreeIndex['scrollMap'];
-        inputMap: TreeIndex['inputMap'];
-    };
-    private reset;
-    idRemoved(id: number): boolean;
-}
-declare type ResolveTree = {
-    value: addedNodeMutation;
-    children: ResolveTree[];
-    parent: ResolveTree | null;
-};
-export declare function queueToResolveTrees(queue: addedNodeMutation[]): ResolveTree[];
-export declare function iterateResolveTree(tree: ResolveTree, cb: (mutation: addedNodeMutation) => unknown): void;
-declare type HTMLIFrameINode = HTMLIFrameElement & {
-    __sn: serializedNodeWithId;
-};
-export declare type AppendedIframe = {
-    mutationInQueue: addedNodeMutation;
-    builtNode: HTMLIFrameINode;
-};
-export declare function isIframeINode(node: INode | ShadowRoot): node is HTMLIFrameINode;
-export declare function getBaseDimension(node: Node, rootIframe: Node): DocumentDimension;
-export declare function hasShadowRoot<T extends Node>(n: T): n is T & {
-    shadowRoot: ShadowRoot;
-};
-export declare function obfuscateText(text: string): string;
-export {};

package/dist/record/observer.d.ts

@@ -1,11 +0,0 @@
-import { MaskInputOptions, SlimDOMOptions, MaskInputFn, MaskTextFn } from '../snapshot';
-import { mutationCallBack, observerParam, listenerHandler, scrollCallback, blockClass, maskTextClass, hooksParam, SamplingStrategy, Mirror } from '../types';
-import MutationBuffer from './mutation';
-import { IframeManager } from './iframe-manager';
-import { ShadowDomManager } from './shadow-dom-manager';
-import { CanvasManager } from './observers/canvas/canvas-manager';
-export declare const mutationBuffers: MutationBuffer[];
-export declare function initMutationObserver(cb: mutationCallBack, doc: Document, blockClass: blockClass, blockSelector: string | null, maskTextClass: maskTextClass, maskTextSelector: string | null, inlineStylesheet: boolean, maskInputOptions: MaskInputOptions, maskTextFn: MaskTextFn | undefined, maskInputFn: MaskInputFn | undefined, recordCanvas: boolean, slimDOMOptions: SlimDOMOptions, mirror: Mirror, iframeManager: IframeManager, shadowDomManager: ShadowDomManager, canvasManager: CanvasManager, rootEl: Node, enableStrictPrivacy: boolean): MutationObserver;
-export declare function initScrollObserver(cb: scrollCallback, doc: Document, mirror: Mirror, blockClass: blockClass, sampling: SamplingStrategy): listenerHandler;
-export declare const INPUT_TAGS: string[];
-export declare function initObservers(o: observerParam, hooks?: hooksParam): listenerHandler;

package/dist/record/shadow-dom-manager.d.ts

@@ -1,34 +0,0 @@
-import { mutationCallBack, blockClass, maskTextClass, Mirror, scrollCallback, SamplingStrategy } from '../types';
-import { MaskInputOptions, SlimDOMOptions, MaskTextFn, MaskInputFn } from '../snapshot';
-import { IframeManager } from './iframe-manager';
-import { CanvasManager } from './observers/canvas/canvas-manager';
-declare type BypassOptions = {
-    blockClass: blockClass;
-    blockSelector: string | null;
-    maskTextClass: maskTextClass;
-    maskTextSelector: string | null;
-    inlineStylesheet: boolean;
-    maskInputOptions: MaskInputOptions;
-    maskTextFn: MaskTextFn | undefined;
-    maskInputFn: MaskInputFn | undefined;
-    recordCanvas: boolean;
-    sampling: SamplingStrategy;
-    slimDOMOptions: SlimDOMOptions;
-    iframeManager: IframeManager;
-    canvasManager: CanvasManager;
-    enableStrictPrivacy: boolean;
-};
-export declare class ShadowDomManager {
-    private mutationCb;
-    private scrollCb;
-    private bypassOptions;
-    private mirror;
-    constructor(options: {
-        mutationCb: mutationCallBack;
-        scrollCb: scrollCallback;
-        bypassOptions: BypassOptions;
-        mirror: Mirror;
-    });
-    addShadowRoot(shadowRoot: ShadowRoot, doc: Document): void;
-}
-export {};