📦 feat: Move Shared Components to @librechat/client (#8685)

* feat: init @librechat/client

* feat: Add common types and interfaces for accessibility, agents, artifacts, assistants, and tools

* feat: Add jotai as a peer dependency

* fix build client package

* feat: cleanup unused types from common/index.ts

- Remove 104 unused type exports from packages/client/src/common/index.ts
- Keep only 7 actually used exports (93% reduction)
- Add cleanup script with enhanced import pattern detection
- Support both named imports and namespace imports (* as t)
- Create automatic backups and comprehensive documentation
- Maintain type safety with build verification
- No breaking changes to existing code

Kept exports:
- TShowToast, Option, OptionWithIcon, DropdownValueSetter
- MentionOption, NotificationSeverity, MenuItemProps

Scripts: cleanup-common-types-safe.js, README-CLEANUP.md

* fix: cleanup

* fix: package; refactor: tsconfig

* feat: add back `recoil`

* fix: move dependencies to peerDependencies in client package

* feat: add @librechat/client as a dependency in package.json and package-lock.json

* feat: update client package configuration and dependencies

- Added new dependencies for Rollup plugins and updated existing ones in package.json and package-lock.json.
- Introduced a new Rollup configuration file for building the client package.
- Refactored build scripts to include a dedicated build command for the client.
- Updated TypeScript configuration for improved module resolution and type declaration output.
- Integrated a Toast component from the client package into the main App component.

* feat: enhance Rollup configuration for client package

- Updated terser plugin settings to preserve directives like 'use client'.
- Added custom warning handler to ignore "use client" directive warnings during the build process.

* chore: rename package/client build script command

* feat: update client package dependencies and Rollup configuration

- Added rollup-plugin-postcss to package.json and updated package-lock.json.
- Enhanced Rollup configuration to include postcss plugin for CSS handling.
- Updated index.ts to export all components from the components directory for better modularity.

* feat: add client package directory to update configuration

- Included the 'client' package directory in the update.js configuration to ensure it is recognized during updates.

* feat: export Toast component in client package

- Added export for the Toast component in index.ts to enhance modularity and accessibility of components.

* feat: /client transition to @librechat/client

* chore: fixed formatting issues

* fix: update peer dependencies in @librechat/client to prevent bundling them

* fix: correct useSprings implementation in SplitText component

* fix: circular dependencies in DataTable

* fix: add remaining peer dependencies and match actual versions previously used in `client/package.json`

* fix: correct frontend:ci script to include client package build

* chore: enhance unused package detection for @librechat/client and improve dependency extraction

* fix: add missing peer dependency for @radix-ui/react-collapsible

* chore: include "packages/client" in unused i18next keys detection

* test: update AgentFooter tests to use document.querySelector for spinner checks
test: mock window.matchMedia in setupTests.js for consistent test environment

* feat: add react-hook-form dependency and update FormInput component to use its types

* chore: linting

* refactor: remove unused defaultSelectedValues prop from MCPSelect and MultiSelect components

* chore: linting

* feat: update GitHub Actions workflow to publish @librechat/client

* chore: update GitHub Actions workflow to install and build data-provider and client dependencies

* chore: add missing @testing-library/react dependency to client package

* chore: update tsconfig.json to exclude additional test files

* chore: fix build issues, resolve latest LC changes

* chore: move MCP components outside of `~/components/ui`

* feat: implement dynamic theme system with environment variable support and Tailwind CSS integration

* chore: remove unnecessary logging of sttExternal and ttsExternal in Speech component

* chore: squashed cleanup commits

chore: move @tanstack/react-virtual to dependencies and remove recoil from package.json

chore: move dependencies to peerDependencies in package.json

feat: update package.json and rollup.config.js to include jotai and enhance bundling configuration

feat: update package.json and rollup.config.js to include jotai and enhance bundling configuration

refactor: reorganize exports in index.ts for improved clarity

refactor: remove unused types and interfaces from common files

refactor: update peer dependencies and improve component typings

- Removed duplicate peer dependencies from package.json and organized them.
- Updated rollup.config.js to disable TypeScript checking during the build process.
- Modified AnimatedTabs component to use React.ReactNode for label and content types, and added TypeScript workarounds for compatibility.
- Enhanced Label and Separator components to accept an optional className prop and improved prop spreading.
- Updated Slider component to include an optional className prop and refined prop handling for better type safety.

refactor: clean up client workflow and update package dependencies

refactor: update package dependencies and improve PostCSS and Rollup configurations

chore: bump version to 0.1.2 in package.json

chore: bump client version to 0.1.2 in package-lock.json

chore: bump client version to 0.1.3 and update dependencies

chore: bump client version to 0.1.4 and update @react-spring dependencies

chore: update package version to 0.1.5 and adjust peer dependencies

- Bump version in package.json from 0.1.4 to 0.1.5.
- Update peer dependency for @tanstack/react-query to allow version 5.0.0.
- Add @tanstack/react-table and @tanstack/react-virtual as dependencies.
- Update various dependencies to their latest compatible versions.
- Simplify postcss.config.js by removing unnecessary options.
- Clean up rollup.config.js by removing ignored PostCSS warnings.
- Update CheckboxButton component to cast icon as React JSX element.
- Adjust Combobox component's class names for better styling.
- Change DropdownPopup component to use React's namespace import.
- Modify InputOTP component to use 'any' type for OTPInputContext.
- Ensure displayLabel and value in ModelParameters are converted to strings.
- Update MultiSearch component's placeholder to ensure it's a string.
- Cast selectIcon in MultiSelect as React JSX element for consistency.
- Update OGDialogTemplate to cast selectText as React JSX element.
- Initialize animationRef in PixelCard with undefined for clarity.
- Add TypeScript ignore comments in Select and SelectDropDown components for Radix UI type conflicts.
- Ensure title in SelectDropDown is a string and adjust rendering of options.
- Update useLocalize hook to cast options as any for compatibility.

refactor: code structure; chore: translations cleanup

chore: remove unused imports and clean up code in NewChat component

refactor: enhance Menu component to support custom render functions for menu items

style: update itemClassName in ToolsDropdown for improved UI consistency

fix: merge conflicts

chore: update @radix-ui/react-accordion to version 1.2.11

* refactor: remove unnecessary TypeScript type assertions in AnimatedTabs, Label, Separator, and Slider components

* feat: enhance theme system with localStorage persistence and new theme atoms

* chore: bump version of @librechat/client to 0.1.7

* chore: fix ci/cd warnings/errors related to linting and unused localization keys

* chore: update dependencies for class-variance-authority, clsx, and match-sorter

* chore: bump @librechat/client to v0.1.8

* feat: add utility colors for theme customization and remove unused tailwindConfig

* v0.1.9

---------

Co-authored-by: Marco Beretta <81851188+berry-13@users.noreply.github.com>

packages/client/src/hooks/ThemeContext.old.tsx

@@ -0,0 +1,88 @@
+//ThemeContext.js
+// source: https://plainenglish.io/blog/light-and-dark-mode-in-react-web-application-with-tailwind-css-89674496b942
+import { useSetAtom } from 'jotai';
+import React, { createContext, useState, useEffect } from 'react';
+import { getInitialTheme, applyFontSize } from '~/utils';
+import { fontSizeAtom } from '~/store';
+
+type ProviderValue = {
+  theme: string;
+  setTheme: React.Dispatch<React.SetStateAction<string>>;
+};
+
+const defaultContextValue: ProviderValue = {
+  theme: getInitialTheme(),
+  setTheme: () => {
+    return;
+  },
+};
+
+export const isDark = (theme: string): boolean => {
+  if (theme === 'system') {
+    return window.matchMedia('(prefers-color-scheme: dark)').matches;
+  }
+  return theme === 'dark';
+};
+
+export const ThemeContext = createContext<ProviderValue>(defaultContextValue);
+
+export const ThemeProvider = ({
+  initialTheme,
+  children,
+}: {
+  initialTheme?: string;
+  children: React.ReactNode;
+}) => {
+  const [theme, setTheme] = useState(getInitialTheme);
+  const setFontSize = useSetAtom(fontSizeAtom);
+
+  const rawSetTheme = (rawTheme: string) => {
+    const root = window.document.documentElement;
+    const darkMode = isDark(rawTheme);
+
+    root.classList.remove(darkMode ? 'light' : 'dark');
+    root.classList.add(darkMode ? 'dark' : 'light');
+
+    localStorage.setItem('color-theme', rawTheme);
+  };
+
+  useEffect(() => {
+    const mediaQuery = window.matchMedia('(prefers-color-scheme: dark)');
+    const changeThemeOnSystemChange = () => {
+      rawSetTheme(mediaQuery.matches ? 'dark' : 'light');
+    };
+
+    mediaQuery.addEventListener('change', changeThemeOnSystemChange);
+
+    return () => {
+      mediaQuery.removeEventListener('change', changeThemeOnSystemChange);
+    };
+  }, []);
+
+  useEffect(() => {
+    const fontSize = localStorage.getItem('fontSize');
+    if (fontSize == null) {
+      setFontSize('text-base');
+      applyFontSize('text-base');
+      localStorage.setItem('fontSize', JSON.stringify('text-base'));
+      return;
+    }
+    try {
+      applyFontSize(JSON.parse(fontSize));
+    } catch (error) {
+      console.log(error);
+    }
+    // Reason: This effect should only run once, and `setFontSize` is a stable function
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, []);
+
+  if (initialTheme) {
+    rawSetTheme(initialTheme);
+  }
+
+  useEffect(() => {
+    rawSetTheme(theme);
+  }, [theme]);
+
+  return <ThemeContext.Provider value={{ theme, setTheme }}>{children}</ThemeContext.Provider>;
+};

packages/client/src/hooks/index.ts

@@ -0,0 +1,10 @@
+// Theme exports are now handled by the theme module in the main index.ts
+
+export type { TranslationKeys } from './useLocalize';
+
+export { default as useToast } from './useToast';
+export { default as useCombobox } from './useCombobox';
+export { default as useLocalize } from './useLocalize';
+export { default as useMediaQuery } from './useMediaQuery';
+export { default as useDelayedRender } from './useDelayedRender';
+export { default as useOnClickOutside } from './useOnClickOutside';

packages/client/src/hooks/useCombobox.ts

@@ -0,0 +1,37 @@
+import { useMemo, useState } from 'react';
+import { matchSorter } from 'match-sorter';
+import type { OptionWithIcon, MentionOption } from '~/common';
+
+export default function useCombobox({
+  value,
+  options,
+}: {
+  value: string;
+  options: Array<OptionWithIcon | MentionOption>;
+}) {
+  const [open, setOpen] = useState(false);
+  const [searchValue, setSearchValue] = useState('');
+
+  const matches = useMemo(() => {
+    if (!searchValue) {
+      return options;
+    }
+    const keys = ['label', 'value'];
+    const matches = matchSorter(options, searchValue, { keys });
+    // Radix Select does not work if we don't render the selected item, so we
+    // make sure to include it in the list of matches.
+    const selectedItem = options.find((currentItem) => currentItem.value === value);
+    if (selectedItem && !matches.includes(selectedItem)) {
+      matches.push(selectedItem);
+    }
+    return matches;
+  }, [searchValue, value, options]);
+
+  return {
+    open,
+    setOpen,
+    searchValue,
+    setSearchValue,
+    matches,
+  };
+}

packages/client/src/hooks/useDelayedRender.tsx

@@ -0,0 +1,37 @@
+import { useState, useRef, useEffect } from 'react';
+import type { ReactNode } from 'react';
+
+const useDelayedRender = (delay: number) => {
+  const [delayed, setDelayed] = useState(true);
+  const timerPromiseRef = useRef<Promise<void> | null>(null);
+
+  useEffect(() => {
+    if (delayed) {
+      const timerPromise = new Promise<void>((resolve) => {
+        const timeout = setTimeout(() => {
+          setDelayed(false);
+          resolve();
+        }, delay);
+
+        return () => {
+          clearTimeout(timeout);
+        };
+      });
+
+      timerPromiseRef.current = timerPromise;
+    }
+
+    return () => {
+      timerPromiseRef.current = null;
+    };
+  }, [delay, delayed]);
+
+  return (fn: () => ReactNode) => {
+    if (delayed && timerPromiseRef.current) {
+      throw timerPromiseRef.current;
+    }
+    return fn();
+  };
+};
+
+export default useDelayedRender;

packages/client/src/hooks/useLocalize.ts

@@ -0,0 +1,21 @@
+import { useEffect } from 'react';
+import { TOptions } from 'i18next';
+import { useAtomValue } from 'jotai';
+import { useTranslation } from 'react-i18next';
+import { resources } from '~/locales/i18n';
+import { langAtom } from '~/store';
+
+export type TranslationKeys = keyof typeof resources.en.translation;
+
+export default function useLocalize() {
+  const lang = useAtomValue(langAtom);
+  const { t, i18n } = useTranslation();
+
+  useEffect(() => {
+    if (i18n.language !== lang) {
+      i18n.changeLanguage(lang);
+    }
+  }, [lang, i18n]);
+
+  return (phraseKey: TranslationKeys, options?: TOptions) => t(phraseKey, options);
+}

packages/client/src/hooks/useMediaQuery.tsx

@@ -0,0 +1,17 @@
+import { useEffect, useState } from 'react';
+
+export default function useMediaQuery(query: string) {
+  const [matches, setMatches] = useState(false);
+
+  useEffect(() => {
+    const media = window.matchMedia(query);
+    if (media.matches !== matches) {
+      setMatches(media.matches);
+    }
+    const listener = () => setMatches(media.matches);
+    media.addEventListener('change', listener);
+    return () => media.removeEventListener('change', listener);
+  }, [matches, query]);
+
+  return matches;
+}

packages/client/src/hooks/useOnClickOutside.ts

@@ -0,0 +1,41 @@
+import { useEffect, RefObject } from 'react';
+type Handler = () => void;
+
+export default function useOnClickOutside(
+  ref: RefObject<HTMLElement>,
+  handler: Handler,
+  excludeIds: string[],
+  customCondition?: (target: EventTarget | Element | null) => boolean,
+): void {
+  useEffect(() => {
+    const handleClickOutside = (event: MouseEvent) => {
+      const target = event.target as Node | null;
+
+      if (target && 'id' in target && excludeIds.includes((target as HTMLElement).id)) {
+        return;
+      }
+
+      if (
+        target?.parentNode &&
+        'id' in target.parentNode &&
+        excludeIds.includes((target.parentNode as HTMLElement).id)
+      ) {
+        return;
+      }
+
+      if (customCondition && customCondition(target)) {
+        return;
+      }
+
+      if (ref.current && !ref.current.contains(target)) {
+        handler();
+      }
+    };
+
+    document.addEventListener('mousedown', handleClickOutside);
+    return () => {
+      document.removeEventListener('mousedown', handleClickOutside);
+    };
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [ref, handler]);
+}

packages/client/src/hooks/useToast.ts

@@ -0,0 +1,58 @@
+import { useAtom } from 'jotai';
+import { useRef, useEffect } from 'react';
+import type { TShowToast } from '~/common';
+import { NotificationSeverity } from '~/common';
+import { toastState, type ToastState } from '~/store';
+
+export default function useToast(showDelay = 100) {
+  const [toast, setToast] = useAtom(toastState);
+  const showTimerRef = useRef<number | null>(null);
+  const hideTimerRef = useRef<number | null>(null);
+
+  useEffect(() => {
+    return () => {
+      if (showTimerRef.current !== null) {
+        clearTimeout(showTimerRef.current);
+      }
+      if (hideTimerRef.current !== null) {
+        clearTimeout(hideTimerRef.current);
+      }
+    };
+  }, []);
+
+  const showToast = ({
+    message,
+    severity = NotificationSeverity.SUCCESS,
+    showIcon = true,
+    duration = 3000, // default duration for the toast to be visible
+    status,
+  }: TShowToast) => {
+    // Clear existing timeouts
+    if (showTimerRef.current !== null) {
+      clearTimeout(showTimerRef.current);
+    }
+    if (hideTimerRef.current !== null) {
+      clearTimeout(hideTimerRef.current);
+    }
+
+    // Timeout to show the toast
+    showTimerRef.current = window.setTimeout(() => {
+      setToast({
+        open: true,
+        message,
+        severity: (status as NotificationSeverity) ?? severity,
+        showIcon,
+      });
+      // Hides the toast after the specified duration
+      hideTimerRef.current = window.setTimeout(() => {
+        setToast((prevToast: ToastState) => ({ ...prevToast, open: false }));
+      }, duration);
+    }, showDelay);
+  };
+
+  return {
+    toast,
+    onOpenChange: (open: boolean) => setToast({ ...toast, open }),
+    showToast,
+  };
+}