@shopgate/engage 7.32.0-beta.2 → 7.32.0-beta.20

package/core/hooks/events/index.d.ts

@@ -1,5 +1,5 @@
-export * from "./appEvents";
-export { default as usePressHandler } from "./usePressHandler";
-export { default as useLongPress } from "./useLongPress";
-export { default as useScrollDirectionChange } from "./useScrollDirectionChange";
+export * from './appEvents';
+export { default as usePressHandler } from './usePressHandler';
+export { default as useLongPress } from './useLongPress';
+export { default as useScrollDirectionChange } from './useScrollDirectionChange';
 //# sourceMappingURL=index.d.ts.map

package/core/hooks/events/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../core/hooks/events/index.js"],"names":[],"mappings":""}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../core/hooks/events/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,OAAO,EAAE,OAAO,IAAI,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC/D,OAAO,EAAE,OAAO,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAAE,OAAO,IAAI,wBAAwB,EAAE,MAAM,4BAA4B,CAAC"}

package/core/hooks/events/useLongPress.d.ts

@@ -1,68 +1,65 @@
-import { MouseEvent as ReactMouseEvent, TouchEvent as ReactTouchEvent } from 'react';
-
+import type { MouseEvent as ReactMouseEvent, TouchEvent as ReactTouchEvent } from 'react';
+/**
+ * The events a long press interaction can originate from. The handlers below are spread onto an
+ * element, so these are React's synthetic events rather than the DOM ones.
+ */
+export type LongPressEvent = ReactMouseEvent | ReactTouchEvent;
+/**
+ * Event handlers to spread onto the element that should react to a long press.
+ */
 export interface LongPressHandlers {
-  /**
-   * Attach to `onMouseDown` event.
-   */
-  onMouseDown: (e: ReactMouseEvent | TouchEvent) => void;
-
-  /**
-   * Attach to `onTouchStart` event.
-   */
-  onTouchStart: (e: ReactTouchEvent | TouchEvent) => void;
-
-  /**
-   * Attach to `onMouseUp` event.
-   */
-  onMouseUp: (e: ReactMouseEvent | TouchEvent) => void;
-
-  /**
-   * Attach to `onMouseLeave` event.
-   */
-  onMouseLeave: (e: ReactMouseEvent | TouchEvent) => void;
-
-  /**
-   * Attach to `onTouchEnd` event.
-   */
-  onTouchEnd: (e: ReactTouchEvent | TouchEvent) => void;
-
-  /**
-   * Attach to `onContextMenu` event to prevent the native context menu.
-   */
-  onContextMenu: (e: MouseEvent) => void;
+    /**
+     * Attach to `onMouseDown` event.
+     */
+    onMouseDown: (e: LongPressEvent) => void;
+    /**
+     * Attach to `onTouchStart` event.
+     */
+    onTouchStart: (e: LongPressEvent) => void;
+    /**
+     * Attach to `onMouseUp` event.
+     */
+    onMouseUp: (e: LongPressEvent) => void;
+    /**
+     * Attach to `onMouseLeave` event.
+     */
+    onMouseLeave: (e: LongPressEvent) => void;
+    /**
+     * Attach to `onTouchEnd` event.
+     */
+    onTouchEnd: (e: LongPressEvent) => void;
+    /**
+     * Attach to `onContextMenu` event to prevent the native context menu.
+     */
+    onContextMenu: (e: ReactMouseEvent) => void;
 }
-
+/**
+ * Configuration and lifecycle callbacks for a long press interaction.
+ */
 export interface UseLongPressOptions {
-  /**
-   * Duration in milliseconds to trigger long press.
-   * @default 1000
-   */
-  threshold?: number;
-
-  /**
-   * Called when the press starts.
-   */
-  onStart?: (e: ReactMouseEvent | ReactTouchEvent) => void;
-
-  /**
-   * Called when the long press completes.
-   */
-  onFinish?: (e: ReactMouseEvent | ReactTouchEvent) => void;
-
-  /**
-   * Called when the press is cancelled before the threshold.
-   */
-  onCancel?: (e: ReactMouseEvent | ReactTouchEvent) => void;
+    /**
+     * Duration in milliseconds to trigger long press.
+     * @default 1000
+     */
+    threshold?: number;
+    /**
+     * Called when the press starts.
+     */
+    onStart?: (e: LongPressEvent) => void;
+    /**
+     * Called when the long press completes.
+     */
+    onFinish?: (e: LongPressEvent) => void;
+    /**
+     * Called when the press is cancelled before the threshold.
+     */
+    onCancel?: (e: LongPressEvent) => void;
 }
-
 /**
  * Custom hook to handle long press interactions.
- *
  * @param callback Function to call on long press.
  * @param options Configuration and lifecycle callbacks.
  * @returns An object containing event handlers for mouse and touch events.
  */
-export default function useLongPress(
-  callback: (e: ReactMouseEvent | ReactTouchEvent) => void,
-  options?: UseLongPressOptions
-): LongPressHandlers;
+export default function useLongPress(callback: (e: LongPressEvent) => void, options?: UseLongPressOptions): LongPressHandlers;
+//# sourceMappingURL=useLongPress.d.ts.map

package/core/hooks/events/useLongPress.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLongPress.d.ts","sourceRoot":"","sources":["../../../../core/hooks/events/useLongPress.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,IAAI,eAAe,EAAE,UAAU,IAAI,eAAe,EAAE,MAAM,OAAO,CAAC;AAE1F;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,eAAe,GAAG,eAAe,CAAC;AAE/D;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,WAAW,EAAE,CAAC,CAAC,EAAE,cAAc,KAAK,IAAI,CAAC;IAEzC;;OAEG;IACH,YAAY,EAAE,CAAC,CAAC,EAAE,cAAc,KAAK,IAAI,CAAC;IAE1C;;OAEG;IACH,SAAS,EAAE,CAAC,CAAC,EAAE,cAAc,KAAK,IAAI,CAAC;IAEvC;;OAEG;IACH,YAAY,EAAE,CAAC,CAAC,EAAE,cAAc,KAAK,IAAI,CAAC;IAE1C;;OAEG;IACH,UAAU,EAAE,CAAC,CAAC,EAAE,cAAc,KAAK,IAAI,CAAC;IAExC;;OAEG;IACH,aAAa,EAAE,CAAC,CAAC,EAAE,eAAe,KAAK,IAAI,CAAC;CAC7C;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,CAAC,EAAE,cAAc,KAAK,IAAI,CAAC;IAEtC;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,cAAc,KAAK,IAAI,CAAC;IAEvC;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,CAAC,EAAE,cAAc,KAAK,IAAI,CAAC;CACxC;AAUD;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,YAAY,CAClC,QAAQ,EAAE,CAAC,CAAC,EAAE,cAAc,KAAK,IAAI,EACrC,OAAO,GAAE,mBAAwB,GAChC,iBAAiB,CA4CnB"}

package/core/hooks/events/useLongPress.js

@@ -1,32 +1,39 @@
-// @ts-check
 import { useRef, useCallback } from 'react';
 
-/** @typedef {import('./useLongPress').LongPressHandlers} LongPressHandlers */
-/** @typedef {import('./useLongPress').UseLongPressOptions} UseLongPressOptions */
+/**
+ * The events a long press interaction can originate from. The handlers below are spread onto an
+ * element, so these are React's synthetic events rather than the DOM ones.
+ */
+
+/**
+ * Event handlers to spread onto the element that should react to a long press.
+ */
+
+/**
+ * Configuration and lifecycle callbacks for a long press interaction.
+ */
 
 /**
  * Prevents the default context menu from appearing on long press.
- * @param {MouseEvent} e The event object.
+ * @param e The event object.
  */
 const preventContextMenu = e => {
   e.preventDefault();
 };
 
-// eslint-disable-next-line valid-jsdoc
 /**
  * Custom hook to handle long press interactions.
- *
- * @param {(e: Event) => void} callback - Function to call on long press.
- * @param {UseLongPressOptions} [options={}] - Configuration and lifecycle callbacks.
- * @returns {LongPressHandlers} An object containing event handlers for mouse and touch events.
+ * @param callback Function to call on long press.
+ * @param options Configuration and lifecycle callbacks.
+ * @returns An object containing event handlers for mouse and touch events.
  */
-export default function useLongPress(callback, {
-  threshold = 1000,
-  onStart,
-  onFinish,
-  onCancel
-} = {}) {
-  /** @type {import('react').MutableRefObject<number | undefined>} */
+export default function useLongPress(callback, options = {}) {
+  const {
+    threshold = 1000,
+    onStart,
+    onFinish,
+    onCancel
+  } = options;
   const timerRef = useRef(undefined);
   const triggeredRef = useRef(false);
   const start = useCallback(e => {

package/core/hooks/events/usePressHandler.d.ts

@@ -1,30 +1,43 @@
-export default usePressHandler;
-export type PressHandlers = {
+import type { KeyboardEvent as ReactKeyboardEvent, MouseEvent as ReactMouseEvent } from 'react';
+/**
+ * The events that can activate a pressable element.
+ */
+export type PressEvent = ReactMouseEvent | ReactKeyboardEvent;
+/**
+ * Event handlers to spread onto the element that should react to a press.
+ */
+export interface PressHandlers {
     /**
-     * - Click event handler.
+     * Click event handler.
      */
-    onClick: Function;
+    onClick: (e: ReactMouseEvent) => void;
     /**
-     * - Keydown handler for Enter/Space.
+     * Keydown handler for Enter/Space.
      */
-    onKeyDown: Function;
-};
+    onKeyDown: (e: ReactKeyboardEvent) => void;
+}
 /**
- * @typedef {Object} PressHandlers
- * @property {Function} onClick - Click event handler.
- * @property {Function} onKeyDown - Keydown handler for Enter/Space.
+ * Optional configuration for the press handlers.
  */
+export interface UsePressHandlerOptions {
+    /**
+     * Whether Space triggers the callback.
+     * @default true
+     */
+    triggerOnSpace?: boolean;
+    /**
+     * Whether Enter triggers the callback.
+     * @default false
+     */
+    triggerOnEnter?: boolean;
+}
 /**
  * Improves development for accessibility by simplifying registration of multiple
  * listeners (click, Enter, Space) to invoke the a callback when an element is
  * interacted with.
- *
- * @param {Function} onPress Callback to run when the element is interacted with
- * @param {Object} [options] Optional configuration
- * @param {boolean} [options.triggerOnSpace=true] Whether Space triggers onActivate
- * @param {boolean} [options.triggerOnEnter=false] Whether Enter triggers onActivate
- * @returns {PressHandlers} handlers - Event handlers to spread onto an element
- *
+ * @param onPress Callback to run when the element is interacted with.
+ * @param options Optional configuration.
+ * @returns Event handlers to spread onto an element.
  * @example
  * ```js
  * function MyPressableButton({ onActivate }) {
@@ -46,8 +59,6 @@ export type PressHandlers = {
  * }
  * ```
  */
-declare function usePressHandler(onPress: Function, options?: {
-    triggerOnSpace?: boolean | undefined;
-    triggerOnEnter?: boolean | undefined;
-}): PressHandlers;
+declare function usePressHandler(onPress: (e: PressEvent) => void, options?: UsePressHandlerOptions): PressHandlers;
+export default usePressHandler;
 //# sourceMappingURL=usePressHandler.d.ts.map

package/core/hooks/events/usePressHandler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"usePressHandler.d.ts","sourceRoot":"","sources":["../../../../core/hooks/events/usePressHandler.js"],"names":[],"mappings":";;;;;;;;;;;AAEA;;;;GAIG;AAEH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AACH,8DAzBG;IAA0B,cAAc;IACd,cAAc;CACxC,GAAU,aAAa,CA2DzB"}
+{"version":3,"file":"usePressHandler.d.ts","sourceRoot":"","sources":["../../../../core/hooks/events/usePressHandler.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,aAAa,IAAI,kBAAkB,EAAE,UAAU,IAAI,eAAe,EAAE,MAAM,OAAO,CAAC;AAEhG;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,eAAe,GAAG,kBAAkB,CAAC;AAE9D;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,OAAO,EAAE,CAAC,CAAC,EAAE,eAAe,KAAK,IAAI,CAAC;IACtC;;OAEG;IACH,SAAS,EAAE,CAAC,CAAC,EAAE,kBAAkB,KAAK,IAAI,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;;OAGG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,iBAAS,eAAe,CACtB,OAAO,EAAE,CAAC,CAAC,EAAE,UAAU,KAAK,IAAI,EAChC,OAAO,GAAE,sBAA2B,GACnC,aAAa,CAoCf;AAED,eAAe,eAAe,CAAC"}

package/core/hooks/events/usePressHandler.js

@@ -1,22 +1,24 @@
 import { useCallback } from 'react';
 
 /**
- * @typedef {Object} PressHandlers
- * @property {Function} onClick - Click event handler.
- * @property {Function} onKeyDown - Keydown handler for Enter/Space.
+ * The events that can activate a pressable element.
+ */
+
+/**
+ * Event handlers to spread onto the element that should react to a press.
+ */
+
+/**
+ * Optional configuration for the press handlers.
  */
 
 /**
  * Improves development for accessibility by simplifying registration of multiple
  * listeners (click, Enter, Space) to invoke the a callback when an element is
  * interacted with.
- *
- * @param {Function} onPress Callback to run when the element is interacted with
- * @param {Object} [options] Optional configuration
- * @param {boolean} [options.triggerOnSpace=true] Whether Space triggers onActivate
- * @param {boolean} [options.triggerOnEnter=false] Whether Enter triggers onActivate
- * @returns {PressHandlers} handlers - Event handlers to spread onto an element
- *
+ * @param onPress Callback to run when the element is interacted with.
+ * @param options Optional configuration.
+ * @returns Event handlers to spread onto an element.
  * @example
  * ```js
  * function MyPressableButton({ onActivate }) {

package/core/hooks/events/useScrollDirectionChange.d.ts

@@ -1,74 +1,85 @@
+/**
+ * A scroll event as the view scroll stream emits it.
+ */
 export interface ViewScrollEvent {
-  /** The original scroll event object */
-  event: UIEvent;
-
-  /** Current vertical scroll position */
-  scrollTop: number;
-
-  /** Previous scrollTop value */
-  previousScrollTop: number;
-
-  /** True if scrolling down */
-  scrollDown: boolean;
-
-  /** True if scrolling up */
-  scrollUp: boolean;
-
-  /** Scroll direction: 'up', 'down', or null */
-  direction: 'up' | 'down' | null;
-
-  /** Optional internal/legacy props (not passed to callbacks) */
-  [key: string]: unknown;
+    /**
+     * The original scroll event object.
+     */
+    event: UIEvent;
+    /**
+     * Current vertical scroll position.
+     */
+    scrollTop: number;
+    /**
+     * Previous scrollTop value.
+     */
+    previousScrollTop: number;
+    /**
+     * True if scrolling down.
+     */
+    scrollDown: boolean;
+    /**
+     * True if scrolling up.
+     */
+    scrollUp: boolean;
+    /**
+     * Scroll direction: 'up', 'down', or null.
+     */
+    direction: 'up' | 'down' | null;
+    /**
+     * Optional internal/legacy props (not passed to callbacks).
+     */
+    [key: string]: unknown;
 }
-
 /**
- * @param event Scroll event
+ * A callback that receives a scroll event.
  */
 export type ScrollCallback = (event: ViewScrollEvent) => void;
-
+/**
+ * Parameters for the scroll direction change hook.
+ */
 export interface UseScrollDirectionChangeParams {
-  /** Whether the hook is active */
-  enabled: boolean;
-
-  /**
-   * ScrollTop threshold for down scroll triggers. When set,
-   * `onScrollDown` fires only when the scroll position is greater than this.
-   * @default 100
-   */
-  offset?: number;
-
-  /**
-   * If true, callbacks fire only once per direction change
-   * @default true
-   */
-  onlyFireOnDirectionChange?: boolean;
-
-  /**
-   * If true, onScrollUp fires only when scrollTop is below or equal to
-   * `onlyFireOnScrollUpAtTopOffset`.
-   * @default false
-   */
-  onlyFireOnScrollUpAtTop?: boolean;
-
-  /**
-   * Maximum scrollTop at which `onScrollUp` may fire when
-   * `onlyFireOnScrollUpAtTop` is true.
-   * @default 0
-   */
-  onlyFireOnScrollUpAtTopOffset?: number;
-
-  /** Callback triggered on scroll up */
-  onScrollUp?: ScrollCallback;
-
-  /** Callback triggered on scroll down past offset */
-  onScrollDown?: ScrollCallback;
+    /**
+     * Whether the hook is active.
+     */
+    enabled: boolean;
+    /**
+     * ScrollTop threshold for down scroll triggers. When set,
+     * `onScrollDown` fires only when the scroll position is greater than this.
+     * @default 100
+     */
+    offset?: number;
+    /**
+     * If true, callbacks fire only once per direction change.
+     * @default true
+     */
+    onlyFireOnDirectionChange?: boolean;
+    /**
+     * If true, onScrollUp fires only when scrollTop is below or equal to
+     * `onlyFireOnScrollUpAtTopOffset`.
+     * @default false
+     */
+    onlyFireOnScrollUpAtTop?: boolean;
+    /**
+     * Maximum scrollTop at which `onScrollUp` may fire when
+     * `onlyFireOnScrollUpAtTop` is true.
+     * @default 0
+     */
+    onlyFireOnScrollUpAtTopOffset?: number;
+    /**
+     * Callback triggered on scroll up.
+     */
+    onScrollUp?: ScrollCallback;
+    /**
+     * Callback triggered on scroll down past offset.
+     */
+    onScrollDown?: ScrollCallback;
 }
-
 /**
  * A scroll hook that detects scroll direction changes (up/down) and
  * triggers the appropriate callbacks. Commonly used to show/hide
  * UI elements based on scroll behavior.
- *
- * @param {UseScrollDirectionChangeParams} params The hook parameters
+ * @param params The hook parameters.
  */
 export default function useScrollDirectionChange(params: UseScrollDirectionChangeParams): void;
+//# sourceMappingURL=useScrollDirectionChange.d.ts.map

package/core/hooks/events/useScrollDirectionChange.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useScrollDirectionChange.d.ts","sourceRoot":"","sources":["../../../../core/hooks/events/useScrollDirectionChange.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,KAAK,EAAE,OAAO,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,IAAI,GAAG,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,KAAK,EAAE,eAAe,KAAK,IAAI,CAAC;AAE9D;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAEpC;;;;OAIG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAElC;;;;OAIG;IACH,6BAA6B,CAAC,EAAE,MAAM,CAAC;IAEvC;;OAEG;IACH,UAAU,CAAC,EAAE,cAAc,CAAC;IAE5B;;OAEG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC;CAC/B;AAOD;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,wBAAwB,CAAC,MAAM,EAAE,8BAA8B,QA4EtF"}

package/core/hooks/events/useScrollDirectionChange.js

@@ -1,38 +1,46 @@
-// @ts-check
 import { useEffect, useRef, useCallback } from 'react';
 import { viewScroll$ } from '@shopgate/engage/core/streams';
 
-/** @typedef {import('./useScrollDirectionChange').ViewScrollEvent} ViewScrollEvent */
-/** @typedef {import('./useScrollDirectionChange').ScrollCallback} ScrollCallback */
-// eslint-disable-next-line max-len
-/** @typedef {import('./useScrollDirectionChange').UseScrollDirectionChangeParams} UseScrollDirectionChangeParams */
+/**
+ * A scroll event as the view scroll stream emits it.
+ */
+
+/**
+ * A callback that receives a scroll event.
+ */
+
+/**
+ * Parameters for the scroll direction change hook.
+ */
+
+// Strips the internal properties the stream adds before an event reaches a callback.
+const toPublicEvent = ({
+  scrollIn: _scrollIn,
+  scrollOut: _scrollOut,
+  scrolled: _scrolled,
+  ...publicEvent
+}) => publicEvent;
 
 /**
  * A scroll hook that detects scroll direction changes (up/down) and
  * triggers the appropriate callbacks. Commonly used to show/hide
  * UI elements based on scroll behavior.
- *
- * @param {UseScrollDirectionChangeParams} params The hook parameters
+ * @param params The hook parameters.
  */
-export default function useScrollDirectionChange({
-  enabled,
-  offset = 100,
-  onlyFireOnDirectionChange = true,
-  onlyFireOnScrollUpAtTop = false,
-  onlyFireOnScrollUpAtTopOffset = 0,
-  onScrollUp,
-  onScrollDown
-}) {
+export default function useScrollDirectionChange(params) {
+  const {
+    enabled,
+    offset = 100,
+    onlyFireOnDirectionChange = true,
+    onlyFireOnScrollUpAtTop = false,
+    onlyFireOnScrollUpAtTopOffset = 0,
+    onScrollUp,
+    onScrollDown
+  } = params;
   const lastDirectionRef = useRef(null);
   const downTriggeredRef = useRef(false);
   const upTriggeredRef = useRef(false);
-
-  /**
-   * Scroll event handler.
-   * Uses `event.direction` and triggers callbacks accordingly.
-   */
-  const handleScroll = useCallback(/** @param {ViewScrollEvent} event The event */
-  event => {
+  const handleScroll = useCallback(event => {
     if (!enabled || !event.scrolled || !event.direction) return;
     const {
       scrollTop,
@@ -43,45 +51,30 @@ export default function useScrollDirectionChange({
 
     // Store current direction and reset flags if direction changed
     if (directionChanged) {
-      // @ts-expect-error
       lastDirectionRef.current = direction;
       if (direction === 'down') downTriggeredRef.current = false;
       if (direction === 'up') upTriggeredRef.current = false;
     }
 
-    // 🔽 Handle downward scroll
+    // Handle downward scroll
     if (direction === 'down') {
       const shouldFire = (!onlyFireOnDirectionChange || directionChanged || !downTriggeredRef.current) && scrollTop >= offset;
       if (shouldFire && typeof onScrollDown === 'function') {
         downTriggeredRef.current = true;
-
-        // Strip internal/legacy properties
-        const {
-          scrollIn,
-          scrollOut,
-          scrolled,
-          ...publicEvent
-        } = event;
-        onScrollDown(publicEvent);
+        onScrollDown(toPublicEvent(event));
       }
     }
 
-    // 🔼 Handle upward scroll
+    // Handle upward scroll
     if (direction === 'up') {
-      // if user wants “only fire at the very top” and we’re not at 0, skip
+      // if user wants "only fire at the very top" and we are not at 0, skip
       if (onlyFireOnScrollUpAtTop && scrollTop > onlyFireOnScrollUpAtTopOffset) {
         return;
       }
       const shouldFire = !onlyFireOnDirectionChange || directionChanged || !upTriggeredRef.current;
       if (shouldFire && typeof onScrollUp === 'function') {
         upTriggeredRef.current = true;
-        const {
-          scrollIn,
-          scrollOut,
-          scrolled,
-          ...publicEvent
-        } = event;
-        onScrollUp(publicEvent);
+        onScrollUp(toPublicEvent(event));
       }
     }
   }, [enabled, onlyFireOnDirectionChange, offset, onScrollDown, onlyFireOnScrollUpAtTop, onlyFireOnScrollUpAtTopOffset, onScrollUp]);

package/core/hooks/html/useLoadImage.d.ts

@@ -1,7 +1,7 @@
 /**
  * Load image hook
- * @param {string} src .
- * @returns {boolean}
+ * @param {string|null} src The image to preload. A falsy src is a no-op.
+ * @returns {boolean} Whether the image has finished loading.
  */
-export function useLoadImage(src: string): boolean;
+export function useLoadImage(src: string | null): boolean;
 //# sourceMappingURL=useLoadImage.d.ts.map

package/core/hooks/html/useLoadImage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useLoadImage.d.ts","sourceRoot":"","sources":["../../../../core/hooks/html/useLoadImage.js"],"names":[],"mappings":"AAGA;;;;GAIG;AACH,kCAHW,MAAM,GACJ,OAAO,CAUnB"}
+{"version":3,"file":"useLoadImage.d.ts","sourceRoot":"","sources":["../../../../core/hooks/html/useLoadImage.js"],"names":[],"mappings":"AAGA;;;;GAIG;AACH,kCAHW,MAAM,GAAC,IAAI,GACT,OAAO,CAUnB"}

package/core/hooks/html/useLoadImage.js

@@ -3,8 +3,8 @@ import { loadImage } from '@shopgate/pwa-common/helpers/html/handleDOM';
 
 /**
  * Load image hook
- * @param {string} src .
- * @returns {boolean}
+ * @param {string|null} src The image to preload. A falsy src is a no-op.
+ * @returns {boolean} Whether the image has finished loading.
  */
 export function useLoadImage(src) {
   const [loaded, setIsLoaded] = useState(false);

package/core/hooks/useLocalStorage.d.ts

@@ -11,6 +11,14 @@ interface UseLocalStorageOptions<T> {
      * @default true
      */
     sync?: boolean;
+    /**
+     * Whether the value is written to localStorage at all. Set to false in contexts that must not
+     * leak state into the visitor's browser and should stay ephemeral. With this off the hook is a
+     * plain useState: it neither reads nor writes localStorage, and it ignores updates from other
+     * tabs.
+     * @default true
+     */
+    persist?: boolean;
 }
 type SetValueAction<T> = T | null | ((prev: T | null) => T | null);
 /**

package/core/hooks/useLocalStorage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useLocalStorage.d.ts","sourceRoot":"","sources":["../../../core/hooks/useLocalStorage.ts"],"names":[],"mappings":"AASA;;GAEG;AACH,UAAU,sBAAsB,CAAC,CAAC;IAChC;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,CAAC;IAEjB;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED,KAAK,cAAc,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,GAAG,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;AAEnE;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,eAAe,CAAC,CAAC,EACvC,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,sBAAsB,CAAC,CAAC,CAAM,GACtC,SAAS,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CA8EzD"}
+{"version":3,"file":"useLocalStorage.d.ts","sourceRoot":"","sources":["../../../core/hooks/useLocalStorage.ts"],"names":[],"mappings":"AASA;;GAEG;AACH,UAAU,sBAAsB,CAAC,CAAC;IAChC;;OAEG;IACH,YAAY,CAAC,EAAE,CAAC,CAAC;IAEjB;;;OAGG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;IAEf;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,KAAK,cAAc,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,GAAG,IAAI,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;AAEnE;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,eAAe,CAAC,CAAC,EACvC,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,sBAAsB,CAAC,CAAC,CAAM,GACtC,SAAS,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAqFzD"}