@wordpress/compose 8.1.1 → 8.2.0

package/build-types/hooks/use-dragging/types.d.ts

@@ -0,0 +1,11 @@
+export interface DraggingProps {
+    onDragStart?: (e: React.MouseEvent) => void;
+    onDragMove?: (e: MouseEvent) => void;
+    onDragEnd?: (e?: MouseEvent) => void;
+}
+export interface DraggingReturn {
+    startDrag: (e: React.MouseEvent) => void;
+    endDrag: (e?: MouseEvent) => void;
+    isDragging: boolean;
+}
+//# sourceMappingURL=types.d.ts.map

package/build-types/hooks/use-dragging/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-dragging/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAC7B,WAAW,CAAC,EAAE,CAAE,CAAC,EAAE,KAAK,CAAC,UAAU,KAAM,IAAI,CAAC;IAC9C,UAAU,CAAC,EAAE,CAAE,CAAC,EAAE,UAAU,KAAM,IAAI,CAAC;IACvC,SAAS,CAAC,EAAE,CAAE,CAAC,CAAC,EAAE,UAAU,KAAM,IAAI,CAAC;CACvC;AAED,MAAM,WAAW,cAAc;IAC9B,SAAS,EAAE,CAAE,CAAC,EAAE,KAAK,CAAC,UAAU,KAAM,IAAI,CAAC;IAC3C,OAAO,EAAE,CAAE,CAAC,CAAC,EAAE,UAAU,KAAM,IAAI,CAAC;IACpC,UAAU,EAAE,OAAO,CAAC;CACpB"}

package/build-types/hooks/use-drop-zone/index.d.ts

@@ -1,26 +1,9 @@
+import type { UseDropZoneProps } from './types';
 /**
  * A hook to facilitate drag and drop handling.
  *
- * @param {Object}                  props                   Named parameters.
- * @param {?HTMLElement}            [props.dropZoneElement] Optional element to be used as the drop zone.
- * @param {boolean}                 [props.isDisabled]      Whether or not to disable the drop zone.
- * @param {(e: DragEvent) => void}  [props.onDragStart]     Called when dragging has started.
- * @param {(e: DragEvent) => void}  [props.onDragEnter]     Called when the zone is entered.
- * @param {(e: DragEvent) => void}  [props.onDragOver]      Called when the zone is moved within.
- * @param {(e: DragEvent) => void}  [props.onDragLeave]     Called when the zone is left.
- * @param {(e: MouseEvent) => void} [props.onDragEnd]       Called when dragging has ended.
- * @param {(e: DragEvent) => void}  [props.onDrop]          Called when dropping in the zone.
- *
- * @return {React.RefCallback<HTMLElement>} Ref callback to be passed to the drop zone element.
+ * @param {UseDropZoneProps} props Hook options
+ * @return Ref callback to be passed to the drop zone element.
  */
-export default function useDropZone({ dropZoneElement, isDisabled, onDrop: _onDrop, onDragStart: _onDragStart, onDragEnter: _onDragEnter, onDragLeave: _onDragLeave, onDragEnd: _onDragEnd, onDragOver: _onDragOver }: {
-    dropZoneElement?: HTMLElement | null;
-    isDisabled?: boolean;
-    onDragStart?: (e: DragEvent) => void;
-    onDragEnter?: (e: DragEvent) => void;
-    onDragOver?: (e: DragEvent) => void;
-    onDragLeave?: (e: DragEvent) => void;
-    onDragEnd?: (e: MouseEvent) => void;
-    onDrop?: (e: DragEvent) => void;
-}): React.RefCallback<HTMLElement>;
+export default function useDropZone({ dropZoneElement, isDisabled, onDrop: _onDrop, onDragStart: _onDragStart, onDragEnter: _onDragEnter, onDragLeave: _onDragLeave, onDragEnd: _onDragEnd, onDragOver: _onDragOver }: UseDropZoneProps): React.RefCallback<HTMLElement>;
 //# sourceMappingURL=index.d.ts.map

package/build-types/hooks/use-drop-zone/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-drop-zone/index.js"],"names":[],"mappings":"AAMA;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,OAAO,UAAU,WAAW,CAAE,EACpC,eAAe,EACf,UAAU,EACV,MAAM,EAAE,OAAO,EACf,WAAW,EAAE,YAAY,EACzB,WAAW,EAAE,YAAY,EACzB,WAAW,EAAE,YAAY,EACzB,SAAS,EAAE,UAAU,EACrB,UAAU,EAAE,WAAW,EACvB,EApBE;IAAwC,eAAe,AAAvD,CACA,EADS,WAAW,OAAA,CACpB;IAAwC,UAAU,AAAlD,CACA,EADQ,OAAO,CACf;IAAwC,WAAW,AAAnD,CACA,EADQ,CAAC,CAAC,EAAE,SAAS,KAAK,IAAI,CAC9B;IAAwC,WAAW,AAAnD,CACA,EADQ,CAAC,CAAC,EAAE,SAAS,KAAK,IAAI,CAC9B;IAAwC,UAAU,AAAlD,CACA,EADQ,CAAC,CAAC,EAAE,SAAS,KAAK,IAAI,CAC9B;IAAwC,WAAW,AAAnD,CACA,EADQ,CAAC,CAAC,EAAE,SAAS,KAAK,IAAI,CAC9B;IAAwC,SAAS,AAAjD,CACA,EADQ,CAAC,CAAC,EAAE,UAAU,KAAK,IAAI,CAC/B;IAAwC,MAAM,AAA9C,CAEA,EAFQ,CAAC,CAAC,EAAE,SAAS,KAAK,IAAI,CAE9B;CAWF,GAXW,KAAK,CAAC,WAAW,CAAC,WAAW,CAAC,CAoMzC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-drop-zone/index.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAEhD;;;;;GAKG;AACH,MAAM,CAAC,OAAO,UAAU,WAAW,CAAE,EACpC,eAAe,EACf,UAAU,EACV,MAAM,EAAE,OAAO,EACf,WAAW,EAAE,YAAY,EACzB,WAAW,EAAE,YAAY,EACzB,WAAW,EAAE,YAAY,EACzB,SAAS,EAAE,UAAU,EACrB,UAAU,EAAE,WAAW,EACvB,EAAE,gBAAgB,GAAI,KAAK,CAAC,WAAW,CAAE,WAAW,CAAE,CAmLtD"}

package/build-types/hooks/use-drop-zone/types.d.ts

@@ -0,0 +1,35 @@
+export interface UseDropZoneProps {
+    /**
+     * Optional element to be used as the drop zone.
+     */
+    dropZoneElement?: HTMLElement | null;
+    /**
+     * Whether or not to disable the drop zone.
+     */
+    isDisabled?: boolean;
+    /**
+     * Called when dragging has started.
+     */
+    onDragStart?: (e: DragEvent) => void;
+    /**
+     *  Called when the zone is entered.
+     */
+    onDragEnter?: (e: DragEvent) => void;
+    /**
+     * Called when the zone is moved within.
+     */
+    onDragOver?: (e: DragEvent) => void;
+    /**
+     * Called when the zone is left.
+     */
+    onDragLeave?: (e: DragEvent) => void;
+    /**
+     * Called when dragging has ended.
+     */
+    onDragEnd?: (e: MouseEvent) => void;
+    /**
+     * Called when dropping in the zone.
+     */
+    onDrop?: (e: DragEvent) => void;
+}
+//# sourceMappingURL=types.d.ts.map

package/build-types/hooks/use-drop-zone/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-drop-zone/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,gBAAgB;IAChC;;OAEG;IACH,eAAe,CAAC,EAAE,WAAW,GAAG,IAAI,CAAC;IACrC;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;OAEG;IACH,WAAW,CAAC,EAAE,CAAE,CAAC,EAAE,SAAS,KAAM,IAAI,CAAC;IACvC;;OAEG;IACH,WAAW,CAAC,EAAE,CAAE,CAAC,EAAE,SAAS,KAAM,IAAI,CAAC;IACvC;;OAEG;IACH,UAAU,CAAC,EAAE,CAAE,CAAC,EAAE,SAAS,KAAM,IAAI,CAAC;IACtC;;OAEG;IACH,WAAW,CAAC,EAAE,CAAE,CAAC,EAAE,SAAS,KAAM,IAAI,CAAC;IACvC;;OAEG;IACH,SAAS,CAAC,EAAE,CAAE,CAAC,EAAE,UAAU,KAAM,IAAI,CAAC;IACtC;;OAEG;IACH,MAAM,CAAC,EAAE,CAAE,CAAC,EAAE,SAAS,KAAM,IAAI,CAAC;CAClC"}

package/build-types/hooks/use-fixed-window-list/index.d.ts

@@ -1,38 +1,34 @@
-export type WPFixedWindowList = {
+interface FixedWindowList {
+    /** Items visible in the current viewport */
     visibleItems: number;
+    /** Start index of the window */
     start: number;
+    /** End index of the window */
     end: number;
+    /** Returns true if item is in the window */
     itemInView: (index: number) => boolean;
-};
-export type WPFixedWindowListOptions = {
+}
+interface FixedWindowListOptions {
+    /** Renders windowOverscan number of items before and after the calculated visible window. */
     windowOverscan?: number;
+    /** When false avoids calculating the window size */
     useWindowing?: boolean;
+    /** Initial window size to use on first render before we can calculate the window size. */
     initWindowSize?: number;
+    /** Used to recalculate the window size when the expanded state of a list changes. */
     expandedState?: any;
-};
+}
 /**
- * @typedef {Object} WPFixedWindowList
  *
- * @property {number}                  visibleItems Items visible in the current viewport
- * @property {number}                  start        Start index of the window
- * @property {number}                  end          End index of the window
- * @property {(index:number)=>boolean} itemInView   Returns true if item is in the window
+ * @param elementRef Used to find the closest scroll container that contains element.
+ * @param itemHeight Fixed item height in pixels
+ * @param totalItems Total items in list
+ * @param [options]  Options object
+ * @return Array with the fixed window list and setter
  */
-/**
- * @typedef {Object} WPFixedWindowListOptions
- *
- * @property {number}  [windowOverscan] Renders windowOverscan number of items before and after the calculated visible window.
- * @property {boolean} [useWindowing]   When false avoids calculating the window size
- * @property {number}  [initWindowSize] Initial window size to use on first render before we can calculate the window size.
- * @property {any}     [expandedState]  Used to recalculate the window size when the expanded state of a list changes.
- */
-/**
- *
- * @param {React.RefObject<HTMLElement>} elementRef Used to find the closest scroll container that contains element.
- * @param { number }                     itemHeight Fixed item height in pixels
- * @param { number }                     totalItems Total items in list
- * @param { WPFixedWindowListOptions }   [options]  Options object
- * @return {[ WPFixedWindowList, setFixedListWindow:(nextWindow:WPFixedWindowList)=>void]} Array with the fixed window list and setter
- */
-export default function useFixedWindowList(elementRef: React.RefObject<HTMLElement>, itemHeight: number, totalItems: number, options?: WPFixedWindowListOptions): [WPFixedWindowList, setFixedListWindow: (nextWindow: WPFixedWindowList) => void];
+export default function useFixedWindowList(elementRef: React.RefObject<HTMLElement>, itemHeight: number, totalItems: number, options?: FixedWindowListOptions): [
+    FixedWindowList,
+    React.Dispatch<React.SetStateAction<FixedWindowList>>
+];
+export {};
 //# sourceMappingURL=index.d.ts.map

package/build-types/hooks/use-fixed-window-list/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-fixed-window-list/index.js"],"names":[],"mappings":"AAeG,YAAkB,iBAAiB,GAEnC;IAAoC,YAAY,EAArC,MAAM,CACjB;IAAoC,KAAK,EAA9B,MAAM,CACjB;IAAoC,GAAG,EAA5B,MAAM,CACjB;IAAoC,UAAU,EAAnC,CAAC,KAAK,EAAC,MAAM,KAAG,OAAO,CACpC;CAAA,CAAA;AAGE,YAAkB,wBAAwB,GAE1C;IAAqB,cAAc,AAAnC,CACA,EADW,MAAM,CACjB;IAAqB,YAAY,AAAjC,CACA,EADW,OAAO,CAClB;IAAqB,cAAc,AAAnC,CACA,EADW,MAAM,CACjB;IAAqB,aAAa,AAAlC,CACF,EADa,GAAG,CAChB;CAAA,CAAA;AAhBD;;;;;;;GAOG;AAEH;;;;;;;GAOG;AAEH;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,UAAU,kBAAkB,CACzC,UAAU,EAPA,KAAK,CAAC,SAAS,CAAC,WAAW,CAO3B,EACV,UAAU,EAPC,MAOD,EACV,UAAU,EAPC,MAOD,EACV,OAAO,AAPL,CACA,EADS,wBAOJ,GANI,CAAE,iBAAiB,EAAE,kBAAkB,EAAC,CAAC,UAAU,EAAC,iBAAiB,KAAG,IAAI,CAAC,CA0JxF"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-fixed-window-list/index.ts"],"names":[],"mappings":"AAcA,UAAU,eAAe;IACxB,4CAA4C;IAC5C,YAAY,EAAE,MAAM,CAAC;IACrB,gCAAgC;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,8BAA8B;IAC9B,GAAG,EAAE,MAAM,CAAC;IACZ,4CAA4C;IAC5C,UAAU,EAAE,CAAE,KAAK,EAAE,MAAM,KAAM,OAAO,CAAC;CACzC;AAED,UAAU,sBAAsB;IAC/B,6FAA6F;IAC7F,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,oDAAoD;IACpD,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,0FAA0F;IAC1F,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,qFAAqF;IACrF,aAAa,CAAC,EAAE,GAAG,CAAC;CACpB;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,OAAO,UAAU,kBAAkB,CACzC,UAAU,EAAE,KAAK,CAAC,SAAS,CAAE,WAAW,CAAE,EAC1C,UAAU,EAAE,MAAM,EAClB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,sBAAsB,GAC9B;IACF,eAAe;IACf,KAAK,CAAC,QAAQ,CAAE,KAAK,CAAC,cAAc,CAAE,eAAe,CAAE,CAAE;CACzD,CAqJA"}

package/build-types/hooks/use-focus-return/index.d.ts

@@ -2,11 +2,11 @@
  * Adds the unmount behavior of returning focus to the element which had it
  * previously as is expected for roles like menus or dialogs.
  *
- * @param {() => void} [onFocusReturn] Overrides the default return behavior.
- * @return {React.RefCallback<HTMLElement>} Element Ref.
+ * @param onFocusReturn Overrides the default return behavior.
+ * @return Element Ref.
  *
  * @example
- * ```js
+ * ```ts
  * import { useFocusReturn } from '@wordpress/compose';
  *
  * const WithFocusReturn = () => {

package/build-types/hooks/use-focus-return/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-focus-return/index.js"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,iBAAS,cAAc,CAAE,aAAa,AAlBnC,CACA,EADQ,MAAM,IAkBqB,GAjB1B,KAAK,CAAC,WAAW,CAAC,WAAW,CAAC,CAsEzC;eAEc,cAAc"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-focus-return/index.ts"],"names":[],"mappings":"AAOA;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,iBAAS,cAAc,CACtB,aAAa,CAAC,EAAE,MAAM,IAAI,GACxB,KAAK,CAAC,WAAW,CAAE,WAAW,CAAE,CAyDlC;eAEc,cAAc"}

package/build-types/hooks/use-isomorphic-layout-effect/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-isomorphic-layout-effect/index.js"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAa,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAEhE;;;;GAIG;AACH,QAAA,MAAM,yBAAyB,wBAC6B,CAAC;eAE9C,yBAAyB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-isomorphic-layout-effect/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,EAAa,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAEhE;;;;GAIG;AACH,QAAA,MAAM,yBAAyB,wBAC6B,CAAC;eAE9C,yBAAyB"}

package/build-types/hooks/use-keyboard-shortcut/index.d.ts

@@ -1,34 +1,40 @@
-/**
- * External dependencies
- */
-import Mousetrap from 'mousetrap';
 import 'mousetrap/plugins/global-bind/mousetrap-global-bind.js';
-export type WPKeyboardShortcutConfig = {
-    bindGlobal?: boolean;
-    eventName?: string;
-    isDisabled?: boolean;
-    target?: React.RefObject<HTMLElement | null>;
-};
+import type { ExtendedKeyboardEvent } from 'mousetrap';
 /**
- * A block selection object.
- *
- * @typedef {Object} WPKeyboardShortcutConfig
- *
- * @property {boolean}                             [bindGlobal] Handle keyboard events anywhere including inside textarea/input fields.
- * @property {string}                              [eventName]  Event name used to trigger the handler, defaults to keydown.
- * @property {boolean}                             [isDisabled] Disables the keyboard handler if the value is true.
- * @property {React.RefObject<HTMLElement | null>} [target]     React reference to the DOM element used to catch the keyboard event.
+ * WordPress dependencies
  */
+import type { RefObject } from '@wordpress/element';
+type KeyboardShortcutConfig = {
+    /**
+     * Handle keyboard events anywhere including inside textarea/input fields.
+     */
+    bindGlobal: boolean;
+    /**
+     * Event name used to trigger the handler, defaults to keydown.
+     */
+    eventName: string;
+    /**
+     * Disables the keyboard handler if the value is true.
+     */
+    isDisabled: boolean;
+    /**
+     * React reference to the DOM element used to catch the keyboard event.
+     */
+    target: RefObject<HTMLElement>;
+};
 /**
  * Attach a keyboard shortcut handler.
  *
  * @see https://craig.is/killing/mice#api.bind for information about the `callback` parameter.
  *
- * @param {string[]|string}                                             shortcuts Keyboard Shortcuts.
- * @param {(e: Mousetrap.ExtendedKeyboardEvent, combo: string) => void} callback  Shortcut callback.
- * @param {WPKeyboardShortcutConfig}                                    options   Shortcut options.
+ * @param shortcuts          Keyboard Shortcuts.
+ * @param callback           Shortcut callback.
+ * @param options            Shortcut options.
+ * @param options.bindGlobal
+ * @param options.eventName
+ * @param options.isDisabled
+ * @param options.target
  */
-declare function useKeyboardShortcut(shortcuts: string[] | string, callback: (e: Mousetrap.ExtendedKeyboardEvent, combo: string) => void, { bindGlobal, eventName, isDisabled, // This is important for performance considerations.
-target }?: WPKeyboardShortcutConfig): void;
+declare function useKeyboardShortcut(shortcuts: string[] | string, callback: (e: ExtendedKeyboardEvent, combo: string) => void, { bindGlobal, eventName, isDisabled, target }?: Partial<KeyboardShortcutConfig>): void;
 export default useKeyboardShortcut;
 //# sourceMappingURL=index.d.ts.map

package/build-types/hooks/use-keyboard-shortcut/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-keyboard-shortcut/index.js"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,SAAS,MAAM,WAAW,CAAC;AAClC,OAAO,wDAAwD,CAAC;AAW7D,YAAkB,wBAAwB,GAE1C;IAAiD,UAAU,AAA3D,CACA,EADW,OAAO,CAClB;IAAiD,SAAS,AAA1D,CACA,EADW,MAAM,CACjB;IAAiD,UAAU,AAA3D,CACA,EADW,OAAO,CAClB;IAAiD,MAAM,AAAvD,CACF,EADa,KAAK,CAAC,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC,CAChD;CAAA,CAAA;AATD;;;;;;;;;GASG;AAEH;;;;;;;;GAQG;AACH,iBAAS,mBAAmB,CAC3B,SAAS,EALC,MAAM,EAAE,GAAC,MAKV,EACT,QAAQ,EALE,CAAC,CAAC,EAAE,SAAS,CAAC,qBAAqB,EAAE,KAAK,EAAE,MAAM,KAAK,IAKzD,EACR,EACC,UAAkB,EAClB,SAAqB,EACrB,UAAkB,EAAE,oDAAoD;AACxE,MAAM,EACN,GAVS,wBAUJ,QA2DN;eAEc,mBAAmB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-keyboard-shortcut/index.ts"],"names":[],"mappings":"AAIA,OAAO,wDAAwD,CAAC;AAChE,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAEvD;;GAEG;AACH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAIpD,KAAK,sBAAsB,GAAG;IAC7B;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,MAAM,EAAE,SAAS,CAAE,WAAW,CAAE,CAAC;CACjC,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,iBAAS,mBAAmB,CAC3B,SAAS,EAAE,MAAM,EAAE,GAAG,MAAM,EAC5B,QAAQ,EAAE,CAAE,CAAC,EAAE,qBAAqB,EAAE,KAAK,EAAE,MAAM,KAAM,IAAI,EAC7D,EACC,UAAkB,EAClB,SAAqB,EACrB,UAAkB,EAClB,MAAM,EACN,GAAE,OAAO,CAAE,sBAAsB,CAAO,QA4DzC;eAEc,mBAAmB"}

package/build-types/hooks/use-reduced-motion/index.d.ts

@@ -1,7 +1,7 @@
 /**
  * Hook returning whether the user has a preference for reduced motion.
  *
- * @return {boolean} Reduced motion preference value.
+ * @return Reduced motion preference value.
  */
 declare const useReducedMotion: () => boolean;
 export default useReducedMotion;

package/build-types/hooks/use-reduced-motion/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-reduced-motion/index.js"],"names":[],"mappings":"AAKA;;;;GAIG;AACH,QAAA,MAAM,gBAAgB,QAFV,OAGwC,CAAC;eAEtC,gBAAgB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-reduced-motion/index.ts"],"names":[],"mappings":"AAKA;;;;GAIG;AACH,QAAA,MAAM,gBAAgB,QAAO,OACuB,CAAC;eAEtC,gBAAgB"}

package/build-types/hooks/use-throttle/index.d.ts

@@ -1,3 +1,5 @@
+import type { ThrottleOptions } from '../../utils/throttle';
+import type { DebouncedFunc } from '../../utils/debounce';
 /**
  * Throttles a function similar to Lodash's `throttle`. A new throttled function will
  * be returned and any scheduled calls cancelled if any of the arguments change,
@@ -6,12 +8,12 @@
  *
  * @see https://lodash.com/docs/4#throttle
  *
- * @template {(...args: any[]) => void} TFunc
+ * @template TFunc
  *
- * @param {TFunc}                                          fn        The function to throttle.
- * @param {number}                                         [wait]    The number of milliseconds to throttle invocations to.
- * @param {import('../../utils/throttle').ThrottleOptions} [options] The options object. See linked documentation for details.
- * @return {import('../../utils/debounce').DebouncedFunc<TFunc>} Throttled function.
+ * @param    fn      The function to throttle.
+ * @param    wait    The number of milliseconds to throttle invocations to.
+ * @param    options The options object.
+ * @return          Throttled function.
  */
-export default function useThrottle<TFunc extends (...args: any[]) => void>(fn: TFunc, wait?: number, options?: import('../../utils/throttle').ThrottleOptions): import('../../utils/debounce').DebouncedFunc<TFunc>;
+export default function useThrottle<TFunc extends (...args: any[]) => void>(fn: TFunc, wait?: number, options?: ThrottleOptions): DebouncedFunc<TFunc>;
 //# sourceMappingURL=index.d.ts.map

package/build-types/hooks/use-throttle/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-throttle/index.js"],"names":[],"mappings":"AAeA;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,OAAO,UAAU,WAAW,CAPK,KAAK,SAA/B,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAW,EAOR,EAAE,EAL5B,KAK4B,EAAE,IAAI,AAJ1C,CACA,EADQ,MAIkC,EAAE,OAAO,AAHnD,CACA,EADQ,OAAO,sBAAsB,EAAE,eAGY,GAF1C,OAAO,sBAAsB,EAAE,aAAa,CAAC,KAAK,CAAC,CAS9D"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-throttle/index.ts"],"names":[],"mappings":"AAcA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAC5D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AAE1D;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,OAAO,UAAU,WAAW,CAAE,KAAK,SAAS,CAAE,GAAG,IAAI,EAAE,GAAG,EAAE,KAAM,IAAI,EAC5E,EAAE,EAAE,KAAK,EACT,IAAI,CAAC,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,eAAe,GACvB,aAAa,CAAE,KAAK,CAAE,CAOxB"}

package/build-types/hooks/use-viewport-match/index.d.ts

@@ -1,6 +1,6 @@
-export type WPBreakpoint = "xhuge" | "huge" | "wide" | "xlarge" | "large" | "medium" | "small" | "mobile";
-export type WPViewportOperator = ">=" | "<";
-declare function useViewportMatch(breakpoint: WPBreakpoint, operator?: WPViewportOperator, view?: Window | undefined): boolean;
+type Breakpoint = 'xhuge' | 'huge' | 'wide' | 'xlarge' | 'large' | 'medium' | 'small' | 'mobile';
+type ViewportOperator = '>=' | '<';
+declare function useViewportMatch(breakpoint: Breakpoint, operator?: ViewportOperator, view?: Window | undefined): boolean;
 declare namespace useViewportMatch {
     var __experimentalWidthProvider: import("react").Provider<number | null>;
 }

package/build-types/hooks/use-viewport-match/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-viewport-match/index.js"],"names":[],"mappings":"AAWG,YAA0F,YAAY,GAA5F,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,GAAG,OAAO,GAAG,QAAQ,CAAc;AAsBtG,YAAsB,kBAAkB,GAA9B,IAAI,GAAG,GAAG,CAAoB;kCA6C1C,UAAU,EAdA,YAcA,EACV,QAAQ,GAdE,kBAcK,EAGf,IAAI,GAhBM,MAAM,GAAC,SAgBwC,GAP9C,OAAO;;;;eA0BJ,gBAAgB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-viewport-match/index.ts"],"names":[],"mappings":"AAUA,KAAK,UAAU,GACZ,OAAO,GACP,MAAM,GACN,MAAM,GACN,QAAQ,GACR,OAAO,GACP,QAAQ,GACR,OAAO,GACP,QAAQ,CAAC;AACZ,KAAK,gBAAgB,GAAG,IAAI,GAAG,GAAG,CAAC;kCAyDlC,UAAU,EAAE,UAAU,EACtB,QAAQ,GAAE,gBAAuB,EAGjC,IAAI,GAAE,MAAM,GAAG,SAEH,GACV,OAAO;;;;eAmBK,gBAAgB"}

package/build-types/hooks/use-warn-on-change/index.d.ts

@@ -1,21 +1,21 @@
 /**
- * Hook that performs a shallow comparison between the preview value of an object
+ * Hook that performs a shallow comparison between the previous value of an object
  * and the new one, if there's a difference, it prints it to the console.
- * this is useful in performance related work, to check why a component re-renders.
+ * This is useful in performance related work, to check why a component re-renders.
  *
  *  @example
  *
- * ```jsx
- * function MyComponent(props) {
+ * ```tsx
+ * function MyComponent(props: Record<string, any>) {
  *    useWarnOnChange(props);
  *
  *    return "Something";
  * }
  * ```
  *
- * @param {object} object Object which changes to compare.
- * @param {string} prefix Just a prefix to show when console logging.
+ * @param object Object which changes to compare.
+ * @param prefix Just a prefix to show when console logging.
  */
-declare function useWarnOnChange(object: object, prefix?: string): void;
+declare function useWarnOnChange(object: Record<string, any> | any[], prefix?: string): void;
 export default useWarnOnChange;
 //# sourceMappingURL=index.d.ts.map

package/build-types/hooks/use-warn-on-change/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-warn-on-change/index.js"],"names":[],"mappings":"AAQA;;;;;;;;;;;;;;;;;GAiBG;AACH,iBAAS,eAAe,CAAE,MAAM,EAHrB,MAGqB,EAAE,MAAM,GAF7B,MAEkD,QAc5D;eAEc,eAAe"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-warn-on-change/index.ts"],"names":[],"mappings":"AAKA;;;;;;;;;;;;;;;;;GAiBG;AACH,iBAAS,eAAe,CACvB,MAAM,EAAE,MAAM,CAAE,MAAM,EAAE,GAAG,CAAE,GAAG,GAAG,EAAE,EACrC,MAAM,GAAE,MAA2B,GACjC,IAAI,CAaN;eAEc,eAAe"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@wordpress/compose",
-	"version": "8.1.1",
+	"version": "8.2.0",
 	"description": "WordPress higher-order components (HOCs).",
 	"author": "The WordPress Contributors",
 	"license": "GPL-2.0-or-later",
@@ -46,15 +46,14 @@
 	"sideEffects": false,
 	"dependencies": {
 		"@types/mousetrap": "^1.6.8",
-		"@types/react": "^18.3.27",
-		"@wordpress/deprecated": "^4.48.1",
-		"@wordpress/dom": "^4.48.1",
-		"@wordpress/element": "^8.0.1",
-		"@wordpress/is-shallow-equal": "^5.48.1",
-		"@wordpress/keycodes": "^4.48.1",
-		"@wordpress/priority-queue": "^3.48.1",
-		"@wordpress/private-apis": "^1.48.1",
-		"@wordpress/undo-manager": "^1.48.1",
+		"@wordpress/deprecated": "^4.49.0",
+		"@wordpress/dom": "^4.49.0",
+		"@wordpress/element": "^8.1.0",
+		"@wordpress/is-shallow-equal": "^5.49.0",
+		"@wordpress/keycodes": "^4.49.0",
+		"@wordpress/priority-queue": "^3.49.0",
+		"@wordpress/private-apis": "^1.49.0",
+		"@wordpress/undo-manager": "^1.49.0",
 		"change-case": "^4.1.2",
 		"mousetrap": "^1.6.5",
 		"use-memo-one": "^1.1.1"
@@ -67,10 +66,16 @@
 		"react-dom": "^18.3.1"
 	},
 	"peerDependencies": {
+		"@types/react": "^18.3.27",
 		"react": "^18.0.0"
 	},
+	"peerDependenciesMeta": {
+		"@types/react": {
+			"optional": true
+		}
+	},
 	"publishConfig": {
 		"access": "public"
 	},
-	"gitHead": "99df7432c5c7cb83ba41146fd1f57f3c19004305"
+	"gitHead": "0e7112a4f4fde4ea15bd9060489b8f6fe11eb6ca"
 }

package/src/hooks/use-constrained-tabbing/{index.js → index.ts}

@@ -12,10 +12,10 @@ import useRefEffect from '../use-ref-effect';
  * In Dialogs/modals, the tabbing must be constrained to the content of
  * the wrapper element. This hook adds the behavior to the returned ref.
  *
- * @return {React.RefCallback<Element>} Element Ref.
+ * @return Element Ref.
  *
  * @example
- * ```js
+ * ```ts
  * import { useConstrainedTabbing } from '@wordpress/compose';
  *
  * const ConstrainedTabbingExample = () => {
@@ -29,9 +29,9 @@ import useRefEffect from '../use-ref-effect';
  * }
  * ```
  */
-function useConstrainedTabbing() {
-	return useRefEffect( ( /** @type {HTMLElement} */ node ) => {
-		function onKeyDown( /** @type {KeyboardEvent} */ event ) {
+function useConstrainedTabbing(): React.RefCallback< Element > {
+	return useRefEffect( ( node: HTMLElement ) => {
+		function onKeyDown( event: KeyboardEvent ): void {
 			const { key, shiftKey, target } = event;
 
 			if ( key !== 'Tab' ) {
@@ -40,9 +40,7 @@ function useConstrainedTabbing() {
 
 			const action = shiftKey ? 'findPrevious' : 'findNext';
 			const nextElement =
-				focus.tabbable[ action ](
-					/** @type {HTMLElement} */ ( target )
-				) || null;
+				focus.tabbable[ action ]( target as HTMLElement ) || null;
 
 			// When the target element contains the element that is about to
 			// receive focus, for example when the target is a tabbable
@@ -50,9 +48,7 @@ function useConstrainedTabbing() {
 			// In this case we can't rely on native browsers behavior. We need
 			// to manage focus instead.
 			// See https://github.com/WordPress/gutenberg/issues/46041.
-			if (
-				/** @type {HTMLElement} */ ( target ).contains( nextElement )
-			) {
+			if ( ( target as HTMLElement ).contains( nextElement ) ) {
 				event.preventDefault();
 				nextElement?.focus();
 				return;

package/src/hooks/use-debounce/{index.js → index.ts}

@@ -12,6 +12,7 @@ import { useEffect } from '@wordpress/element';
  * Internal dependencies
  */
 import { debounce } from '../../utils/debounce';
+import type { DebounceOptions, DebouncedFunc } from '../../utils/debounce';
 
 /**
  * Debounces a function similar to Lodash's `debounce`. A new debounced function will
@@ -21,14 +22,18 @@ import { debounce } from '../../utils/debounce';
  *
  * @see https://lodash.com/docs/4#debounce
  *
- * @template {(...args: any[]) => void} TFunc
+ * @template TFunc
  *
- * @param {TFunc}                                          fn        The function to debounce.
- * @param {number}                                         [wait]    The number of milliseconds to delay.
- * @param {import('../../utils/debounce').DebounceOptions} [options] The options object.
- * @return {import('../../utils/debounce').DebouncedFunc<TFunc>} Debounced function.
+ * @param    fn      The function to debounce.
+ * @param    wait    The number of milliseconds to delay.
+ * @param    options The options object.
+ * @return          Debounced function.
  */
-export default function useDebounce( fn, wait, options ) {
+export default function useDebounce< TFunc extends ( ...args: any[] ) => void >(
+	fn: TFunc,
+	wait?: number,
+	options?: DebounceOptions
+): DebouncedFunc< TFunc > {
 	const debounced = useMemoOne(
 		() => debounce( fn, wait ?? 0, options ),
 		[ fn, wait, options?.leading, options?.trailing, options?.maxWait ]

package/src/hooks/use-disabled/index.ts

@@ -32,6 +32,8 @@ import useRefEffect from '../use-ref-effect';
  */
 export default function useDisabled( {
 	isDisabled: isDisabledProp = false,
+}: {
+	isDisabled?: boolean;
 } = {} ) {
 	return useRefEffect(
 		( node ) => {
@@ -45,7 +47,7 @@ export default function useDisabled( {
 			}
 
 			/** A variable keeping track of the previous updates in order to restore them. */
-			const updates: Function[] = [];
+			const updates: ( () => void )[] = [];
 			const disable = () => {
 				node.childNodes.forEach( ( child ) => {
 					if ( ! ( child instanceof defaultView.HTMLElement ) ) {

package/src/hooks/use-dragging/index.ts

@@ -0,0 +1,78 @@
+/**
+ * WordPress dependencies
+ */
+import { useCallback, useEffect, useRef, useState } from '@wordpress/element';
+
+/**
+ * Internal dependencies
+ */
+import useIsomorphicLayoutEffect from '../use-isomorphic-layout-effect';
+import type { DraggingProps, DraggingReturn } from './types';
+
+/**
+ * Hook to manage drag events with proper event handling
+ *
+ * @param props             Drag handlers
+ * @param props.onDragStart
+ * @param props.onDragMove
+ * @param props.onDragEnd
+ * @return Drag state and handlers
+ */
+export default function useDragging( {
+	onDragStart,
+	onDragMove,
+	onDragEnd,
+}: DraggingProps ): DraggingReturn {
+	const [ isDragging, setIsDragging ] = useState( false );
+
+	const eventsRef = useRef< DraggingProps >( {
+		onDragStart,
+		onDragMove,
+		onDragEnd,
+	} );
+	useIsomorphicLayoutEffect( () => {
+		eventsRef.current.onDragStart = onDragStart;
+		eventsRef.current.onDragMove = onDragMove;
+		eventsRef.current.onDragEnd = onDragEnd;
+	}, [ onDragStart, onDragMove, onDragEnd ] );
+
+	const onMouseMove = useCallback( ( event: MouseEvent ): void => {
+		eventsRef.current.onDragMove?.( event );
+	}, [] );
+
+	const endDrag = useCallback(
+		function endDrag( event?: MouseEvent ): void {
+			eventsRef.current.onDragEnd?.( event );
+			document.removeEventListener( 'mousemove', onMouseMove );
+			document.removeEventListener( 'mouseup', endDrag );
+			setIsDragging( false );
+		},
+		[ onMouseMove ]
+	);
+
+	const startDrag = useCallback(
+		( event: React.MouseEvent ): void => {
+			eventsRef.current.onDragStart?.( event );
+			document.addEventListener( 'mousemove', onMouseMove );
+			document.addEventListener( 'mouseup', endDrag );
+			setIsDragging( true );
+		},
+		[ onMouseMove, endDrag ]
+	);
+
+	// Remove the global events when unmounting if needed.
+	useEffect( () => {
+		return () => {
+			if ( isDragging ) {
+				document.removeEventListener( 'mousemove', onMouseMove );
+				document.removeEventListener( 'mouseup', endDrag );
+			}
+		};
+	}, [ isDragging, onMouseMove, endDrag ] );
+
+	return {
+		startDrag,
+		endDrag,
+		isDragging,
+	};
+}

package/src/hooks/use-dragging/types.ts

@@ -0,0 +1,11 @@
+export interface DraggingProps {
+	onDragStart?: ( e: React.MouseEvent ) => void;
+	onDragMove?: ( e: MouseEvent ) => void;
+	onDragEnd?: ( e?: MouseEvent ) => void;
+}
+
+export interface DraggingReturn {
+	startDrag: ( e: React.MouseEvent ) => void;
+	endDrag: ( e?: MouseEvent ) => void;
+	isDragging: boolean;
+}