jsdocs updates for interfaces

src/addons/useCookieImplementation.ts

@@ -1,29 +1,8 @@
-import { Paths, GetValueByPath, CookieConfig } from "@/definition";
-import { Portal } from "@/subject";
+import { Paths, GetValueByPath, UseCookieImplementation } from "@/definition";
 
 import { cookieStorage } from "../component";
 import { usePortalImplementation } from "./usePortalImplementation";
 
-/**
- * Represents the properties of the `useCookieImplementation` hook.
- *
- * @template Store The type of the store.
- * @template Path The type of the path.
- * @template State The type of the state.
- * @template Data The type of the data.
- */
-interface UseCookieImplementation<
-  Store extends Record<string, any>,
-  Path extends Paths<Store>,
-  State extends GetValueByPath<Store, Path>,
-  Data
-> {
-  path: Path;
-  portal: Portal;
-  initialState: State;
-  config?: CookieConfig<State, Data>;
-}
-
 /**
  * A hook for managing the portal states with cookie storage.
  *

src/addons/useLocalImplementation.ts

@@ -1,20 +1,6 @@
-import { Config, GetValueByPath, Paths } from "@/definition";
-import { Portal } from "@/subject";
-
+import { GetValueByPath, Paths, UseLocalImplementation } from "@/definition";
 import { usePortalImplementation } from "./usePortalImplementation";
 
-interface UseLocalImplementation<
-  Store extends Record<string, any>,
-  Path extends Paths<Store>,
-  State extends GetValueByPath<Store, Path>,
-  Data
-> {
-  path: Path;
-  portal: Portal;
-  config?: Config<State, Data>;
-  initialState: State;
-}
-
 /**
  * A hook for managing the portal states with local storage.
  *

src/addons/useSessionImplementation.ts

@@ -1,20 +1,6 @@
-import { Paths, GetValueByPath, Config } from "@/definition";
-import { Portal } from "@/subject";
-
+import { Paths, GetValueByPath, UseSessionImplementation } from "@/definition";
 import { usePortalImplementation } from "./usePortalImplementation";
 
-interface UseSessionImplementation<
-  Store extends Record<string, any>,
-  Path extends Paths<Store>,
-  State extends GetValueByPath<Store, Path>,
-  Data
-> {
-  path: Path;
-  portal: Portal;
-  initialState: State;
-  config?: Config<State, Data>;
-}
-
 /**
  * A hook for managing the portal states with session storage.
  *

src/definition/cookie.ts

@@ -56,6 +56,9 @@ export type CookieEntry = CookieOptions & {
   value: string;
 };
 
+/**
+ * Represents the cookie storage.
+ */
 export interface CookieStorage extends Storage {
   /**
    * Retrieves the value of the cookie with the specified name from the document.cookie.

src/definition/portal.ts

@@ -6,6 +6,9 @@ import { CookieOptions } from "./cookie";
 export type GetState<State> = (state: State) => State;
 export type SetStore<State> = (value: State) => void;
 
+/**
+ * Represents the options for the portal.
+ */
 export type PortalOptions<State, Data> = {
   /**
    * The initial value of the portal.
@@ -46,6 +49,12 @@ export type PortalOptions<State, Data> = {
   get?: GetState<State>;
 };
 
+/**
+ * Represents the config for the portal.
+ *
+ * @template State The type of the state.
+ * @template Data The type of the data.
+ */
 export interface Config<State, Data>
   extends Omit<PortalOptions<State, Data>, "set" | "get"> {
   /**
@@ -75,13 +84,24 @@ export interface Config<State, Data>
   get?: (value: string) => State;
 }
 
+/**
+ * Represents the config for the cookie portal.
+ *
+ * @template State The type of the state.
+ * @template Data The type of the data.
+ */
 export interface CookieConfig<State, Data> extends Config<State, Data> {
   /**
    * The options for the cookie.
    */
   cookieOptions?: CookieOptions;
 }
 
+/**
+ * Represents the value of a portal entry.
+ *
+ * @template State The type of the state.
+ */
 export type PortalValue<State> = {
   /**
    * The BehaviorSubject that contains the current value of the store.
@@ -130,9 +150,23 @@ export type Paths<Base, Delimiter extends string = "."> = Base extends Record<
     }[Keys]
   : never;
 
+/**
+ * Represents the value of a key in a store.
+ *
+ * @template Key The type of the key.
+ */
 export type ParseAsNumber<Key extends string | number> =
   Key extends `${infer Value extends number}` ? Value : Key;
 
+/**
+ * Represents the value at a path in a store.
+ *
+ * @template T The type of the store.
+ * @template Path The type of the path.
+ * @template Delimiter The type of the delimiter.
+ *
+ * @description It is a union of all the possible values in the store.
+ */
 export type GetValueByPath<
   T,
   Path extends string | number,
@@ -228,3 +262,63 @@ export interface UsePortal<Store extends Record<string, any>> {
     config?: CookieConfig<State, Data>
   ): PortalState<State, Data>;
 }
+
+/**
+ * Represents the properties of the `useLocalImplementation` hook.
+ *
+ * @template State The type of the state.
+ * @template Path The type of the path.
+ * @template Store The type of the store.
+ * @template Data The type of the data.
+ */
+export interface UseLocalImplementation<
+  Store extends Record<string, any>,
+  Path extends Paths<Store>,
+  State extends GetValueByPath<Store, Path>,
+  Data
+> {
+  path: Path;
+  portal: Portal;
+  config?: Config<State, Data>;
+  initialState: State;
+}
+
+/**
+ * Represents the properties of the `useSessionImplementation` hook.
+ *
+ * @template State The type of the state.
+ * @template Path The type of the path.
+ * @template Store The type of the store.
+ * @template Data The type of the data.
+ */
+export interface UseSessionImplementation<
+  Store extends Record<string, any>,
+  Path extends Paths<Store>,
+  State extends GetValueByPath<Store, Path>,
+  Data
+> {
+  path: Path;
+  portal: Portal;
+  initialState: State;
+  config?: Config<State, Data>;
+}
+
+/**
+ * Represents the properties of the `useCookieImplementation` hook.
+ *
+ * @template Store The type of the store.
+ * @template Path The type of the path.
+ * @template State The type of the state.
+ * @template Data The type of the data.
+ */
+export interface UseCookieImplementation<
+  Store extends Record<string, any>,
+  Path extends Paths<Store>,
+  State extends GetValueByPath<Store, Path>,
+  Data
+> {
+  path: Path;
+  portal: Portal;
+  initialState: State;
+  config?: CookieConfig<State, Data>;
+}