@cyberskill/shared 1.216.0 → 2.0.0

package/dist/react/apollo-client/apollo-client.component.d.ts

@@ -1,3 +1,21 @@
 import { default as React } from 'react';
 import { I_ApolloProviderProps } from './apollo-client.type.js';
-export declare function ApolloProvider({ options, children, }: I_ApolloProviderProps): React.JSX.Element;
+/**
+ * Apollo Provider component that wraps the application with Apollo Client context.
+ * This component provides the Apollo Client instance to all child components,
+ * enabling GraphQL operations throughout the component tree. It includes
+ * error handling and toast integration for a complete GraphQL experience.
+ *
+ * Features:
+ * - Apollo Client context provision
+ * - Error boundary integration
+ * - Toast notification support
+ * - Automatic error handling
+ * - Development and production optimizations
+ *
+ * @param props - Component props containing options and children.
+ * @param props.options - Apollo Client configuration options.
+ * @param props.children - React children that will have access to Apollo Client context.
+ * @returns A React component that provides Apollo Client context to its children.
+ */
+export declare function ApolloProvider({ options, children }: I_ApolloProviderProps): React.JSX.Element;

package/dist/react/apollo-client/apollo-client.component.js

@@ -5,10 +5,7 @@ import { getClient as i } from "./apollo-client.util.js";
 import { ApolloErrorProvider as p } from "../apollo-error/apollo-error.provider.js";
 import { ApolloErrorComponent as a } from "../apollo-error/apollo-error.component.js";
 import { Toaster as c } from "react-hot-toast";
-function s({
-  options: e,
-  children: t
-}) {
+function s({ options: e, children: t }) {
   const o = m(
     () => i(e || {}),
     [e]

package/dist/react/apollo-client/apollo-client.constant.d.ts

@@ -1 +1,6 @@
+/**
+ * Default GraphQL endpoint URI for Apollo Client configuration.
+ * This constant provides the standard GraphQL endpoint path that is commonly used
+ * in web applications for GraphQL API communication.
+ */
 export declare const GRAPHQL_URI_DEFAULT = "/graphql";

package/dist/react/apollo-client/apollo-client.context.d.ts

@@ -1,6 +1,21 @@
 import { ApolloClient, NormalizedCacheObject } from '@apollo/client';
 import { default as React } from 'react';
+/**
+ * React context for providing Apollo Client instance to child components.
+ * This context allows components to access the Apollo Client instance without
+ * prop drilling, enabling direct access to client methods and cache operations.
+ */
 declare const ApolloClientContext: React.Context<ApolloClient<NormalizedCacheObject> | null>;
+/**
+ * Provider component that makes Apollo Client available to the component tree.
+ * This component wraps the Apollo Client instance in a React context, allowing
+ * any child component to access the client using the useApolloClient hook.
+ *
+ * @param props - Component props containing client and children.
+ * @param props.client - The Apollo Client instance to provide to the component tree.
+ * @param props.children - React children that will have access to the Apollo Client context.
+ * @returns A React component that provides Apollo Client context to its children.
+ */
 export declare function ApolloClientProvider({ client, children, }: {
     client: ApolloClient<NormalizedCacheObject>;
     children: React.ReactNode;

package/dist/react/apollo-client/apollo-client.hook.d.ts

@@ -1,2 +1,14 @@
 import { ApolloClient, NormalizedCacheObject } from '@apollo/client';
+/**
+ * React hook that provides access to the Apollo Client instance.
+ * This hook retrieves the Apollo Client from the React context and provides
+ * a convenient way to access client methods, cache operations, and other
+ * Apollo Client functionality within components.
+ *
+ * The hook will throw an error if used outside of an ApolloClientProvider,
+ * ensuring proper context usage and providing clear error messages for debugging.
+ *
+ * @returns The Apollo Client instance from the nearest ApolloClientProvider context.
+ * @throws {Error} When used outside of an ApolloClientProvider context.
+ */
 export declare function useApolloClient(): ApolloClient<NormalizedCacheObject>;

package/dist/react/apollo-client/apollo-client.util.d.ts

@@ -3,9 +3,57 @@ import { Observable } from '@apollo/client/utilities';
 import { ApolloClient } from '@apollo/client/core/core.cjs';
 import { ApolloLink } from '@apollo/client/link/core/core.cjs';
 import { I_ApolloOptions } from './apollo-client.type.js';
+/**
+ * Custom Apollo Link for development logging of GraphQL operations.
+ * This link intercepts GraphQL operations and logs detailed information about
+ * each request including operation name, duration, and request count for debugging
+ * and performance monitoring purposes.
+ *
+ * Features:
+ * - Request counting for tracking operation frequency
+ * - Duration measurement for performance analysis
+ * - Operation name logging for easy identification
+ * - Development-only logging to avoid production noise
+ */
 export declare class DevLoggerLink extends ApolloLink {
     private count;
+    /**
+     * Intercepts and logs GraphQL operations during development.
+     * This method wraps each GraphQL operation with timing and logging functionality,
+     * providing insights into operation performance and frequency.
+     *
+     * @param operation - The GraphQL operation to be logged and executed.
+     * @param forward - Function to forward the operation to the next link in the chain.
+     * @returns An observable that emits the operation result with logging side effects.
+     */
     request(operation: Operation, forward: (op: Operation) => Observable<FetchResult>): Observable<FetchResult>;
 }
+/**
+ * Creates a comprehensive Apollo Link chain with all necessary middleware.
+ * This function sets up a complete Apollo Link chain including error handling,
+ * logging, file uploads, WebSocket subscriptions, and custom links. The chain
+ * is configured to handle both HTTP and WebSocket operations with proper routing.
+ *
+ * The link chain includes:
+ * - Development logging for operation tracking
+ * - Error handling with user-friendly notifications
+ * - Type name removal for cleaner requests
+ * - File upload support
+ * - WebSocket subscription support
+ * - Custom link integration
+ *
+ * @param options - Configuration options for the Apollo Client including URI, WebSocket URL, and custom links.
+ * @returns An array of Apollo Links configured for the specified options.
+ */
 export declare function createApolloLinks(options: I_ApolloOptions): ApolloLink[];
+/**
+ * Creates a fully configured Apollo Client instance.
+ * This function creates an Apollo Client with all necessary configuration including
+ * the link chain, cache, and any additional options provided. The client is ready
+ * for immediate use in React applications with comprehensive error handling and
+ * development tooling.
+ *
+ * @param options - Configuration options for the Apollo Client including links, cache, and other settings.
+ * @returns A fully configured Apollo Client instance ready for use.
+ */
 export declare function getClient(options?: I_ApolloOptions): ApolloClient<import('@apollo/client').NormalizedCacheObject>;

package/dist/react/apollo-client/apollo-client.util.js

@@ -23,6 +23,15 @@ class V extends g {
   constructor() {
     super(...arguments), J(this, "count", 0);
   }
+  /**
+   * Intercepts and logs GraphQL operations during development.
+   * This method wraps each GraphQL operation with timing and logging functionality,
+   * providing insights into operation performance and frequency.
+   *
+   * @param operation - The GraphQL operation to be logged and executed.
+   * @param forward - Function to forward the operation to the next link in the chain.
+   * @returns An observable that emits the operation result with logging side effects.
+   */
   request(e, o) {
     const m = Date.now();
     return this.count += 1, o(e).map((u) => {

package/dist/react/apollo-client-nextjs/apollo-client-nextjs.component.d.ts

@@ -1,3 +1,21 @@
 import { default as React } from 'react';
 import { I_ApolloProviderProps } from '../apollo-client/index.js';
-export declare function ApolloProvider({ options, children, }: I_ApolloProviderProps): React.JSX.Element;
+/**
+ * Next.js Apollo Provider component that wraps the application with Apollo Client context.
+ * This component provides the Apollo Client instance to all child components,
+ * enabling GraphQL operations throughout the component tree. It includes
+ * error handling and toast integration for a complete GraphQL experience.
+ *
+ * Features:
+ * - Apollo Client context provision
+ * - Error boundary integration
+ * - Toast notification support
+ * - Automatic error handling
+ * - Next.js specific optimizations
+ *
+ * @param props - Component props containing options and children.
+ * @param props.options - Apollo Client configuration options.
+ * @param props.children - React children that will have access to Apollo Client context.
+ * @returns A React component that provides Apollo Client context to its children.
+ */
+export declare function ApolloProvider({ options, children }: I_ApolloProviderProps): React.JSX.Element;

package/dist/react/apollo-client-nextjs/apollo-client-nextjs.component.js

@@ -4,10 +4,7 @@ import { getClient as n } from "./apollo-client-nextjs.util.js";
 import { ApolloErrorProvider as p } from "../apollo-error/apollo-error.provider.js";
 import { ApolloErrorComponent as i } from "../apollo-error/apollo-error.component.js";
 import { Toaster as a } from "react-hot-toast";
-function g({
-  options: r,
-  children: o
-}) {
+function g({ options: r, children: o }) {
   const t = m(
     () => () => n(r || {}),
     [r]

package/dist/react/apollo-client-nextjs/apollo-client-nextjs.rsc.d.ts

@@ -1,4 +1,14 @@
 import { I_ApolloOptions } from '../apollo-client/index.js';
+/**
+ * Creates a registered Apollo Client factory for Next.js server components.
+ * This function creates a client factory that is registered with Next.js for
+ * proper server-side rendering support. The factory function ensures that
+ * each request gets its own Apollo Client instance, which is essential for
+ * SSR compatibility and preventing client state leakage between requests.
+ *
+ * @param options - Configuration options for the Apollo Client including URI, WebSocket URL, and custom links.
+ * @returns A registered Apollo Client factory function that can be used with Next.js server components.
+ */
 export declare const makeClient: (options?: I_ApolloOptions) => {
     getClient: () => import('@apollo/client-integration-nextjs').ApolloClient<unknown>;
     query: <T = any, TVariables extends import('@apollo/client').OperationVariables = import('@apollo/client').OperationVariables>(options: import('@apollo/client').QueryOptions<TVariables, T>) => Promise<import('@apollo/client').ApolloQueryResult<import('@apollo/client').MaybeMasked<T>>>;

package/dist/react/apollo-client-nextjs/apollo-client-nextjs.util.d.ts

@@ -1,3 +1,13 @@
 import { ApolloClient } from '@apollo/client-integration-nextjs';
 import { I_ApolloOptions } from '../apollo-client/index.js';
+/**
+ * Creates a Next.js optimized Apollo Client instance.
+ * This function creates an Apollo Client specifically configured for Next.js applications,
+ * using the Next.js integration package for proper server-side rendering support.
+ * The client includes all standard Apollo features like error handling, logging,
+ * file uploads, and WebSocket subscriptions, but is optimized for Next.js environments.
+ *
+ * @param options - Configuration options for the Apollo Client including URI, WebSocket URL, and custom links.
+ * @returns A Next.js optimized Apollo Client instance ready for use in Next.js applications.
+ */
 export declare function getClient(options?: I_ApolloOptions): ApolloClient<unknown>;

package/dist/react/apollo-error/apollo-error.component.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("react"),c=require("./apollo-error.context.cjs"),t=require("./apollo-error.module.scss.cjs");function m(){const o=e.use(c.ApolloErrorContext),r=o==null?void 0:o.error;if(!r)return null;const l=(s,n)=>n!=null&&n.length?e.createElement("div",null,e.createElement("strong",null,s,":"),e.createElement("ul",null,n.map(a=>e.createElement("li",{key:a.message},a.message)))):null;return e.createElement("div",{className:t.default["modal-backdrop"]},e.createElement("div",{className:t.default["modal-content"]},e.createElement("button",{type:"button",className:t.default["btn-close"],onClick:o.hideError},"✕"),e.createElement("div",{className:t.default["error-title"]},e.createElement("button",{type:"button",className:t.default["btn-retry"],onClick:()=>window.location.reload()},"Reload")," ",r.message),e.createElement("div",{className:t.default["error-details"]},r.networkError&&e.createElement("pre",{className:"network"},e.createElement("strong",null,"Network Error:")," ",r.networkError.message),l("GraphQL Errors",[...r.graphQLErrors]),l("Protocol Errors",[...r.protocolErrors]),l("Client Errors",[...r.clientErrors]),r.extraInfo&&e.createElement("pre",{className:"extra"},e.createElement("strong",null,"Extra Info:")," ",JSON.stringify(r.extraInfo,null,4)))))}exports.ApolloErrorComponent=m;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("react"),a=require("./apollo-error.context.cjs"),t=require("./apollo-error.module.scss.cjs");function l(o,r){return r!=null&&r.length?e.createElement("div",null,e.createElement("strong",null,o,":"),e.createElement("ul",null,r.map(n=>e.createElement("li",{key:n.message},n.message)))):null}function c(){const o=e.use(a.ApolloErrorContext),r=o==null?void 0:o.error;return r?e.createElement("div",{className:t.default["modal-backdrop"]},e.createElement("div",{className:t.default["modal-content"]},e.createElement("button",{type:"button",className:t.default["btn-close"],onClick:o.hideError},"✕"),e.createElement("div",{className:t.default["error-title"]},e.createElement("button",{type:"button",className:t.default["btn-retry"],onClick:()=>window.location.reload()},"Reload")," ",r.message),e.createElement("div",{className:t.default["error-details"]},r.networkError&&e.createElement("pre",{className:"network"},e.createElement("strong",null,"Network Error:")," ",r.networkError.message),l("GraphQL Errors",[...r.graphQLErrors]),l("Protocol Errors",[...r.protocolErrors]),l("Client Errors",[...r.clientErrors]),r.extraInfo&&e.createElement("pre",{className:"extra"},e.createElement("strong",null,"Extra Info:")," ",JSON.stringify(r.extraInfo,null,4))))):null}exports.ApolloErrorComponent=c;

package/dist/react/apollo-error/apollo-error.component.d.ts

@@ -1,2 +1,19 @@
 import { default as React } from 'react';
+/**
+ * Apollo Error Component that displays detailed error information in a modal.
+ * This component provides a comprehensive error display interface that shows
+ * all types of Apollo errors including GraphQL errors, network errors, protocol
+ * errors, and client errors. It includes a reload button for recovery and
+ * detailed error information for debugging purposes.
+ *
+ * Features:
+ * - Modal overlay with backdrop for focus
+ * - Detailed error categorization and display
+ * - Reload functionality for error recovery
+ * - Close button to dismiss the error modal
+ * - Structured display of different error types
+ * - Extra information display for debugging
+ *
+ * @returns A modal component displaying Apollo error details, or null if no error is present.
+ */
 export declare function ApolloErrorComponent(): React.JSX.Element | null;

package/dist/react/apollo-error/apollo-error.component.js

@@ -1,12 +1,12 @@
-import e, { use as c } from "react";
-import { ApolloErrorContext as m } from "./apollo-error.context.js";
+import e, { use as a } from "react";
+import { ApolloErrorContext as s } from "./apollo-error.context.js";
 import t from "./apollo-error.module.scss.js";
-function d() {
-  const o = c(m), r = o == null ? void 0 : o.error;
-  if (!r)
-    return null;
-  const l = (s, n) => n != null && n.length ? /* @__PURE__ */ e.createElement("div", null, /* @__PURE__ */ e.createElement("strong", null, s, ":"), /* @__PURE__ */ e.createElement("ul", null, n.map((a) => /* @__PURE__ */ e.createElement("li", { key: a.message }, a.message)))) : null;
-  return /* @__PURE__ */ e.createElement("div", { className: t["modal-backdrop"] }, /* @__PURE__ */ e.createElement("div", { className: t["modal-content"] }, /* @__PURE__ */ e.createElement(
+function n(o, r) {
+  return r != null && r.length ? /* @__PURE__ */ e.createElement("div", null, /* @__PURE__ */ e.createElement("strong", null, o, ":"), /* @__PURE__ */ e.createElement("ul", null, r.map((l) => /* @__PURE__ */ e.createElement("li", { key: l.message }, l.message)))) : null;
+}
+function i() {
+  const o = a(s), r = o == null ? void 0 : o.error;
+  return r ? /* @__PURE__ */ e.createElement("div", { className: t["modal-backdrop"] }, /* @__PURE__ */ e.createElement("div", { className: t["modal-content"] }, /* @__PURE__ */ e.createElement(
     "button",
     {
       type: "button",
@@ -22,8 +22,8 @@ function d() {
       onClick: () => window.location.reload()
     },
     "Reload"
-  ), " ", r.message), /* @__PURE__ */ e.createElement("div", { className: t["error-details"] }, r.networkError && /* @__PURE__ */ e.createElement("pre", { className: "network" }, /* @__PURE__ */ e.createElement("strong", null, "Network Error:"), " ", r.networkError.message), l("GraphQL Errors", [...r.graphQLErrors]), l("Protocol Errors", [...r.protocolErrors]), l("Client Errors", [...r.clientErrors]), r.extraInfo && /* @__PURE__ */ e.createElement("pre", { className: "extra" }, /* @__PURE__ */ e.createElement("strong", null, "Extra Info:"), " ", JSON.stringify(r.extraInfo, null, 4)))));
+  ), " ", r.message), /* @__PURE__ */ e.createElement("div", { className: t["error-details"] }, r.networkError && /* @__PURE__ */ e.createElement("pre", { className: "network" }, /* @__PURE__ */ e.createElement("strong", null, "Network Error:"), " ", r.networkError.message), n("GraphQL Errors", [...r.graphQLErrors]), n("Protocol Errors", [...r.protocolErrors]), n("Client Errors", [...r.clientErrors]), r.extraInfo && /* @__PURE__ */ e.createElement("pre", { className: "extra" }, /* @__PURE__ */ e.createElement("strong", null, "Extra Info:"), " ", JSON.stringify(r.extraInfo, null, 4))))) : null;
 }
 export {
-  d as ApolloErrorComponent
+  i as ApolloErrorComponent
 };

package/dist/react/apollo-error/apollo-error.hook.d.ts

@@ -1 +1,13 @@
+/**
+ * React hook that provides access to Apollo error context.
+ * This hook retrieves the Apollo error context which contains the current error state
+ * and methods to show or hide errors. It provides a convenient way to access error
+ * handling functionality within components.
+ *
+ * The hook will throw an error if used outside of an ApolloErrorProvider,
+ * ensuring proper context usage and providing clear error messages for debugging.
+ *
+ * @returns The Apollo error context containing error state and control methods.
+ * @throws {Error} When used outside of an ApolloErrorProvider context.
+ */
 export declare function useApolloError(): import('./apollo-error.type.js').I_ApolloErrorContext;

package/dist/react/apollo-error/apollo-error.provider.d.ts

@@ -1,4 +1,19 @@
 import { ReactNode, default as React } from 'react';
+/**
+ * Provider component that manages Apollo error state and provides error context.
+ * This component sets up error handling for Apollo Client operations and provides
+ * error state management to all child components through React context.
+ *
+ * Features:
+ * - Global Apollo error state management
+ * - Error context provision to child components
+ * - Automatic error handling and display
+ * - Integration with error boundaries
+ *
+ * @param props - Component props containing children.
+ * @param props.children - React children that will have access to the error context.
+ * @returns A React component that provides Apollo error context to its children.
+ */
 export declare function ApolloErrorProvider({ children }: {
     children: ReactNode;
 }): React.JSX.Element;

package/dist/react/apollo-error/apollo-error.util.d.ts

@@ -1,3 +1,20 @@
 import { ApolloError } from '@apollo/client';
+/**
+ * Sets the global callback function for Apollo error handling.
+ * This function registers a callback that will be called whenever a global
+ * Apollo error needs to be displayed. The callback is typically set by the
+ * ApolloErrorProvider component and used throughout the application for
+ * consistent error handling.
+ *
+ * @param callback - The function to be called when a global Apollo error occurs.
+ */
 export declare function setGlobalApolloErrorCallback(callback: (err: ApolloError) => void): void;
+/**
+ * Displays a global Apollo error using the registered callback.
+ * This function triggers the global error display system by calling the
+ * registered callback function. If no callback is registered, the function
+ * does nothing, providing safe error handling even when the provider is not set up.
+ *
+ * @param error - The Apollo error to display globally.
+ */
 export declare function showGlobalApolloError(error: ApolloError): void;

package/dist/react/i18next/i18next.hook.d.ts

@@ -1,2 +1,11 @@
 import { useTranslation } from 'react-i18next';
+/**
+ * React hook that provides i18next translation functionality.
+ * This hook is a wrapper around react-i18next's useTranslation hook,
+ * providing access to translation functions and current language information.
+ * It enables internationalization features including text translation,
+ * language switching, and pluralization support.
+ *
+ * @returns The useTranslation hook result with translation functions and language information.
+ */
 export declare const useTranslateI18next: typeof useTranslation;

package/dist/react/i18next/i18next.util.d.ts

@@ -1,2 +1,12 @@
 import { InitOptions } from 'i18next';
+/**
+ * Initializes i18next with React integration.
+ * This function sets up i18next for use with React applications by configuring
+ * the react-i18next plugin and initializing the i18next instance with the provided
+ * options. It enables internationalization features including translation,
+ * language detection, and pluralization rules.
+ *
+ * @param options - Configuration options for i18next initialization including languages, namespaces, and plugins.
+ * @returns A promise that resolves when i18next initialization is complete.
+ */
 export declare function initI18next(options: InitOptions): Promise<import('i18next').TFunction<"translation", undefined>>;

package/dist/react/loading/loading.component.d.ts

@@ -1,3 +1,24 @@
 import { default as React } from 'react';
 import { I_LoadingProps } from './loading.type.js';
+/**
+ * Loading component that displays animated loading indicators.
+ * This component provides a customizable loading interface with animated rings
+ * and optional full-screen overlay. It includes features for preventing user
+ * interaction during loading states and supports both inline and full-screen modes.
+ *
+ * Features:
+ * - Animated loading rings with multiple colors
+ * - Full-screen overlay mode with scroll prevention
+ * - Context menu prevention during full-screen loading
+ * - Customizable loading message
+ * - Responsive design with CSS modules
+ * - Accessibility considerations with reduced motion support
+ *
+ * @param props - Component props containing loading configuration.
+ * @param props.full - Whether to display the loading indicator in full-screen mode (default: false).
+ * @param props.className - Additional CSS classes to apply to the loading container.
+ * @param props.message - Custom message to display below the loading animation.
+ * @param props.rest - Additional props to spread to the loading container.
+ * @returns A React component displaying the loading animation with optional full-screen overlay.
+ */
 export declare function Loading({ full, className, message, ...rest }: I_LoadingProps): React.JSX.Element;

package/dist/react/loading/loading.hook.d.ts

@@ -1 +1,13 @@
+/**
+ * React hook that provides access to loading context.
+ * This hook retrieves the loading context which contains loading state and
+ * control methods. It provides a convenient way to access loading functionality
+ * within components, allowing them to show and hide loading states.
+ *
+ * The hook will throw an error if used outside of a LoadingProvider,
+ * ensuring proper context usage and providing clear error messages for debugging.
+ *
+ * @returns The loading context containing loading state and control methods.
+ * @throws {Error} When used outside of a LoadingProvider context.
+ */
 export declare function useLoading(): import('./loading.type.js').I_LoadingContext;

package/dist/react/loading/loading.provider.d.ts

@@ -1,3 +1,18 @@
 import { default as React } from 'react';
 import { I_Children } from '../../typescript/index.js';
+/**
+ * Provider component that manages loading state and provides loading context.
+ * This component sets up loading state management for the application and provides
+ * loading context to all child components through React context.
+ *
+ * Features:
+ * - Global loading state management
+ * - Loading context provision to child components
+ * - Automatic loading state synchronization
+ * - Integration with loading components
+ *
+ * @param props - Component props containing children.
+ * @param props.children - React children that will have access to the loading context.
+ * @returns A React component that provides loading context to its children.
+ */
 export declare function LoadingProvider({ children }: I_Children): React.JSX.Element;

package/dist/react/log/log.util.d.ts

@@ -1,6 +1,23 @@
 import { I_Log, I_Return } from '../../typescript/index.js';
 import { I_CatchErrorOptions } from './log.type.js';
+/**
+ * Browser-compatible logging interface using consola.
+ * This object provides all standard consola logging methods for use in browser environments,
+ * including error, warning, info, success, and debug logging capabilities.
+ */
 export declare const log: I_Log;
+/**
+ * Catches and handles errors with configurable behavior for React applications.
+ * This function provides a standardized way to handle errors in React components
+ * with options for logging control, return value specification, and custom callback execution.
+ *
+ * The function handles different error input types and provides consistent error
+ * response formatting for React applications.
+ *
+ * @param errorInput - The error to catch and handle, can be Error object, string, or unknown type.
+ * @param options - Configuration options for error handling behavior.
+ * @returns Either the specified return value or a standardized error response object.
+ */
 export declare function catchError<T = unknown>(errorInput: unknown, options: I_CatchErrorOptions & {
     returnValue: T;
 }): T;

package/dist/react/next-intl/next-intl.constant.d.ts

@@ -1,3 +1,12 @@
+/**
+ * Default language configuration for Next.js internationalization.
+ * This constant provides the default English (US) language settings including:
+ * - Language label and value for display and identification
+ * - Flag emoji and icon for UI representation
+ * - Date-fns locale adapter for date formatting
+ * - Number formatting configuration (locale and currency)
+ * - Timezone setting for date/time operations
+ */
 export declare const NEXT_INTL_DEFAULT_LANGUAGE: {
     label: string;
     value: string;

package/dist/react/next-intl/next-intl.hoc.d.ts

@@ -1,6 +1,22 @@
 import { ComponentType, default as React } from 'react';
 import { I_Children } from '../../typescript/index.js';
 import { I_NextIntlLanguage, T_NextIntlMessageList } from './next-intl.type.js';
+/**
+ * Higher-Order Component (HOC) that wraps components with Next.js internationalization support.
+ * This HOC provides internationalization capabilities to React components by wrapping them
+ * with the NextIntlClientProvider. It automatically handles language detection, message
+ * loading, and timezone configuration based on the current language settings.
+ *
+ * Features:
+ * - Automatic language detection and message loading
+ * - Timezone configuration based on language settings
+ * - Fallback to default language when messages are missing
+ * - Warning logging for missing message configurations
+ * - Proper display name preservation for debugging
+ *
+ * @param Component - The React component to wrap with internationalization support.
+ * @returns A new component with internationalization capabilities and additional props for languages and messages.
+ */
 export declare function withNextIntl<T extends I_Children>(Component: ComponentType<T>): {
     (props: T & {
         languages: I_NextIntlLanguage[];

package/dist/react/next-intl/next-intl.hook.d.ts

@@ -1,4 +1,25 @@
 import { useTranslations } from 'next-intl';
 import { I_NextIntlContext } from './next-intl.type.js';
+/**
+ * React hook that provides access to Next.js internationalization context.
+ * This hook retrieves the Next.js internationalization context which contains
+ * language information and language switching functionality. It provides a
+ * convenient way to access internationalization features within components.
+ *
+ * The hook will throw an error if used outside of a NextIntlProvider,
+ * ensuring proper context usage and providing clear error messages for debugging.
+ *
+ * @returns The Next.js internationalization context containing language state and control methods.
+ * @throws {Error} When used outside of a NextIntlProvider context.
+ */
 export declare function useNextIntl(): I_NextIntlContext;
+/**
+ * React hook that provides Next.js translation functionality.
+ * This hook is a wrapper around next-intl's useTranslations hook,
+ * providing access to translation functions and current locale information.
+ * It enables internationalization features including text translation,
+ * locale switching, and pluralization support for Next.js applications.
+ *
+ * @returns The useTranslations hook result with translation functions and locale information.
+ */
 export declare const useTranslateNextIntl: typeof useTranslations;

package/dist/react/next-intl/next-intl.provider.d.ts

@@ -1,3 +1,24 @@
 import { default as React } from 'react';
 import { I_NextIntlProviderProps } from './next-intl.type.js';
+/**
+ * Provider component that manages Next.js internationalization state and provides i18n context.
+ * This component sets up a complete internationalization system for Next.js applications,
+ * including language management, message loading, and persistent language preferences.
+ * It integrates with the storage system to remember user language choices and provides
+ * a comprehensive i18n context to all child components.
+ *
+ * Features:
+ * - Language state management with persistence
+ * - Automatic language detection and fallback
+ * - Message loading and caching
+ * - Timezone configuration per language
+ * - Integration with Next.js internationalization
+ * - Memoized context value for performance optimization
+ *
+ * @param props - Component props containing children, languages, and messages.
+ * @param props.children - React children that will have access to the internationalization context.
+ * @param props.languages - Array of supported languages with their configurations.
+ * @param props.messages - Object containing translation messages for each supported language.
+ * @returns A React component that provides internationalization context to its children.
+ */
 export declare function NextIntlProvider({ children, languages, messages, }: I_NextIntlProviderProps): React.JSX.Element;

package/dist/react/storage/storage.hook.d.ts

@@ -1,4 +1,23 @@
 import { I_Serializer } from '../../util/serializer/index.js';
+/**
+ * React hook that provides persistent storage functionality with automatic serialization.
+ * This hook manages state that persists across browser sessions using localForage,
+ * with automatic serialization/deserialization of complex data types. It provides
+ * a React-friendly interface for storage operations with proper error handling.
+ *
+ * Features:
+ * - Automatic data serialization and deserialization
+ * - Persistent storage across browser sessions
+ * - Initial value handling and fallback
+ * - Error handling with graceful degradation
+ * - Automatic storage synchronization
+ * - Support for complex data types via custom serializers
+ *
+ * @param key - The unique storage key for the data.
+ * @param initialValue - Optional initial value to use if no stored value exists.
+ * @param serializer - Optional custom serializer for complex data types (defaults to JSON serializer).
+ * @returns An object containing the current value, set function, and remove function.
+ */
 export declare function useStorage<T>(key: string, initialValue?: T, serializer?: I_Serializer<T>): {
     value: T | undefined;
     set: (newValue: T | ((val: T | undefined) => T)) => void;