js.foresight-devtools 1.0.4 → 1.0.6

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import * as lit from 'lit';
 import { LitElement, TemplateResult, PropertyValues } from 'lit';
-import { ForesightEvent, ForesightElementData, ForesightManagerSettings as ForesightManagerSettings$2 } from 'js.foresight';
-import { ForesightEvent as ForesightEvent$1, HitSlop as HitSlop$1, UpdatedDataPropertyNames, CallbackHitType, Point, ScrollDirection, ForesightManagerSettings as ForesightManagerSettings$1 } from 'js.foresight/types/types';
+import { ForesightEvent, ForesightElementData, ForesightManagerSettings as ForesightManagerSettings$1 } from 'js.foresight';
+import { ForesightEvent as ForesightEvent$1, HitSlop, UpdatedDataPropertyNames, CallbackHitType, Point, ScrollDirection, ForesightManagerSettings, UpdatedManagerSetting, CallbackHits, ForesightElementData as ForesightElementData$1 } from 'js.foresight/types/types';
 
 type DeepPartial<T> = T extends object ? {
     [P in keyof T]?: DeepPartial<T[P]>;
@@ -236,100 +236,7 @@ declare global {
     }
 }
 
-type Rect = {
-    top: number;
-    left: number;
-    right: number;
-    bottom: number;
-};
-type BaseForesightManagerSettings = {
-    /**
-     * Number of mouse positions to keep in history for trajectory calculation.
-     * A higher number might lead to smoother but slightly delayed predictions.
-     *
-     *
-     * @link https://foresightjs.com/docs/getting_started/config#available-global-settings
-     *
-     *
-     * **This value is clamped between 2 and 30.**
-     * @default 8
-     */
-    positionHistorySize: number;
-    /**
-     *
-     * @deprecated will be removed from v4.0
-     * ForesightJS now have its stand-alone devtools library with the debugger built-in
-     * @link https://github.com/spaansba/ForesightJS-DevTools
-     */
-    debug: boolean;
-    /**
-     * How far ahead (in milliseconds) to predict the mouse trajectory.
-     * A larger value means the prediction extends further into the future. (meaning it will trigger callbacks sooner)
-     *
-     * @link https://foresightjs.com/docs/getting_started/config#available-global-settings
-     *
-     * **This value is clamped between 10 and 200.**
-     * @default 120
-     */
-    trajectoryPredictionTime: number;
-    /**
-     * Whether to enable mouse trajectory prediction.
-     * If false, only direct hover/interaction is considered.
-     * @link https://foresightjs.com/docs/getting_started/config#available-global-settings
-     * @default true
-     */
-    enableMousePrediction: boolean;
-    /**
-     * Toggles whether keyboard prediction is on
-     *
-     * @link https://foresightjs.com/docs/getting_started/config#available-global-settings
-     * @default true
-     */
-    enableTabPrediction: boolean;
-    /**
-     * Sets the pixel distance to check from the mouse position in the scroll direction.
-     *
-     * @link https://foresightjs.com/docs/getting_started/config#available-global-settings
-     *
-     * **This value is clamped between 30 and 300.**
-     * @default 150
-     */
-    scrollMargin: number;
-    /**
-     * Toggles whether scroll prediction is on
-     * @link https://foresightjs.com/docs/getting_started/config#available-global-settings
-     * @default true
-     */
-    enableScrollPrediction: boolean;
-    /**
-     * Tab stops away from an element to trigger callback. Only works when @argument enableTabPrediction is true
-     *
-     * **This value is clamped between 0 and 20.**
-     * @default 2
-     */
-    tabOffset: number;
-};
-/**
- * Configuration options for the ForesightManager
- * @link https://foresightjs.com/docs/getting_started/config#available-global-settings
- */
-type ForesightManagerSettings = BaseForesightManagerSettings & {
-    defaultHitSlop: Exclude<HitSlop, number>;
-};
-/**
- * Fully invisible "slop" around the element.
- * Basically increases the hover hitbox
- */
-type HitSlop = Rect | number;
-type UpdatedManagerSetting = {
-    [K in keyof ForesightManagerSettings]: {
-        setting: K;
-        newValue: ForesightManagerSettings[K];
-        oldValue: ForesightManagerSettings[K];
-    };
-}[keyof ForesightManagerSettings];
-
-type SerializedEventType = ForesightEvent$1 | "serializationError";
+type SerializedEventType = ForesightEvent$1 | "serializationError" | "managerDataPayload";
 interface PayloadBase {
     type: SerializedEventType;
     localizedTimestamp: string;
@@ -341,7 +248,8 @@ interface ElementRegisteredPayload extends PayloadBase {
     name: string;
     id: string;
     registerCount: number;
-    hitslop: HitSlop$1;
+    hitslop: HitSlop;
+    meta: Record<string, unknown>;
 }
 interface ElementUnregisteredPayload extends PayloadBase {
     type: "elementUnregistered";
@@ -350,17 +258,20 @@ interface ElementUnregisteredPayload extends PayloadBase {
     registerCount: number;
     unregisterReason: string;
     wasLastElement: boolean;
+    meta: Record<string, unknown>;
 }
 interface ElementDataUpdatedPayload extends PayloadBase {
     type: "elementDataUpdated";
     name: string;
     updatedProps: UpdatedDataPropertyNames[];
     isIntersecting: boolean;
+    meta: Record<string, unknown>;
 }
 interface CallbackInvokedPayload extends PayloadBase {
     type: "callbackInvoked";
     name: string;
     hitType: CallbackHitType;
+    meta: Record<string, unknown>;
 }
 interface CallbackCompletedBasePayload extends PayloadBase {
     type: "callbackCompleted";
@@ -369,6 +280,7 @@ interface CallbackCompletedBasePayload extends PayloadBase {
     callbackRunTimeRaw: number;
     hitType: CallbackHitType;
     status: "success" | "error";
+    meta: Record<string, unknown>;
 }
 type CallbackCompletedPayload = CallbackCompletedBasePayload & ({
     status: "success";
@@ -391,7 +303,7 @@ interface ScrollTrajectoryUpdatePayload extends PayloadBase {
 }
 interface ManagerSettingsChangedPayload extends PayloadBase {
     type: "managerSettingsChanged";
-    globalSettings: ForesightManagerSettings$1;
+    globalSettings: ForesightManagerSettings;
     settingsChanged: UpdatedManagerSetting[];
 }
 interface SerializationErrorPayload extends PayloadBase {
@@ -399,7 +311,17 @@ interface SerializationErrorPayload extends PayloadBase {
     error: "Failed to serialize event data";
     errorMessage: string;
 }
-type SerializedEventData = ElementRegisteredPayload | ElementUnregisteredPayload | ElementDataUpdatedPayload | CallbackInvokedPayload | CallbackCompletedPayload | MouseTrajectoryUpdatePayload | ScrollTrajectoryUpdatePayload | ManagerSettingsChangedPayload | SerializationErrorPayload;
+interface ManagerDataPayload extends PayloadBase {
+    type: "managerDataPayload";
+    warning: string;
+    globalCallbackHits: CallbackHits;
+    eventListenerCount: Record<string, number>;
+    managerSettings: ForesightManagerSettings;
+    registeredElements: Array<Omit<ForesightElementData$1, "element"> & {
+        elementInfo: string;
+    }>;
+}
+type SerializedEventData = ElementRegisteredPayload | ElementUnregisteredPayload | ElementDataUpdatedPayload | CallbackInvokedPayload | CallbackCompletedPayload | MouseTrajectoryUpdatePayload | ScrollTrajectoryUpdatePayload | ManagerSettingsChangedPayload | ManagerDataPayload | SerializationErrorPayload;
 
 declare class SingleLog extends LitElement {
     static styles: lit.CSSResult[];
@@ -449,6 +371,9 @@ declare class LogTab extends LitElement {
     private removeAllEventListeners;
     private getEventColor;
     private handleEvent;
+    private addLog;
+    private logManagerData;
+    private addManagerLog;
     private addEventLog;
     render(): lit.TemplateResult<1>;
 }
@@ -475,7 +400,7 @@ declare class SettingItemCheckbox extends LitElement {
     isChecked: boolean;
     header: string;
     description: string;
-    setting: keyof ForesightManagerSettings$2 | keyof DevtoolsSettings;
+    setting: keyof ForesightManagerSettings$1 | keyof DevtoolsSettings;
     private handleCheckboxChange;
     render(): lit.TemplateResult<1>;
 }
@@ -493,7 +418,7 @@ declare class SettingItemRange extends LitElement {
     unit: string;
     header: string;
     description: string;
-    setting: keyof ForesightManagerSettings$2;
+    setting: keyof ForesightManagerSettings$1;
     private displayValue;
     private handleRangeInput;
     private handleRangeChange;
@@ -575,6 +500,7 @@ declare class ForesightDevtools extends LitElement {
     static get instance(): ForesightDevtools;
     disconnectedCallback(): void;
     private shouldUpdateSetting;
+    private updateLoggingSetting;
     alterDevtoolsSettings(props?: DeepPartial<DevtoolsSettings>): void;
     private cleanup;
     render(): lit.TemplateResult<1>;