@donotdev/core 0.0.12 → 0.0.13

package/index.d.ts

@@ -21819,6 +21819,15 @@ interface UseViewportVisibilityReturn {
  */
 declare function useViewportVisibility(options?: UseViewportVisibilityOptions): UseViewportVisibilityReturn;
 
+/**
+ * @fileoverview useAddOrUpdate hook
+ * @description Generic hook for creating or updating entities
+ *
+ * @version 0.0.1
+ * @since 0.0.1
+ * @author AMBROISE PARK Consulting
+ */
+
 /**
  * Hook for creating or updating an entity.
  * If the data contains an 'id' field, it will perform an update; otherwise, a create.
@@ -21856,6 +21865,15 @@ declare function useBreathingTimer({ duration, onComplete, }: UseBreathingTimerP
     onComplete: (() => void) | undefined;
 };
 
+/**
+ * @fileoverview useDelete hook
+ * @description Generic hook for deleting entities by ID
+ *
+ * @version 0.0.1
+ * @since 0.0.1
+ * @author AMBROISE PARK Consulting
+ */
+
 /**
  * Hook for deleting an entity by ID.
  *
@@ -21867,6 +21885,43 @@ declare function useBreathingTimer({ duration, onComplete, }: UseBreathingTimerP
  */
 declare function useDelete<T>(schema: dndevSchema<T>): UseMutationResult<MutationResponse, EntityHookError, string>;
 
+/**
+ * @fileoverview useGet hook for single entity retrieval
+ * @description Generic hook for fetching a single entity by ID with full type safety
+ *
+ * This hook provides a simple, type-safe way to fetch individual entities
+ * from the database using DoNotDev schemas. It handles loading states,
+ * error handling, and caching automatically.
+ *
+ * **Key Features:**
+ * - Type-safe entity retrieval
+ * - Automatic loading and error states
+ * - React Query integration for caching
+ * - Optimistic updates support
+ * - Automatic refetching on focus
+ *
+ * @version 0.0.1
+ * @since 0.0.1
+ * @author AMBROISE PARK Consulting
+ *
+ * **Usage Pattern:**
+ * ```typescript
+ * const { data: product, isLoading, error } = useGet(ProductSchema, productId);
+ *
+ * if (isLoading) return <LoadingSpinner />;
+ * if (error) return <ErrorMessage error={error} />;
+ * if (!product) return <NotFound />;
+ *
+ * return <ProductView product={product} />;
+ * ```
+ *
+ * **Performance:**
+ * - Automatic caching with React Query
+ * - Background refetching for fresh data
+ * - Optimized re-renders
+ * - Memory-efficient cleanup
+ */
+
 /**
  * Hook for fetching a single entity by ID with full type safety
  *