@fecommunity/reactpress-toolkit 3.0.0 → 3.1.0

package/dist/ui/context/LocaleContext.d.ts

@@ -0,0 +1,15 @@
+import React from 'react';
+import type { LocaleCatalog, LocaleMessages } from '../../theme/visitor/locale';
+import type { LocaleContextValue } from './types';
+export interface LocaleProviderProps {
+    locale: string;
+    locales: string[];
+    messages: LocaleMessages;
+    catalog: LocaleCatalog;
+    children: React.ReactNode;
+    persistLocale?: boolean;
+    onLocaleChange?: (locale: string) => void;
+}
+export declare function LocaleProvider({ locale: initialLocale, locales, messages: initialMessages, catalog, children, persistLocale, onLocaleChange, }: LocaleProviderProps): import("react/jsx-runtime").JSX.Element;
+export declare function useLocale(): LocaleContextValue;
+export declare function readPersistedLocale(locales: string[], fallback: string): string;

package/dist/ui/context/LocaleContext.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LocaleProvider = LocaleProvider;
+exports.useLocale = useLocale;
+exports.readPersistedLocale = readPersistedLocale;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const react_1 = require("react");
+const locale_1 = require("../../theme/visitor/locale");
+const visitorLocale_1 = require("../../theme/visitor/visitorLocale");
+const LocaleContext = (0, react_1.createContext)(null);
+function LocaleProvider({ locale: initialLocale, locales, messages: initialMessages, catalog, children, persistLocale = true, onLocaleChange, }) {
+    const [locale, setLocaleState] = (0, react_1.useState)(initialLocale);
+    const [messages, setMessages] = (0, react_1.useState)(initialMessages);
+    (0, react_1.useEffect)(() => {
+        setMessages({ ...(catalog[locale] ?? {}) });
+    }, [catalog, locale]);
+    const setLocale = (0, react_1.useCallback)((next) => {
+        if (!locales.includes(next))
+            return;
+        setLocaleState(next);
+        setMessages({ ...(catalog[next] ?? {}) });
+        if (persistLocale && typeof window !== 'undefined') {
+            window.localStorage.setItem(visitorLocale_1.VISITOR_LOCALE_COOKIE, next);
+        }
+        onLocaleChange?.(next);
+    }, [catalog, locales, onLocaleChange, persistLocale]);
+    const value = (0, react_1.useMemo)(() => {
+        const t = (0, locale_1.createTranslator)(messages);
+        return {
+            locale,
+            locales,
+            messages,
+            catalog,
+            setLocale,
+            t,
+        };
+    }, [catalog, locale, locales, messages, setLocale]);
+    return (0, jsx_runtime_1.jsx)(LocaleContext.Provider, { value: value, children: children });
+}
+function useLocale() {
+    const ctx = (0, react_1.useContext)(LocaleContext);
+    if (!ctx) {
+        throw new Error('useLocale must be used within ReactPressProvider or LocaleProvider');
+    }
+    return ctx;
+}
+function readPersistedLocale(locales, fallback) {
+    if (typeof window === 'undefined')
+        return fallback;
+    try {
+        const stored = window.localStorage.getItem(visitorLocale_1.VISITOR_LOCALE_COOKIE);
+        if (stored && locales.includes(stored))
+            return stored;
+    }
+    catch {
+        // ignore
+    }
+    return fallback;
+}

package/dist/ui/context/ReactPressProvider.d.ts

@@ -0,0 +1,3 @@
+import type { ReactPressProviderProps } from './types';
+/** Wraps the theme app with locale + active theme / customizer context. */
+export declare function ReactPressProvider({ locale, locales, messages, catalog, themeId, activeThemeId, mods, isPreview, siteMeta, children, persistLocale, onLocaleChange, }: ReactPressProviderProps): import("react/jsx-runtime").JSX.Element;

package/dist/ui/context/ReactPressProvider.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ReactPressProvider = ReactPressProvider;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const LocaleContext_1 = require("./LocaleContext");
+const ThemeRuntimeContext_1 = require("./ThemeRuntimeContext");
+/** Wraps the theme app with locale + active theme / customizer context. */
+function ReactPressProvider({ locale, locales, messages, catalog = {}, themeId, activeThemeId, mods = {}, isPreview = false, siteMeta, children, persistLocale = true, onLocaleChange, }) {
+    return ((0, jsx_runtime_1.jsx)(LocaleContext_1.LocaleProvider, { locale: locale, locales: locales, messages: messages, catalog: catalog, persistLocale: persistLocale, onLocaleChange: onLocaleChange, children: (0, jsx_runtime_1.jsx)(ThemeRuntimeContext_1.ThemeRuntimeProvider, { themeId: themeId, activeThemeId: activeThemeId, mods: mods, isPreview: isPreview, siteMeta: siteMeta, children: children }) }));
+}

package/dist/ui/context/SiteCatalogContext.d.ts

@@ -0,0 +1,41 @@
+import React from 'react';
+import type { SiteCatalogContextValue } from './siteCatalogTypes';
+export type { SiteCatalogContextValue, SiteCatalogSiteConfig, SiteConfigNav, } from './siteCatalogTypes';
+/** Global site catalog + session state for full-featured themes. */
+export declare const SiteCatalogContext: React.Context<SiteCatalogContextValue>;
+export declare function SiteCatalogProvider({ value, children, }: {
+    value: SiteCatalogContextValue;
+    children: React.ReactNode;
+}): import("react/jsx-runtime").JSX.Element;
+export declare function useSiteCatalog(): {
+    categories: import("../..").ICategory[];
+    tags: import("../..").ITag[];
+    pages: import("../..").IPage[];
+    siteConfig: (import("./siteCatalogTypes").SiteCatalogSiteConfig & import("../../theme").ResolvedSiteConfig) | undefined;
+    globalSetting: {
+        globalConfig: Record<string, unknown>;
+    } | undefined;
+    locale: string | undefined;
+    locales: string[];
+    i18n: Record<string, unknown> | undefined;
+    changeLocale: ((locale: string) => void) | undefined;
+    collapsed: boolean | undefined;
+    toggleCollapse: (() => void) | undefined;
+};
+export declare function useSiteSetting(): import("../..").ISetting;
+export declare function useSiteUser(): {
+    user: import("../..").IUser | Partial<import("../..").IUser> | null | undefined;
+    setUser: ((user: import("../..").IUser) => void) | undefined;
+    removeUser: (() => void) | undefined;
+};
+export declare function useColorMode(): {
+    colorMode: import("../../theme").ThemeColorMode;
+    changeColorMode: ((mode: import("../../theme").ThemeColorMode) => void) | undefined;
+};
+/** @deprecated Prefer `useSiteCatalog().siteConfig`. */
+export declare function useSiteConfig(): {
+    siteConfig: (import("./siteCatalogTypes").SiteCatalogSiteConfig & import("../../theme").ResolvedSiteConfig) | undefined;
+    globalSetting: {
+        globalConfig: Record<string, unknown>;
+    } | undefined;
+};

package/dist/ui/context/SiteCatalogContext.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SiteCatalogContext = void 0;
+exports.SiteCatalogProvider = SiteCatalogProvider;
+exports.useSiteCatalog = useSiteCatalog;
+exports.useSiteSetting = useSiteSetting;
+exports.useSiteUser = useSiteUser;
+exports.useColorMode = useColorMode;
+exports.useSiteConfig = useSiteConfig;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const react_1 = require("react");
+const siteCatalogTypes_1 = require("./siteCatalogTypes");
+/** Global site catalog + session state for full-featured themes. */
+exports.SiteCatalogContext = (0, react_1.createContext)(siteCatalogTypes_1.defaultSiteCatalogContext);
+function SiteCatalogProvider({ value, children, }) {
+    return ((0, jsx_runtime_1.jsx)(exports.SiteCatalogContext.Provider, { value: value, children: children }));
+}
+function useSiteCatalog() {
+    const ctx = (0, react_1.useContext)(exports.SiteCatalogContext);
+    return {
+        categories: ctx.categories ?? [],
+        tags: ctx.tags ?? [],
+        pages: ctx.pages ?? [],
+        siteConfig: ctx.siteConfig,
+        globalSetting: ctx.globalSetting,
+        locale: ctx.locale,
+        locales: ctx.locales ?? [],
+        i18n: ctx.i18n,
+        changeLocale: ctx.changeLocale,
+        collapsed: ctx.collapsed,
+        toggleCollapse: ctx.toggleCollapse,
+    };
+}
+function useSiteSetting() {
+    const ctx = (0, react_1.useContext)(exports.SiteCatalogContext);
+    return ctx.setting ?? {};
+}
+function useSiteUser() {
+    const ctx = (0, react_1.useContext)(exports.SiteCatalogContext);
+    return {
+        user: ctx.user,
+        setUser: ctx.setUser,
+        removeUser: ctx.removeUser,
+    };
+}
+function useColorMode() {
+    const ctx = (0, react_1.useContext)(exports.SiteCatalogContext);
+    return {
+        colorMode: ctx.theme ?? 'light',
+        changeColorMode: ctx.changeTheme,
+    };
+}
+/** @deprecated Prefer `useSiteCatalog().siteConfig`. */
+function useSiteConfig() {
+    const ctx = (0, react_1.useContext)(exports.SiteCatalogContext);
+    return {
+        siteConfig: ctx.siteConfig,
+        globalSetting: ctx.globalSetting,
+    };
+}

package/dist/ui/context/ThemeRuntimeContext.d.ts

@@ -0,0 +1,21 @@
+import React from 'react';
+import type { ThemeMods } from '../../theme/extension/theme';
+import type { ThemeRuntimeContextValue } from './types';
+export interface ThemeRuntimeProviderProps {
+    themeId: string;
+    activeThemeId: string;
+    mods?: ThemeMods;
+    isPreview?: boolean;
+    siteMeta?: ThemeRuntimeContextValue['siteMeta'];
+    children: React.ReactNode;
+}
+export declare function ThemeRuntimeProvider({ themeId, activeThemeId, mods, isPreview, siteMeta, children, }: ThemeRuntimeProviderProps): import("react/jsx-runtime").JSX.Element;
+export declare function useThemeRuntime(): ThemeRuntimeContextValue;
+/** Read a single customizer mod with optional default (from `theme.json` customizer). */
+export declare function useThemeMod(modId: string, defaultValue?: string): string;
+/** Checkbox mods are stored as strings (`"1"` / `"0"`). */
+export declare function useThemeModBool(modId: string, defaultValue?: boolean): boolean;
+export declare function useThemeId(): string;
+export declare function useActiveThemeId(): string;
+export declare function useIsThemePreview(): boolean;
+export declare function useSiteMeta(): ThemeRuntimeContextValue['siteMeta'];

package/dist/ui/context/ThemeRuntimeContext.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ThemeRuntimeProvider = ThemeRuntimeProvider;
+exports.useThemeRuntime = useThemeRuntime;
+exports.useThemeMod = useThemeMod;
+exports.useThemeModBool = useThemeModBool;
+exports.useThemeId = useThemeId;
+exports.useActiveThemeId = useActiveThemeId;
+exports.useIsThemePreview = useIsThemePreview;
+exports.useSiteMeta = useSiteMeta;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const react_1 = require("react");
+const setting_1 = require("../../theme/ssr/setting");
+const ThemeRuntimeContext = (0, react_1.createContext)(null);
+function ThemeRuntimeProvider({ themeId, activeThemeId, mods = {}, isPreview = false, siteMeta = setting_1.DEFAULT_SITE_META, children, }) {
+    const value = (0, react_1.useMemo)(() => ({
+        themeId,
+        activeThemeId,
+        mods,
+        isPreview,
+        siteMeta,
+    }), [activeThemeId, isPreview, mods, siteMeta, themeId]);
+    return ((0, jsx_runtime_1.jsx)(ThemeRuntimeContext.Provider, { value: value, children: children }));
+}
+function useThemeRuntime() {
+    const ctx = (0, react_1.useContext)(ThemeRuntimeContext);
+    if (!ctx) {
+        throw new Error('useThemeRuntime must be used within ReactPressProvider or ThemeRuntimeProvider');
+    }
+    return ctx;
+}
+/** Read a single customizer mod with optional default (from `theme.json` customizer). */
+function useThemeMod(modId, defaultValue = '') {
+    const ctx = (0, react_1.useContext)(ThemeRuntimeContext);
+    if (!ctx)
+        return defaultValue;
+    return ctx.mods[modId] ?? defaultValue;
+}
+const TRUTHY = new Set(['1', 'true', 'yes', 'on']);
+/** Checkbox mods are stored as strings (`"1"` / `"0"`). */
+function useThemeModBool(modId, defaultValue = false) {
+    const raw = useThemeMod(modId, defaultValue ? '1' : '0');
+    if (raw === '')
+        return defaultValue;
+    return TRUTHY.has(raw.trim().toLowerCase());
+}
+function useThemeId() {
+    return useThemeRuntime().themeId;
+}
+function useActiveThemeId() {
+    return useThemeRuntime().activeThemeId;
+}
+function useIsThemePreview() {
+    return useThemeRuntime().isPreview;
+}
+function useSiteMeta() {
+    const ctx = (0, react_1.useContext)(ThemeRuntimeContext);
+    return ctx?.siteMeta ?? setting_1.DEFAULT_SITE_META;
+}

package/dist/ui/context/index.d.ts

@@ -0,0 +1,8 @@
+export type { LocaleProviderProps } from './LocaleContext';
+export { LocaleProvider, readPersistedLocale, useLocale } from './LocaleContext';
+export { ReactPressProvider } from './ReactPressProvider';
+export type { ThemeRuntimeProviderProps } from './ThemeRuntimeContext';
+export { ThemeRuntimeProvider, useActiveThemeId, useIsThemePreview, useSiteMeta, useThemeId, useThemeMod, useThemeModBool, useThemeRuntime, } from './ThemeRuntimeContext';
+export type { LocaleContextValue, ReactPressProviderProps, ThemeRuntimeContextValue, } from './types';
+export type { SiteCatalogContextValue, SiteCatalogSiteConfig, SiteConfigNav, } from './SiteCatalogContext';
+export { SiteCatalogContext, SiteCatalogProvider, useColorMode, useSiteCatalog, useSiteConfig, useSiteSetting, useSiteUser, } from './SiteCatalogContext';

package/dist/ui/context/index.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useSiteUser = exports.useSiteSetting = exports.useSiteConfig = exports.useSiteCatalog = exports.useColorMode = exports.SiteCatalogProvider = exports.SiteCatalogContext = exports.useThemeRuntime = exports.useThemeModBool = exports.useThemeMod = exports.useThemeId = exports.useSiteMeta = exports.useIsThemePreview = exports.useActiveThemeId = exports.ThemeRuntimeProvider = exports.ReactPressProvider = exports.useLocale = exports.readPersistedLocale = exports.LocaleProvider = void 0;
+var LocaleContext_1 = require("./LocaleContext");
+Object.defineProperty(exports, "LocaleProvider", { enumerable: true, get: function () { return LocaleContext_1.LocaleProvider; } });
+Object.defineProperty(exports, "readPersistedLocale", { enumerable: true, get: function () { return LocaleContext_1.readPersistedLocale; } });
+Object.defineProperty(exports, "useLocale", { enumerable: true, get: function () { return LocaleContext_1.useLocale; } });
+var ReactPressProvider_1 = require("./ReactPressProvider");
+Object.defineProperty(exports, "ReactPressProvider", { enumerable: true, get: function () { return ReactPressProvider_1.ReactPressProvider; } });
+var ThemeRuntimeContext_1 = require("./ThemeRuntimeContext");
+Object.defineProperty(exports, "ThemeRuntimeProvider", { enumerable: true, get: function () { return ThemeRuntimeContext_1.ThemeRuntimeProvider; } });
+Object.defineProperty(exports, "useActiveThemeId", { enumerable: true, get: function () { return ThemeRuntimeContext_1.useActiveThemeId; } });
+Object.defineProperty(exports, "useIsThemePreview", { enumerable: true, get: function () { return ThemeRuntimeContext_1.useIsThemePreview; } });
+Object.defineProperty(exports, "useSiteMeta", { enumerable: true, get: function () { return ThemeRuntimeContext_1.useSiteMeta; } });
+Object.defineProperty(exports, "useThemeId", { enumerable: true, get: function () { return ThemeRuntimeContext_1.useThemeId; } });
+Object.defineProperty(exports, "useThemeMod", { enumerable: true, get: function () { return ThemeRuntimeContext_1.useThemeMod; } });
+Object.defineProperty(exports, "useThemeModBool", { enumerable: true, get: function () { return ThemeRuntimeContext_1.useThemeModBool; } });
+Object.defineProperty(exports, "useThemeRuntime", { enumerable: true, get: function () { return ThemeRuntimeContext_1.useThemeRuntime; } });
+var SiteCatalogContext_1 = require("./SiteCatalogContext");
+Object.defineProperty(exports, "SiteCatalogContext", { enumerable: true, get: function () { return SiteCatalogContext_1.SiteCatalogContext; } });
+Object.defineProperty(exports, "SiteCatalogProvider", { enumerable: true, get: function () { return SiteCatalogContext_1.SiteCatalogProvider; } });
+Object.defineProperty(exports, "useColorMode", { enumerable: true, get: function () { return SiteCatalogContext_1.useColorMode; } });
+Object.defineProperty(exports, "useSiteCatalog", { enumerable: true, get: function () { return SiteCatalogContext_1.useSiteCatalog; } });
+Object.defineProperty(exports, "useSiteConfig", { enumerable: true, get: function () { return SiteCatalogContext_1.useSiteConfig; } });
+Object.defineProperty(exports, "useSiteSetting", { enumerable: true, get: function () { return SiteCatalogContext_1.useSiteSetting; } });
+Object.defineProperty(exports, "useSiteUser", { enumerable: true, get: function () { return SiteCatalogContext_1.useSiteUser; } });

package/dist/ui/context/siteCatalogTypes.d.ts

@@ -0,0 +1,64 @@
+import type { ResolvedSiteConfig } from '../../theme/extension/configuration/types';
+import type { ThemeColorMode } from '../../theme/visitor/colorMode';
+import type { ICategory, IPage, ISetting, ITag, IUser } from '../../types';
+export interface SiteConfigNav {
+    urlConfig?: Array<{
+        key: string;
+        label: string;
+        icon?: string;
+        children?: Array<{
+            key: string;
+            label: string;
+            url?: string;
+            description?: string;
+            icon?: string;
+            type?: string;
+        }>;
+    }>;
+    searchCategories?: {
+        categories?: Array<{
+            label: string;
+            key: string;
+        }>;
+        subCategories?: Record<string, Array<{
+            label: string;
+            key: string;
+            url?: string;
+        }>>;
+    };
+}
+export interface SiteCatalogSiteConfig {
+    header?: {
+        navLinks?: Array<{
+            path: string;
+            locale?: string;
+            label?: string;
+            icon?: string;
+            visible?: boolean;
+        }>;
+    };
+    nav?: SiteConfigNav;
+}
+export interface SiteCatalogContextValue {
+    setting?: ISetting;
+    i18n?: Record<string, unknown>;
+    siteConfig?: SiteCatalogSiteConfig & ResolvedSiteConfig;
+    globalSetting?: {
+        globalConfig: Record<string, unknown>;
+    };
+    locale?: string;
+    locales?: string[];
+    pages?: IPage[];
+    categories?: ICategory[];
+    tags?: ITag[];
+    changeLocale?: (locale: string) => void;
+    user?: IUser | Partial<IUser> | null;
+    setUser?: (user: IUser) => void;
+    removeUser?: () => void;
+    changeTheme?: (mode: ThemeColorMode) => void;
+    theme?: ThemeColorMode;
+    collapsed?: boolean;
+    getSetting?: () => void;
+    toggleCollapse?: () => void;
+}
+export declare const defaultSiteCatalogContext: SiteCatalogContextValue;

package/dist/ui/context/siteCatalogTypes.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultSiteCatalogContext = void 0;
+exports.defaultSiteCatalogContext = {
+    setting: {},
+    i18n: {},
+    locale: '',
+    locales: [],
+    pages: [],
+    categories: [],
+    tags: [],
+    changeLocale: () => { },
+    user: null,
+    setUser: () => { },
+    removeUser: () => { },
+    changeTheme: () => { },
+    theme: 'light',
+    getSetting: () => { },
+    toggleCollapse: () => { },
+};

package/dist/ui/context/types.d.ts

@@ -0,0 +1,34 @@
+import type React from 'react';
+import type { ThemeMods } from '../../theme/extension/theme';
+import type { LocaleCatalog, LocaleMessages } from '../../theme/visitor/locale';
+import type { SiteMeta } from '../../theme/ssr/setting';
+export interface LocaleContextValue {
+    locale: string;
+    locales: string[];
+    messages: LocaleMessages;
+    catalog: LocaleCatalog;
+    setLocale: (next: string) => void;
+    t: (key: string, fallback?: string) => string;
+}
+export interface ThemeRuntimeContextValue {
+    themeId: string;
+    activeThemeId: string;
+    mods: ThemeMods;
+    isPreview: boolean;
+    siteMeta: SiteMeta;
+}
+export interface ReactPressProviderProps {
+    locale: string;
+    locales: string[];
+    messages: LocaleMessages;
+    catalog?: LocaleCatalog;
+    themeId: string;
+    activeThemeId: string;
+    mods?: ThemeMods;
+    isPreview?: boolean;
+    siteMeta?: SiteMeta;
+    children: React.ReactNode;
+    /** Persist locale in `localStorage` (browser only). */
+    persistLocale?: boolean;
+    onLocaleChange?: (locale: string) => void;
+}

package/dist/ui/context/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/ui/hooks/index.d.ts

@@ -0,0 +1,12 @@
+export { readPersistedLocale, useActiveThemeId, useIsThemePreview, useLocale, useThemeId, useThemeMod, useThemeRuntime, } from '../context';
+export { useAsyncLoading } from './useAsyncLoading';
+export { useForceUpdate } from './useForceUpdate';
+export { useNavActive } from './useNavActive';
+export type { PaginatedFetch, UsePaginationOptions, UsePaginationResult, } from './usePagination';
+export { usePagination } from './usePagination';
+export type { UseReportPageViewOptions } from './useReportPageView';
+export { useReportPageView } from './useReportPageView';
+export { useReportArticleView } from './useReportArticleView';
+export { useRouteParam } from './useRouteParam';
+export { useToggle } from './useToggle';
+export { useWarningOnExit } from './useWarningOnExit';

package/dist/ui/hooks/index.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useWarningOnExit = exports.useToggle = exports.useRouteParam = exports.useReportArticleView = exports.useReportPageView = exports.usePagination = exports.useNavActive = exports.useForceUpdate = exports.useAsyncLoading = exports.useThemeRuntime = exports.useThemeMod = exports.useThemeId = exports.useLocale = exports.useIsThemePreview = exports.useActiveThemeId = exports.readPersistedLocale = void 0;
+var context_1 = require("../context");
+Object.defineProperty(exports, "readPersistedLocale", { enumerable: true, get: function () { return context_1.readPersistedLocale; } });
+Object.defineProperty(exports, "useActiveThemeId", { enumerable: true, get: function () { return context_1.useActiveThemeId; } });
+Object.defineProperty(exports, "useIsThemePreview", { enumerable: true, get: function () { return context_1.useIsThemePreview; } });
+Object.defineProperty(exports, "useLocale", { enumerable: true, get: function () { return context_1.useLocale; } });
+Object.defineProperty(exports, "useThemeId", { enumerable: true, get: function () { return context_1.useThemeId; } });
+Object.defineProperty(exports, "useThemeMod", { enumerable: true, get: function () { return context_1.useThemeMod; } });
+Object.defineProperty(exports, "useThemeRuntime", { enumerable: true, get: function () { return context_1.useThemeRuntime; } });
+var useAsyncLoading_1 = require("./useAsyncLoading");
+Object.defineProperty(exports, "useAsyncLoading", { enumerable: true, get: function () { return useAsyncLoading_1.useAsyncLoading; } });
+var useForceUpdate_1 = require("./useForceUpdate");
+Object.defineProperty(exports, "useForceUpdate", { enumerable: true, get: function () { return useForceUpdate_1.useForceUpdate; } });
+var useNavActive_1 = require("./useNavActive");
+Object.defineProperty(exports, "useNavActive", { enumerable: true, get: function () { return useNavActive_1.useNavActive; } });
+var usePagination_1 = require("./usePagination");
+Object.defineProperty(exports, "usePagination", { enumerable: true, get: function () { return usePagination_1.usePagination; } });
+var useReportPageView_1 = require("./useReportPageView");
+Object.defineProperty(exports, "useReportPageView", { enumerable: true, get: function () { return useReportPageView_1.useReportPageView; } });
+var useReportArticleView_1 = require("./useReportArticleView");
+Object.defineProperty(exports, "useReportArticleView", { enumerable: true, get: function () { return useReportArticleView_1.useReportArticleView; } });
+var useRouteParam_1 = require("./useRouteParam");
+Object.defineProperty(exports, "useRouteParam", { enumerable: true, get: function () { return useRouteParam_1.useRouteParam; } });
+var useToggle_1 = require("./useToggle");
+Object.defineProperty(exports, "useToggle", { enumerable: true, get: function () { return useToggle_1.useToggle; } });
+var useWarningOnExit_1 = require("./useWarningOnExit");
+Object.defineProperty(exports, "useWarningOnExit", { enumerable: true, get: function () { return useWarningOnExit_1.useWarningOnExit; } });

package/dist/ui/hooks/useAsyncLoading.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Wrap an async function and expose a debounced `loading` flag (avoids flicker on fast requests).
+ */
+export declare function useAsyncLoading<A extends (...args: any[]) => Promise<any>>(action: A, wait?: number, initialLoading?: boolean): [A, boolean];

package/dist/ui/hooks/useAsyncLoading.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useAsyncLoading = useAsyncLoading;
+const react_1 = require("react");
+/**
+ * Wrap an async function and expose a debounced `loading` flag (avoids flicker on fast requests).
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function useAsyncLoading(action, wait = 200, initialLoading = false) {
+    const timerRef = (0, react_1.useRef)(null);
+    const [pending, setPending] = (0, react_1.useState)(false);
+    const [loading, setLoading] = (0, react_1.useState)(initialLoading);
+    const actionWithPending = (0, react_1.useCallback)((...args) => {
+        setPending(true);
+        const promise = action(...args);
+        promise.then(() => setPending(false), () => setPending(false));
+        return promise;
+    }, [action]);
+    (0, react_1.useEffect)(() => {
+        if (timerRef.current)
+            clearTimeout(timerRef.current);
+        timerRef.current = setTimeout(() => {
+            setLoading(pending);
+        }, wait);
+        return () => {
+            if (timerRef.current)
+                clearTimeout(timerRef.current);
+        };
+    }, [wait, pending]);
+    return [actionWithPending, loading];
+}

package/dist/ui/hooks/useForceUpdate.d.ts

@@ -0,0 +1,2 @@
+/** Force a function component re-render without changing state props. */
+export declare function useForceUpdate(): () => void;

package/dist/ui/hooks/useForceUpdate.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useForceUpdate = useForceUpdate;
+const react_1 = require("react");
+/** Force a function component re-render without changing state props. */
+function useForceUpdate() {
+    const [, update] = (0, react_1.useState)(0);
+    return (0, react_1.useCallback)(() => {
+        update((v) => v + 1);
+    }, []);
+}

package/dist/ui/hooks/useNavActive.d.ts

@@ -0,0 +1,5 @@
+import type { NavItem } from '../../theme/content/nav';
+/**
+ * Derive active nav id from pathname (pass `router.pathname` from `next/router` in client components).
+ */
+export declare function useNavActive(items: NavItem[], pathname: string): string | undefined;

package/dist/ui/hooks/useNavActive.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useNavActive = useNavActive;
+const react_1 = require("react");
+const nav_1 = require("../../theme/content/nav");
+/**
+ * Derive active nav id from pathname (pass `router.pathname` from `next/router` in client components).
+ */
+function useNavActive(items, pathname) {
+    return (0, react_1.useMemo)(() => (0, nav_1.getNavActiveId)(pathname, items), [pathname, items]);
+}

package/dist/ui/hooks/usePagination.d.ts

@@ -0,0 +1,34 @@
+import type { Dispatch, SetStateAction } from 'react';
+export type PaginatedFetch<T> = (params: Record<string, unknown> & {
+    page: number;
+    pageSize: number;
+}) => Promise<[T[], number]>;
+export interface UsePaginationOptions<T> {
+    page?: number;
+    pageSize?: number;
+    params?: Record<string, unknown>;
+    after?: (snapshot?: {
+        loading: boolean;
+        page: number;
+        pageSize: number;
+        data: T[];
+        total: number;
+    }) => void;
+}
+export interface UsePaginationResult<T> {
+    loading: boolean;
+    data: T[];
+    total: number;
+    page: number;
+    pageSize: number;
+    params: Record<string, unknown>;
+    setPage: Dispatch<SetStateAction<number>>;
+    setPageSize: Dispatch<SetStateAction<number>>;
+    setParams: Dispatch<SetStateAction<Record<string, unknown>>>;
+    refresh: () => void;
+    reset: () => void;
+}
+/**
+ * Paginated list state for APIs that return `[items, total]`.
+ */
+export declare function usePagination<T>(fetch: PaginatedFetch<T>, options?: UsePaginationOptions<T>): UsePaginationResult<T>;

package/dist/ui/hooks/usePagination.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.usePagination = usePagination;
+const react_1 = require("react");
+const useAsyncLoading_1 = require("./useAsyncLoading");
+const DEFAULT_PAGE = 1;
+const DEFAULT_PAGE_SIZE = 12;
+/**
+ * Paginated list state for APIs that return `[items, total]`.
+ */
+function usePagination(fetch, options) {
+    const defaultPage = options?.page ?? DEFAULT_PAGE;
+    const defaultPageSize = options?.pageSize ?? DEFAULT_PAGE_SIZE;
+    const defaultParams = options?.params ?? {};
+    const after = options?.after;
+    const [api, loading] = (0, useAsyncLoading_1.useAsyncLoading)(fetch);
+    const [page, setPage] = (0, react_1.useState)(defaultPage);
+    const [pageSize, setPageSize] = (0, react_1.useState)(defaultPageSize);
+    const [params, setParams] = (0, react_1.useState)(defaultParams);
+    const [total, setTotal] = (0, react_1.useState)(0);
+    const [data, setData] = (0, react_1.useState)([]);
+    const callAfter = (0, react_1.useCallback)(() => {
+        after?.({ page, pageSize, data, total, loading });
+    }, [after, page, pageSize, data, total, loading]);
+    const query = (0, react_1.useCallback)((queryParams) => api(queryParams).then((res) => {
+        const [items, count] = res;
+        setData(items);
+        setTotal(count);
+        callAfter();
+        return res;
+    }), [api, callAfter]);
+    const refresh = (0, react_1.useCallback)(() => query({ page, pageSize, ...params }), [query, page, pageSize, params]);
+    const reset = (0, react_1.useCallback)(() => {
+        setPage(defaultPage);
+        setPageSize(defaultPageSize);
+        setParams(defaultParams);
+    }, [defaultPage, defaultPageSize, defaultParams]);
+    (0, react_1.useEffect)(() => {
+        query({ page, pageSize, ...params });
+        // eslint-disable-next-line react-hooks/exhaustive-deps -- refresh when page/size/filters change only
+    }, [page, pageSize, params]);
+    return {
+        loading,
+        data,
+        total,
+        page,
+        pageSize,
+        params,
+        setPage,
+        setPageSize,
+        setParams,
+        refresh,
+        reset,
+    };
+}