@siberiacancode/reactuse 0.1.0 → 0.1.1

package/dist/types/hooks/useDropZone/useDropZone.d.ts

@@ -0,0 +1,80 @@
+import { HookTarget } from '../../utils/helpers';
+import { StateRef } from '../useRefState/useRefState';
+export type DropZoneDataTypes = ((types: string[]) => boolean) | string[];
+export interface UseDropZoneOptions {
+    /** The data types for drop zone */
+    dataTypes?: DropZoneDataTypes;
+    /** The multiple mode for drop zone */
+    multiple?: boolean;
+    /** The on drop callback */
+    onDrop?: (files: File[] | null, event: DragEvent) => void;
+    /** The on enter callback */
+    onEnter?: (event: DragEvent) => void;
+    /** The on leave callback */
+    onLeave?: (event: DragEvent) => void;
+    /** The on over callback */
+    onOver?: (event: DragEvent) => void;
+}
+export interface UseDropZoneReturn {
+    /** The files that was dropped in drop zone */
+    files: File[] | null;
+    /** The over drop zone status */
+    overed: boolean;
+}
+export interface UseDropZone {
+    (target: HookTarget, callback?: (files: File[] | null, event: DragEvent) => void): UseDropZoneReturn;
+    <Target extends Element>(callback?: (files: File[] | null, event: DragEvent) => void, target?: never): UseDropZoneReturn & {
+        ref: StateRef<Target>;
+    };
+    (target: HookTarget, options?: UseDropZoneOptions): UseDropZoneReturn;
+    <Target extends Element>(options?: UseDropZoneOptions, target?: never): UseDropZoneReturn & {
+        ref: StateRef<Target>;
+    };
+}
+/**
+ * @name useDropZone
+ * @description - Hook that provides drop zone functionality
+ * @category Elements
+ *
+ * @overload
+ * @template Target The target element
+ * @param {Target} target The target element drop zone's
+ * @param {DataTypes} [options.dataTypes] The data types
+ * @param {boolean} [options.multiple] The multiple mode
+ * @param {(files: File[] | null, event: DragEvent) => void} [options.onDrop] The on drop callback function
+ * @param {(event: DragEvent) => void} [options.onEnter] The on enter callback function
+ * @param {(event: DragEvent) => void} [options.onLeave] The on leave callback function
+ * @param {(event: DragEvent) => void} [options.onOver] The on over callback function
+ * @returns {[boolean, File[] | null]} The object with drop zone states
+ *
+ * @example
+ * const { overed, files } = useDropZone(ref, options);
+ *
+ * @overload
+ * @param {Target} target The target element drop zone's
+ * @param {(files: File[] | null, event: DragEvent) => void} [callback] The callback function to be invoked on drop
+ * @returns {[boolean, File[] | null]} The object with drop zone states
+ *
+ * @example
+ * const { overed, files } = useDropZone(ref, () => console.log('callback'));
+ *
+ * @overload
+ * @param {DataTypes} [options.dataTypes] The data types
+ * @param {boolean} [options.multiple] The multiple mode
+ * @param {(files: File[] | null, event: DragEvent) => void} [options.onDrop] The on drop callback function
+ * @param {(event: DragEvent) => void} [options.onEnter] The on enter callback function
+ * @param {(event: DragEvent) => void} [options.onLeave] The on leave callback function
+ * @param {(event: DragEvent) => void} [options.onOver] The on over callback function
+ * @returns {[StateRef<Target>, boolean, File[] | null]} The object with drop zone states and ref
+ *
+ * @example
+ * const { ref, overed, files } = useDropZone(options);
+ *
+ * @overload
+ * @param {(files: File[] | null, event: DragEvent) => void} [callback] The callback function to be invoked on drop
+ * @returns {[StateRef<Target>, boolean, File[] | null]} The object with drop zone states and ref
+ *
+ * @example
+ * const { ref, overed, files } = useDropZone(() => console.log('callback'));
+ */
+export declare const useDropZone: UseDropZone;

package/dist/types/hooks/useEventSource/useEventSource.d.ts

@@ -0,0 +1,47 @@
+/** The use event source options type */
+export interface UseEventSourceOptions<QueryData, Data> extends EventSourceInit {
+    /** Immediately open the connection when calling this hook */
+    immediately?: boolean;
+    placeholderData?: (() => Data) | Data;
+    retry?: boolean | number;
+    retryDelay?: ((retry: number, event: Event) => number) | number;
+    onError?: (error: Event) => void;
+    onMessage?: (event: Event & {
+        data?: Data;
+    }) => void;
+    onOpen?: () => void;
+    select?: (data: QueryData) => Data;
+}
+/** The use event source return type */
+interface UseEventSourceReturn<Data = any> {
+    /** The latest data received via the EventSource */
+    data?: Data;
+    /** The current error */
+    error?: Event;
+    /** The instance of the EventSource */
+    instance?: EventSource;
+    isConnecting: boolean;
+    isError: boolean;
+    isOpen: boolean;
+    /** Closes the EventSource connection gracefully */
+    close: () => void;
+    /** Reopen the EventSource connection */
+    open: () => void;
+}
+/**
+ * @name useEventSource
+ * @description - Hook that provides a reactive wrapper for event source
+ * @category Browser
+ *
+ * @browserapi EventSource https://developer.mozilla.org/en-US/docs/Web/API/EventSource
+ *
+ * @param {string | URL} url The URL of the EventSource
+ * @param {string[]} [events=[]] List of events to listen to
+ * @param {UseEventSourceOptions} [options={}] Configuration options
+ * @returns {UseEventSourceReturn<Data>} The EventSource state and controls
+ *
+ * @example
+ * const { instance, data, isConnecting, isOpen, isError, close, open } = useEventSource('url', ['message']);
+ */
+export declare const useEventSource: <QueryData = any, Data = QueryData>(url: string | URL, events?: string[], options?: UseEventSourceOptions<QueryData, Data>) => UseEventSourceReturn<Data>;
+export {};

package/dist/types/hooks/useHover/useHover.d.ts

@@ -7,11 +7,18 @@ export interface UseHoverOptions {
     /** The on leave callback */
     onLeave?: (event: Event) => void;
 }
+export interface UseHoverReturn {
+    value: boolean;
+}
 export interface UseHover {
     (target: HookTarget, callback?: (event: Event) => void): boolean;
     (target: HookTarget, options?: UseHoverOptions): boolean;
-    <Target extends Element>(callback?: (event: Event) => void, target?: never): [StateRef<Target>, boolean];
-    <Target extends Element>(options?: UseHoverOptions, target?: never): [StateRef<Target>, boolean];
+    <Target extends Element>(callback?: (event: Event) => void, target?: never): {
+        ref: StateRef<Target>;
+    } & UseHoverReturn;
+    <Target extends Element>(options?: UseHoverOptions, target?: never): {
+        ref: StateRef<Target>;
+    } & UseHoverReturn;
 }
 /**
  * @name useHover
@@ -38,7 +45,7 @@ export interface UseHover {
  * @overload
  * @template Target The target element
  * @param {(event: Event) => void} [callback] The callback function to be invoked on mouse enter
- * @returns {UseHoverReturn<Target>} The state of the hover
+ * @returns {{ ref: StateRef<Target> } & UseHoverReturn} The state of the hover
  *
  * @example
  * const [ref, hovering] = useHover(() => console.log('callback'));
@@ -47,7 +54,7 @@ export interface UseHover {
  * @template Target The target element
  * @param {(event: Event) => void} [options.onEntry] The callback function to be invoked on mouse enter
  * @param {(event: Event) => void} [options.onLeave] The callback function to be invoked on mouse leave
- * @returns {UseHoverReturn<Target>} The state of the hover
+ * @returns {{ ref: StateRef<Target> } & UseHoverReturn} The state of the hover
  *
  * @example
  * const [ref, hovering] = useHover(options);

package/dist/types/hooks/useQuery/useQuery.d.ts

@@ -1,7 +1,6 @@
 import { DependencyList } from 'react';
 export interface UseQueryOptions<QueryData, Data> {
     enabled?: boolean;
-    initialData?: (() => Data) | Data;
     keys?: DependencyList;
     placeholderData?: (() => Data) | Data;
     refetchInterval?: number;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@siberiacancode/reactuse",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "The ultimate collection of react hooks",
   "author": {
     "name": "SIBERIA CAN CODE 🧊",
@@ -81,11 +81,7 @@
     "vitest": "^3.1.2"
   },
   "lint-staged": {
-    "*.js": [
-      "eslint --fix",
-      "prettier --write"
-    ],
-    "*.ts": [
+    "*.{js,ts,tsx}": [
       "eslint --fix",
       "prettier --write"
     ]