api-core-lib 12.11.4 → 12.12.4

package/dist/index.d.mts

@@ -211,14 +211,6 @@ interface ApiModuleConfig<TActions extends Record<string, ActionConfigModule<any
     baseEndpoint: string;
     actions: TActions;
 }
-/** @description Configuration options passed directly to the `useApiModule` hook. */
-interface UseApiModuleOptions {
-    onSuccess?: (actionName: string, message: string, data: unknown) => void;
-    onError?: (actionName: string, message: string, error?: ApiError | null) => void;
-    refetchOnWindowFocus?: boolean;
-    pathParams?: Record<string, any>;
-    enabled?: boolean;
-}
 /** A utility type to infer the Input type (`TInput`) from an ActionConfigModule. */
 type InputOf<TActionConfig> = TActionConfig extends ActionConfigModule<infer TInput, any> ? TInput : never;
 /** A utility type to infer the Output type (`TOutput`) from an ActionConfigModule. */
@@ -244,6 +236,24 @@ type ModuleActions<TActions extends Record<string, ActionConfigModule<any, any>>
 type ModuleStates<TActions extends Record<string, ActionConfigModule<any, any>>> = {
     [K in keyof TActions]: ActionState<OutputOf<TActions[K]>>;
 };
+/** @description Configuration options passed directly to the `useApiModule` hook. */
+interface UseApiModuleOptions {
+    onSuccess?: (actionName: string, message: string, data: unknown) => void;
+    onError?: (actionName: string, message: string, error?: ApiError | null) => void;
+    refetchOnWindowFocus?: boolean;
+    pathParams?: Record<string, any>;
+    enabled?: boolean;
+}
+/** @description Configuration options passed directly to the `useApiModule` hook. */
+interface UseApiModuleOptions {
+    onSuccess?: (actionName: string, message: string, data: unknown) => void;
+    onError?: (actionName: string, message: string, error?: ApiError | null) => void;
+    refetchOnWindowFocus?: boolean;
+    pathParams?: Record<string, any>;
+    enabled?: boolean;
+    /** [NEW.............] The dehydrated state string from the server to avoid re-fetching on the client. */
+    hydratedState?: string;
+}
 /** @description The complete, fully-typed return object of the `useApiModule` hook. */
 interface UseApiModuleReturn<TActions extends Record<string, ActionConfigModule<any, any>>> {
     states: ModuleStates<TActions>;
@@ -254,6 +264,18 @@ interface UseApiModuleReturn<TActions extends Record<string, ActionConfigModule<
         } ? UseApiQuery : never;
     };
 }
+/** @description The complete, fully-typed return object of the `useApiModule` hook. */
+interface UseApiModuleReturn<TActions extends Record<string, ActionConfigModule<any, any>>> {
+    states: ModuleStates<TActions>;
+    actions: ModuleActions<TActions>;
+    queries: {
+        [K in keyof TActions]?: TActions[K] extends {
+            hasQuery: true;
+        } ? UseApiQuery : never;
+    };
+    /** [NEW.............] A function to serialize the current state of all queries in the hook's scope to a JSON string. */
+    dehydrate: () => string;
+}
 
 /**
  * A factory function to create a reusable set of API services for a specific endpoint.
@@ -489,6 +511,18 @@ declare class GlobalStateManager {
    * @example invalidateByPrefix('myModule/list::') سيبطل كل صفحات القائمة.
    */
     invalidateByPrefix(prefix: string): void;
+    /**
+   * Serializes the current state of the query store into a JSON string.
+   * This is used on the server to pass the initial state to the client.
+   * @returns A JSON string representing the dehydrated state.
+   */
+    dehydrate(): string;
+    /**
+     * Merges a dehydrated state object into the current store.
+     * This is used on the client to hydrate the state received from the server.
+     * @param hydratedState - A JSON string from the `dehydrate` method.
+     */
+    rehydrate(hydratedState: string): void;
 }
 declare const globalStateManager: GlobalStateManager;
 

package/dist/index.d.ts

@@ -211,14 +211,6 @@ interface ApiModuleConfig<TActions extends Record<string, ActionConfigModule<any
     baseEndpoint: string;
     actions: TActions;
 }
-/** @description Configuration options passed directly to the `useApiModule` hook. */
-interface UseApiModuleOptions {
-    onSuccess?: (actionName: string, message: string, data: unknown) => void;
-    onError?: (actionName: string, message: string, error?: ApiError | null) => void;
-    refetchOnWindowFocus?: boolean;
-    pathParams?: Record<string, any>;
-    enabled?: boolean;
-}
 /** A utility type to infer the Input type (`TInput`) from an ActionConfigModule. */
 type InputOf<TActionConfig> = TActionConfig extends ActionConfigModule<infer TInput, any> ? TInput : never;
 /** A utility type to infer the Output type (`TOutput`) from an ActionConfigModule. */
@@ -244,6 +236,24 @@ type ModuleActions<TActions extends Record<string, ActionConfigModule<any, any>>
 type ModuleStates<TActions extends Record<string, ActionConfigModule<any, any>>> = {
     [K in keyof TActions]: ActionState<OutputOf<TActions[K]>>;
 };
+/** @description Configuration options passed directly to the `useApiModule` hook. */
+interface UseApiModuleOptions {
+    onSuccess?: (actionName: string, message: string, data: unknown) => void;
+    onError?: (actionName: string, message: string, error?: ApiError | null) => void;
+    refetchOnWindowFocus?: boolean;
+    pathParams?: Record<string, any>;
+    enabled?: boolean;
+}
+/** @description Configuration options passed directly to the `useApiModule` hook. */
+interface UseApiModuleOptions {
+    onSuccess?: (actionName: string, message: string, data: unknown) => void;
+    onError?: (actionName: string, message: string, error?: ApiError | null) => void;
+    refetchOnWindowFocus?: boolean;
+    pathParams?: Record<string, any>;
+    enabled?: boolean;
+    /** [NEW.............] The dehydrated state string from the server to avoid re-fetching on the client. */
+    hydratedState?: string;
+}
 /** @description The complete, fully-typed return object of the `useApiModule` hook. */
 interface UseApiModuleReturn<TActions extends Record<string, ActionConfigModule<any, any>>> {
     states: ModuleStates<TActions>;
@@ -254,6 +264,18 @@ interface UseApiModuleReturn<TActions extends Record<string, ActionConfigModule<
         } ? UseApiQuery : never;
     };
 }
+/** @description The complete, fully-typed return object of the `useApiModule` hook. */
+interface UseApiModuleReturn<TActions extends Record<string, ActionConfigModule<any, any>>> {
+    states: ModuleStates<TActions>;
+    actions: ModuleActions<TActions>;
+    queries: {
+        [K in keyof TActions]?: TActions[K] extends {
+            hasQuery: true;
+        } ? UseApiQuery : never;
+    };
+    /** [NEW.............] A function to serialize the current state of all queries in the hook's scope to a JSON string. */
+    dehydrate: () => string;
+}
 
 /**
  * A factory function to create a reusable set of API services for a specific endpoint.
@@ -489,6 +511,18 @@ declare class GlobalStateManager {
    * @example invalidateByPrefix('myModule/list::') سيبطل كل صفحات القائمة.
    */
     invalidateByPrefix(prefix: string): void;
+    /**
+   * Serializes the current state of the query store into a JSON string.
+   * This is used on the server to pass the initial state to the client.
+   * @returns A JSON string representing the dehydrated state.
+   */
+    dehydrate(): string;
+    /**
+     * Merges a dehydrated state object into the current store.
+     * This is used on the client to hydrate the state received from the server.
+     * @param hydratedState - A JSON string from the `dehydrate` method.
+     */
+    rehydrate(hydratedState: string): void;
 }
 declare const globalStateManager: GlobalStateManager;