js.foresight 3.0.1 → 3.1.1

package/dist/types/types.d.ts

@@ -1,312 +0,0 @@
-export type Rect = {
-    top: number;
-    left: number;
-    right: number;
-    bottom: number;
-};
-/**
- * A callback function that is executed when a foresight interaction
- * (e.g., hover, trajectory hit) occurs on a registered element.
- */
-export type ForesightCallback = () => void;
-/**
- * Represents the HTML element that is being tracked by the ForesightManager.
- * This is typically a standard DOM `Element`.
- */
-export type ForesightElement = Element;
-/**
- * Represents a mouse position captured at a specific point in time.
- * Used for tracking mouse movement history.
- */
-export type MousePosition = {
-    /** The (x, y) coordinates of the mouse. */
-    point: Point;
-    /** The timestamp (e.g., from `performance.now()`) when this position was recorded. */
-    time: number;
-};
-export type Point = {
-    x: number;
-    y: number;
-};
-export type TrajectoryPositions = {
-    positions: MousePosition[];
-    currentPoint: Point;
-    predictedPoint: Point;
-};
-/**
- * Internal type representing the calculated boundaries of a foresight element,
- * including its original dimensions and the expanded hit area.
- */
-export type ElementBounds = {
-    /** The expanded rectangle, including hitSlop, used for interaction detection. */
-    expandedRect: Rect;
-    /** The original bounding rectangle of the element, as returned by `getBoundingClientRect()`. */
-    originalRect?: DOMRectReadOnly | undefined;
-    /** The hit slop values applied to this element. */
-    hitSlop: Exclude<HitSlop, number>;
-};
-/**
- * Represents trajectory hit related data for a foresight element.
- */
-export type TrajectoryHitData = {
-    /** True if the predicted mouse trajectory has intersected the element's expanded bounds. */
-    isTrajectoryHit: boolean;
-    /** The timestamp when the last trajectory hit occurred. */
-    trajectoryHitTime: number;
-    /** Timeout ID for expiring the trajectory hit state. */
-    trajectoryHitExpirationTimeoutId?: ReturnType<typeof setTimeout>;
-};
-export type ForesightRegisterResult = {
-    /** Whether the current device is a touch device. This is important as ForesightJS only works based on cursor movement. If the user is using a touch device you should handle prefetching differently  */
-    isTouchDevice: boolean;
-    /** Whether the user has connection limitations (slow network (2g) or data saver enabled) that should prevent prefetching */
-    isLimitedConnection: boolean;
-    /** Whether ForesightJS will actively track this element. False if touch device or limited connection, true otherwise */
-    isRegistered: boolean;
-    /** Function to unregister the element */
-    unregister: () => void;
-};
-/**
- * Represents the data associated with a registered foresight element.
- */
-export type ForesightElementData = Required<Pick<ForesightRegisterOptions, "callback" | "name">> & {
-    /** The boundary information for the element. */
-    elementBounds: ElementBounds;
-    /** True if the mouse cursor is currently hovering over the element's expanded bounds. */
-    isHovering: boolean;
-    /**
-     * Represents trajectory hit related data for a foresight element. Only used for the manager
-     */
-    trajectoryHitData: TrajectoryHitData;
-    /**
-     * Is the element intersecting with the viewport, usefull to track which element we should observe or not
-     */
-    isIntersectingWithViewport: boolean;
-    /**
-     * Amount of times this callback has been hit
-     */
-    callbackHits: CallbackHits;
-    /**
-     * The element you registered
-     */
-    element: ForesightElement;
-};
-export type MouseCallbackCounts = {
-    hover: number;
-    trajectory: number;
-};
-export type TabCallbackCounts = {
-    reverse: number;
-    forwards: number;
-};
-export type ScrollDirection = "down" | "up" | "left" | "right" | "none";
-export type ScrollCallbackCounts = Record<`${Exclude<ScrollDirection, "none">}`, number>;
-export type CallbackHits = {
-    total: number;
-    mouse: MouseCallbackCounts;
-    tab: TabCallbackCounts;
-    scroll: ScrollCallbackCounts;
-};
-export type HitType = {
-    kind: "mouse";
-    subType: keyof MouseCallbackCounts;
-} | {
-    kind: "tab";
-    subType: keyof TabCallbackCounts;
-} | {
-    kind: "scroll";
-    subType: keyof ScrollCallbackCounts;
-};
-/**
- * Snapshot of the current ForesightManager state
- */
-export type ForesightManagerData = {
-    registeredElements: ReadonlyMap<ForesightElement, ForesightElementData>;
-    globalSettings: Readonly<ForesightManagerSettings>;
-    globalCallbackHits: Readonly<CallbackHits>;
-};
-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;
-    /**
-     * A global callback that runs whenever a callback is fired for any
-     * registered element, just after the element's specific callback is fired.
-     *
-     * @param elementData - The ForesightTarget object for the element that triggered the event.
-     * @param managerData - Data about the ForesightManager
-     */
-    onAnyCallbackFired: (elementData: ForesightElementData, managerData: ForesightManagerData) => void;
-};
-/**
- * Configuration options for the ForesightManager
- * @link https://foresightjs.com/docs/getting_started/config#available-global-settings
- */
-export type ForesightManagerSettings = BaseForesightManagerSettings & {
-    defaultHitSlop: Exclude<HitSlop, number>;
-};
-/**
- * Update options for the ForesightManager
- * @link https://foresightjs.com/docs/getting_started/config#available-global-settings
- */
-export type UpdateForsightManagerSettings = BaseForesightManagerSettings & {
-    defaultHitSlop: HitSlop;
-};
-/**
- * Type used to register elements to the foresight manager
- */
-export type ForesightRegisterOptions = {
-    element: ForesightElement;
-    callback: ForesightCallback;
-    hitSlop?: HitSlop;
-    /**
-     * @deprecated will be removed in V4.0
-     */
-    unregisterOnCallback?: boolean;
-    name?: string;
-};
-/**
- * Usefull for if you want to create a custom button component in a modern framework (for example React).
- * And you want to have the ForesightRegisterOptions used in ForesightManager.instance.register({})
- * without the element as the element will be the ref of the component.
- *
- * @link https://foresightjs.com/docs/getting_started/typescript#foresightregisteroptionswithoutelement
- */
-export type ForesightRegisterOptionsWithoutElement = Omit<ForesightRegisterOptions, "element">;
-/**
- * Fully invisible "slop" around the element.
- * Basically increases the hover hitbox
- */
-export type HitSlop = Rect | number;
-/**
- * Get all keys in UpdateForsightManagerSettings that are numeric
- */
-export type NumericSettingKeys = {
-    [K in keyof UpdateForsightManagerSettings]: UpdateForsightManagerSettings[K] extends number ? K : never;
-}[keyof UpdateForsightManagerSettings];
-/**
- * Get all keys in UpdateForsightManagerSettings that are boolean
- */
-export type ManagerBooleanSettingKeys = {
-    [K in keyof UpdateForsightManagerSettings]: UpdateForsightManagerSettings[K] extends boolean ? K : never;
-}[keyof UpdateForsightManagerSettings];
-export interface ForesightEventMap {
-    elementRegistered: ElementRegisteredEvent;
-    elementUnregistered: ElementUnregisteredEvent;
-    elementDataUpdated: ElementDataUpdatedEvent;
-    callbackFired: CallbackFiredEvent;
-    mouseTrajectoryUpdate: MouseTrajectoryUpdateEvent;
-    scrollTrajectoryUpdate: ScrollTrajectoryUpdateEvent;
-    managerSettingsChanged: ManagerSettingsChangedEvent;
-}
-export type ForesightEventType = keyof ForesightEventMap;
-export interface ForesightEvent {
-    type: ForesightEventType;
-    timestamp: number;
-}
-export interface ElementRegisteredEvent extends ForesightEvent {
-    type: "elementRegistered";
-    elementData: ForesightElementData;
-}
-export interface ElementUnregisteredEvent extends ForesightEvent {
-    type: "elementUnregistered";
-    elementData: ForesightElementData;
-    unregisterReason: ElementUnregisteredReason;
-}
-/**
- * The reason an element was unregistered from ForesightManager's tracking.
- * - `callbackHit`: The element was automatically unregistered after its callback fired.
- * - `disconnected`: The element was automatically unregistered because it was removed from the DOM.
- * - `apiCall`: The developer manually called the `unregister()` function for the element.
- */
-export type ElementUnregisteredReason = "callbackHit" | "disconnected" | "apiCall";
-export interface ElementDataUpdatedEvent extends ForesightEvent {
-    type: "elementDataUpdated";
-    elementData: ForesightElementData;
-    updatedProp: "bounds" | "visibility";
-}
-export interface CallbackFiredEvent extends ForesightEvent {
-    type: "callbackFired";
-    elementData: ForesightElementData;
-    hitType: HitType;
-}
-export interface MouseTrajectoryUpdateEvent extends ForesightEvent {
-    type: "mouseTrajectoryUpdate";
-    trajectoryPositions: TrajectoryPositions;
-    predictionEnabled: boolean;
-}
-export interface ScrollTrajectoryUpdateEvent extends ForesightEvent {
-    type: "scrollTrajectoryUpdate";
-    currentPoint: Point;
-    predictedPoint: Point;
-}
-export interface ManagerSettingsChangedEvent extends ForesightEvent {
-    type: "managerSettingsChanged";
-    newSettings: ForesightManagerSettings;
-}
-export type ForesightEventData = ElementRegisteredEvent | ElementUnregisteredEvent | ElementDataUpdatedEvent | CallbackFiredEvent | MouseTrajectoryUpdateEvent | ScrollTrajectoryUpdateEvent | ManagerSettingsChangedEvent;
-export type ForesightEventListener = (event: ForesightEventData) => void;
-export {};
-//# sourceMappingURL=types.d.ts.map

package/dist/types/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,IAAI,GAAG;IACjB,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAA;AAE1C;;;GAGG;AACH,MAAM,MAAM,gBAAgB,GAAG,OAAO,CAAA;AAEtC;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,2CAA2C;IAC3C,KAAK,EAAE,KAAK,CAAA;IACZ,sFAAsF;IACtF,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAED,MAAM,MAAM,KAAK,GAAG;IAClB,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;CACV,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,SAAS,EAAE,aAAa,EAAE,CAAA;IAC1B,YAAY,EAAE,KAAK,CAAA;IACnB,cAAc,EAAE,KAAK,CAAA;CACtB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,iFAAiF;IACjF,YAAY,EAAE,IAAI,CAAA;IAClB,gGAAgG;IAChG,YAAY,CAAC,EAAE,eAAe,GAAG,SAAS,CAAA;IAC1C,mDAAmD;IACnD,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;CAClC,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B,4FAA4F;IAC5F,eAAe,EAAE,OAAO,CAAA;IACxB,2DAA2D;IAC3D,iBAAiB,EAAE,MAAM,CAAA;IACzB,wDAAwD;IACxD,gCAAgC,CAAC,EAAE,UAAU,CAAC,OAAO,UAAU,CAAC,CAAA;CACjE,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IACpC,yMAAyM;IACzM,aAAa,EAAE,OAAO,CAAA;IACtB,4HAA4H;IAC5H,mBAAmB,EAAE,OAAO,CAAA;IAC5B,wHAAwH;IACxH,YAAY,EAAE,OAAO,CAAA;IACrB,yCAAyC;IACzC,UAAU,EAAE,MAAM,IAAI,CAAA;CACvB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,QAAQ,CAAC,IAAI,CAAC,wBAAwB,EAAE,UAAU,GAAG,MAAM,CAAC,CAAC,GAAG;IACjG,gDAAgD;IAChD,aAAa,EAAE,aAAa,CAAA;IAC5B,yFAAyF;IACzF,UAAU,EAAE,OAAO,CAAA;IACnB;;OAEG;IACH,iBAAiB,EAAE,iBAAiB,CAAA;IACpC;;OAEG;IACH,0BAA0B,EAAE,OAAO,CAAA;IACnC;;OAEG;IACH,YAAY,EAAE,YAAY,CAAA;IAC1B;;OAEG;IACH,OAAO,EAAE,gBAAgB,CAAA;CAC1B,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAChC,KAAK,EAAE,MAAM,CAAA;IACb,UAAU,EAAE,MAAM,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,IAAI,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,CAAA;AACvE,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,GAAG,OAAO,CAAC,eAAe,EAAE,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;AAExF,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,mBAAmB,CAAA;IAC1B,GAAG,EAAE,iBAAiB,CAAA;IACtB,MAAM,EAAE,oBAAoB,CAAA;CAC7B,CAAA;AAED,MAAM,MAAM,OAAO,GACf;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,MAAM,mBAAmB,CAAA;CAAE,GACrD;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,OAAO,EAAE,MAAM,iBAAiB,CAAA;CAAE,GACjD;IAAE,IAAI,EAAE,QAAQ,CAAC;IAAC,OAAO,EAAE,MAAM,oBAAoB,CAAA;CAAE,CAAA;AAE3D;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,kBAAkB,EAAE,WAAW,CAAC,gBAAgB,EAAE,oBAAoB,CAAC,CAAA;IACvE,cAAc,EAAE,QAAQ,CAAC,wBAAwB,CAAC,CAAA;IAClD,kBAAkB,EAAE,QAAQ,CAAC,YAAY,CAAC,CAAA;CAC3C,CAAA;AAED,KAAK,4BAA4B,GAAG;IAClC;;;;;;;;;;OAUG;IACH,mBAAmB,EAAE,MAAM,CAAA;IAE3B;;;;;OAKG;IACH,KAAK,EAAE,OAAO,CAAA;IAEd;;;;;;;;OAQG;IACH,wBAAwB,EAAE,MAAM,CAAA;IAEhC;;;;;OAKG;IACH,qBAAqB,EAAE,OAAO,CAAA;IAE9B;;;;;OAKG;IACH,mBAAmB,EAAE,OAAO,CAAA;IAE5B;;;;;;;OAOG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;;;OAIG;IACH,sBAAsB,EAAE,OAAO,CAAA;IAE/B;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;;;;;OAMG;IACH,kBAAkB,EAAE,CAAC,WAAW,EAAE,oBAAoB,EAAE,WAAW,EAAE,oBAAoB,KAAK,IAAI,CAAA;CACnG,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,4BAA4B,GAAG;IACpE,cAAc,EAAE,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;CACzC,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,6BAA6B,GAAG,4BAA4B,GAAG;IACzE,cAAc,EAAE,OAAO,CAAA;CACxB,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,OAAO,EAAE,gBAAgB,CAAA;IACzB,QAAQ,EAAE,iBAAiB,CAAA;IAC3B,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED;;;;;;GAMG;AACH,MAAM,MAAM,sCAAsC,GAAG,IAAI,CAAC,wBAAwB,EAAE,SAAS,CAAC,CAAA;AAE9F;;;GAGG;AACH,MAAM,MAAM,OAAO,GAAG,IAAI,GAAG,MAAM,CAAA;AAEnC;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;KAC9B,CAAC,IAAI,MAAM,6BAA6B,GAAG,6BAA6B,CAAC,CAAC,CAAC,SAAS,MAAM,GACvF,CAAC,GACD,KAAK;CACV,CAAC,MAAM,6BAA6B,CAAC,CAAA;AAEtC;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;KACrC,CAAC,IAAI,MAAM,6BAA6B,GAAG,6BAA6B,CAAC,CAAC,CAAC,SAAS,OAAO,GACxF,CAAC,GACD,KAAK;CACV,CAAC,MAAM,6BAA6B,CAAC,CAAA;AAGtC,MAAM,WAAW,iBAAiB;IAChC,iBAAiB,EAAE,sBAAsB,CAAA;IACzC,mBAAmB,EAAE,wBAAwB,CAAA;IAC7C,kBAAkB,EAAE,uBAAuB,CAAA;IAC3C,aAAa,EAAE,kBAAkB,CAAA;IACjC,qBAAqB,EAAE,0BAA0B,CAAA;IACjD,sBAAsB,EAAE,2BAA2B,CAAA;IACnD,sBAAsB,EAAE,2BAA2B,CAAA;CACpD;AAGD,MAAM,MAAM,kBAAkB,GAAG,MAAM,iBAAiB,CAAA;AAGxD,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,kBAAkB,CAAA;IACxB,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,sBAAuB,SAAQ,cAAc;IAC5D,IAAI,EAAE,mBAAmB,CAAA;IACzB,WAAW,EAAE,oBAAoB,CAAA;CAClC;AAED,MAAM,WAAW,wBAAyB,SAAQ,cAAc;IAC9D,IAAI,EAAE,qBAAqB,CAAA;IAC3B,WAAW,EAAE,oBAAoB,CAAA;IACjC,gBAAgB,EAAE,yBAAyB,CAAA;CAC5C;AAED;;;;;GAKG;AACH,MAAM,MAAM,yBAAyB,GAAG,aAAa,GAAG,cAAc,GAAG,SAAS,CAAA;AAElF,MAAM,WAAW,uBAAwB,SAAQ,cAAc;IAC7D,IAAI,EAAE,oBAAoB,CAAA;IAC1B,WAAW,EAAE,oBAAoB,CAAA;IACjC,WAAW,EAAE,QAAQ,GAAG,YAAY,CAAA;CACrC;AAED,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACxD,IAAI,EAAE,eAAe,CAAA;IACrB,WAAW,EAAE,oBAAoB,CAAA;IACjC,OAAO,EAAE,OAAO,CAAA;CACjB;AAED,MAAM,WAAW,0BAA2B,SAAQ,cAAc;IAChE,IAAI,EAAE,uBAAuB,CAAA;IAC7B,mBAAmB,EAAE,mBAAmB,CAAA;IACxC,iBAAiB,EAAE,OAAO,CAAA;CAC3B;AAED,MAAM,WAAW,2BAA4B,SAAQ,cAAc;IACjE,IAAI,EAAE,wBAAwB,CAAA;IAC9B,YAAY,EAAE,KAAK,CAAA;IACnB,cAAc,EAAE,KAAK,CAAA;CACtB;AAED,MAAM,WAAW,2BAA4B,SAAQ,cAAc;IACjE,IAAI,EAAE,wBAAwB,CAAA;IAC9B,WAAW,EAAE,wBAAwB,CAAA;CACtC;AAED,MAAM,MAAM,kBAAkB,GAC1B,sBAAsB,GACtB,wBAAwB,GACxB,uBAAuB,GACvB,kBAAkB,GAClB,0BAA0B,GAC1B,2BAA2B,GAC3B,2BAA2B,CAAA;AAG/B,MAAM,MAAM,sBAAsB,GAAG,CAAC,KAAK,EAAE,kBAAkB,KAAK,IAAI,CAAA"}

package/dist/types/types.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=types.js.map

package/dist/types/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types/types.ts"],"names":[],"mappings":""}