LibreChat/client/src/utils/artifacts.ts
Danny Avila a288ad1d9c
🪄 feat: Artifacts Badge & Optimize Ephemeral Agent State (#8252)
* 🔧 fix: Update type annotations in useEventHandlers for better type safety

* 🔧 refactor: `useToolToggle` for improved localStorage synchronization and allow string/falsy values for setting to storage

*  feat: Implement Artifacts badge to BadgeRow with toggle options and UI components

- Added Artifacts component to manage artifacts state and options.
- Introduced ArtifactsSubMenu for additional settings related to artifacts.
- Integrated artifacts functionality into BadgeRow and ToolsDropdown components.
- Updated localStorage handling for artifacts state persistence.
- Enhanced localization for artifacts-related strings in translation files.
- Refactored Agent model to include artifacts in the ephemeral agent response.

* fix: set ephemeral agent state for conversation on finalization

* chore: remove beta settings dialog tab

* refactor: improve Ephemeral Agent statefulness

* fix: update setValue parameter to use 'value' instead of 'isChecked' in CheckboxButton

* refactor: update color classes for Artifact toggle and order of dropdown components

* chore: remove unused i18n localization
2025-07-04 13:25:04 -04:00

197 lines
6.6 KiB
TypeScript

import dedent from 'dedent';
import { shadcnComponents } from 'librechat-data-provider';
import type {
SandpackProviderProps,
SandpackPredefinedTemplate,
} from '@codesandbox/sandpack-react';
const artifactFilename = {
'application/vnd.mermaid': 'App.tsx',
'application/vnd.react': 'App.tsx',
'text/html': 'index.html',
'application/vnd.code-html': 'index.html',
default: 'index.html',
// 'css': 'css',
// 'javascript': 'js',
// 'typescript': 'ts',
// 'jsx': 'jsx',
// 'tsx': 'tsx',
};
const artifactTemplate: Record<
keyof typeof artifactFilename,
SandpackPredefinedTemplate | undefined
> = {
'text/html': 'static',
'application/vnd.react': 'react-ts',
'application/vnd.mermaid': 'react-ts',
'application/vnd.code-html': 'static',
default: 'static',
// 'css': 'css',
// 'javascript': 'js',
// 'typescript': 'ts',
// 'jsx': 'jsx',
// 'tsx': 'tsx',
};
export function getFileExtension(language?: string): string {
switch (language) {
case 'application/vnd.react':
return 'tsx';
case 'application/vnd.mermaid':
return 'mermaid';
case 'text/html':
return 'html';
// case 'jsx':
// return 'jsx';
// case 'tsx':
// return 'tsx';
// case 'html':
// return 'html';
// case 'css':
// return 'css';
default:
return 'txt';
}
}
export function getKey(type: string, language?: string): string {
return `${type}${(language?.length ?? 0) > 0 ? `-${language}` : ''}`;
}
export function getArtifactFilename(type: string, language?: string): string {
const key = getKey(type, language);
return artifactFilename[key] ?? artifactFilename.default;
}
export function getTemplate(type: string, language?: string): SandpackPredefinedTemplate {
const key = getKey(type, language);
return artifactTemplate[key] ?? (artifactTemplate.default as SandpackPredefinedTemplate);
}
const standardDependencies = {
three: '^0.167.1',
'lucide-react': '^0.394.0',
'react-router-dom': '^6.11.2',
'class-variance-authority': '^0.6.0',
clsx: '^1.2.1',
'date-fns': '^3.3.1',
'tailwind-merge': '^1.9.1',
'tailwindcss-animate': '^1.0.5',
recharts: '2.12.7',
'@radix-ui/react-accordion': '^1.1.2',
'@radix-ui/react-alert-dialog': '^1.0.2',
'@radix-ui/react-aspect-ratio': '^1.1.0',
'@radix-ui/react-avatar': '^1.1.0',
'@radix-ui/react-checkbox': '^1.0.3',
'@radix-ui/react-collapsible': '^1.0.3',
'@radix-ui/react-dialog': '^1.0.2',
'@radix-ui/react-dropdown-menu': '^2.1.1',
'@radix-ui/react-hover-card': '^1.0.5',
'@radix-ui/react-label': '^2.0.0',
'@radix-ui/react-menubar': '^1.1.1',
'@radix-ui/react-navigation-menu': '^1.2.0',
'@radix-ui/react-popover': '^1.0.7',
'@radix-ui/react-progress': '^1.1.0',
'@radix-ui/react-radio-group': '^1.1.3',
'@radix-ui/react-select': '^2.0.0',
'@radix-ui/react-separator': '^1.0.3',
'@radix-ui/react-slider': '^1.1.1',
'@radix-ui/react-switch': '^1.0.3',
'@radix-ui/react-tabs': '^1.0.3',
'@radix-ui/react-toast': '^1.1.5',
'@radix-ui/react-slot': '^1.1.0',
'@radix-ui/react-toggle': '^1.1.0',
'@radix-ui/react-toggle-group': '^1.1.0',
'embla-carousel-react': '^8.2.0',
'react-day-picker': '^9.0.8',
'dat.gui': '^0.7.9',
vaul: '^0.9.1',
};
const mermaidDependencies = Object.assign(
{
mermaid: '^11.4.1',
'react-zoom-pan-pinch': '^3.6.1',
},
standardDependencies,
);
const dependenciesMap: Record<keyof typeof artifactFilename, object> = {
'application/vnd.mermaid': mermaidDependencies,
'application/vnd.react': standardDependencies,
'text/html': standardDependencies,
'application/vnd.code-html': standardDependencies,
default: standardDependencies,
};
export function getDependencies(type: string): Record<string, string> {
return dependenciesMap[type] ?? standardDependencies;
}
export function getProps(type: string): Partial<SandpackProviderProps> {
return {
customSetup: {
dependencies: getDependencies(type),
},
};
}
export const sharedOptions: SandpackProviderProps['options'] = {
externalResources: ['https://unpkg.com/@tailwindcss/ui/dist/tailwind-ui.min.css'],
};
export const sharedFiles = {
'/lib/utils.ts': shadcnComponents.utils,
'/components/ui/accordion.tsx': shadcnComponents.accordian,
'/components/ui/alert-dialog.tsx': shadcnComponents.alertDialog,
'/components/ui/alert.tsx': shadcnComponents.alert,
'/components/ui/avatar.tsx': shadcnComponents.avatar,
'/components/ui/badge.tsx': shadcnComponents.badge,
'/components/ui/breadcrumb.tsx': shadcnComponents.breadcrumb,
'/components/ui/button.tsx': shadcnComponents.button,
'/components/ui/calendar.tsx': shadcnComponents.calendar,
'/components/ui/card.tsx': shadcnComponents.card,
'/components/ui/carousel.tsx': shadcnComponents.carousel,
'/components/ui/checkbox.tsx': shadcnComponents.checkbox,
'/components/ui/collapsible.tsx': shadcnComponents.collapsible,
'/components/ui/dialog.tsx': shadcnComponents.dialog,
'/components/ui/drawer.tsx': shadcnComponents.drawer,
'/components/ui/dropdown-menu.tsx': shadcnComponents.dropdownMenu,
'/components/ui/input.tsx': shadcnComponents.input,
'/components/ui/label.tsx': shadcnComponents.label,
'/components/ui/menubar.tsx': shadcnComponents.menuBar,
'/components/ui/navigation-menu.tsx': shadcnComponents.navigationMenu,
'/components/ui/pagination.tsx': shadcnComponents.pagination,
'/components/ui/popover.tsx': shadcnComponents.popover,
'/components/ui/progress.tsx': shadcnComponents.progress,
'/components/ui/radio-group.tsx': shadcnComponents.radioGroup,
'/components/ui/select.tsx': shadcnComponents.select,
'/components/ui/separator.tsx': shadcnComponents.separator,
'/components/ui/skeleton.tsx': shadcnComponents.skeleton,
'/components/ui/slider.tsx': shadcnComponents.slider,
'/components/ui/switch.tsx': shadcnComponents.switchComponent,
'/components/ui/table.tsx': shadcnComponents.table,
'/components/ui/tabs.tsx': shadcnComponents.tabs,
'/components/ui/textarea.tsx': shadcnComponents.textarea,
'/components/ui/toast.tsx': shadcnComponents.toast,
'/components/ui/toaster.tsx': shadcnComponents.toaster,
'/components/ui/toggle-group.tsx': shadcnComponents.toggleGroup,
'/components/ui/toggle.tsx': shadcnComponents.toggle,
'/components/ui/tooltip.tsx': shadcnComponents.tooltip,
'/components/ui/use-toast.tsx': shadcnComponents.useToast,
'/public/index.html': dedent`
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Document</title>
<script src="https://cdn.tailwindcss.com"></script>
</head>
<body>
<div id="root"></div>
</body>
</html>
`,
};