mirror of
https://github.com/danny-avila/LibreChat.git
synced 2025-12-17 17:00:15 +01:00
* WIP: first pass ModelSpecs * refactor(onSelectEndpoint): use `getConvoSwitchLogic` * feat: introduce iconURL, greeting, frontend fields for conversations/presets/messages * feat: conversation.iconURL & greeting in Landing * feat: conversation.iconURL & greeting in New Chat button * feat: message.iconURL * refactor: ConversationIcon -> ConvoIconURL * WIP: add spec as a conversation field * refactor: useAppStartup, set spec on initial load for new chat, allow undefined spec, add localStorage keys enum, additional type fields for spec * feat: handle `showIconInMenu`, `showIconInHeader`, undefined `iconURL` and no specs on initial load * chore: handle undefined or empty modelSpecs * WIP: first pass, modelSpec schema for custom config * refactor: move default filtered tools definition to ToolService * feat: pass modelSpecs from backend via startupConfig * refactor: modelSpecs config, return and define list * fix: react error and include iconURL in responseMessage * refactor: add iconURL to responseMessage only * refactor: getIconEndpoint * refactor: pass TSpecsConfig * fix(assistants): differentiate compactAssistantSchema, correctly resets shared conversation state with other endpoints * refactor: assistant id prefix localStorage key * refactor: add more LocalStorageKeys and replace hardcoded values * feat: prioritize spec on new chat behavior: last selected modelSpec behavior (localStorage) * feat: first pass, interface config * chore: WIP, todo: add warnings based on config.modelSpecs settings. * feat: enforce modelSpecs if configured * feat: show config file yaml errors * chore: delete unused legacy Plugins component * refactor: set tools to localStorage from recoil store * chore: add stable recoil setter to useEffect deps * refactor: save tools to conversation documents * style(MultiSelectPop): dynamic height, remove unused import * refactor(react-query): use localstorage keys and pass config to useAvailablePluginsQuery * feat(utils): add mapPlugins * refactor(Convo): use conversation.tools if defined, lastSelectedTools if not * refactor: remove unused legacy code using `useSetOptions`, remove conditional flag `isMultiChat` for using legacy settings * refactor(PluginStoreDialog): add exhaustive-deps which are stable react state setters * fix(HeaderOptions): pass `popover` as true * refactor(useSetStorage): use project enums * refactor: use LocalStorageKeys enum * fix: prevent setConversation from setting falsy values in lastSelectedTools * refactor: use map for availableTools state and available Plugins query * refactor(updateLastSelectedModel): organize logic better and add note on purpose * fix(setAgentOption): prevent reseting last model to secondary model for gptPlugins * refactor(buildDefaultConvo): use enum * refactor: remove `useSetStorage` and consolidate areas where conversation state is saved to localStorage * fix: conversations retain tools on refresh * fix(gptPlugins): prevent nullish tools from being saved * chore: delete useServerStream * refactor: move initial plugins logic to useAppStartup * refactor(MultiSelectDropDown): add more pass-in className props * feat: use tools in presets * chore: delete unused usePresetOptions * refactor: new agentOptions default handling * chore: note * feat: add label and custom instructions to agents * chore: remove 'disabled with tools' message * style: move plugins to 2nd column in parameters * fix: TPreset type for agentOptions * fix: interface controls * refactor: add interfaceConfig, use Separator within Switcher * refactor: hide Assistants panel if interface.parameters are disabled * fix(Header): only modelSpecs if list is greater than 0 * refactor: separate MessageIcon logic from useMessageHelpers for better react rule-following * fix(AppService): don't use reserved keyword 'interface' * feat: set existing Icon for custom endpoints through iconURL * fix(ci): tests passing for App Service * docs: refactor custom_config.md for readability and better organization, also include missing values * docs: interface section and re-organize docs * docs: update modelSpecs info * chore: remove unused files * chore: remove unused files * chore: move useSetIndexOptions * chore: remove unused file * chore: move useConversation(s) * chore: move useDefaultConvo * chore: move useNavigateToConvo * refactor: use plugin install hook so it can be used elsewhere * chore: import order * update docs * refactor(OpenAI/Plugins): allow modelLabel as an initial value for chatGptLabel * chore: remove unused EndpointOptionsPopover and hide 'Save as Preset' button if preset UI visibility disabled * feat(loadDefaultInterface): issue warnings based on values * feat: changelog for custom config file * docs: add additional changelog note * fix: prevent unavailable tool selection from preset and update availableTools on Plugin installations * feat: add `filteredTools` option in custom config * chore: changelog * fix(MessageIcon): always overwrite conversation.iconURL in messageSettings * fix(ModelSpecsMenu): icon edge cases * fix(NewChat): dynamic icon * fix(PluginsClient): always include endpoint in responseMessage * fix: always include endpoint and iconURL in responseMessage across different response methods * feat: interchangeable keys for modelSpec enforcing
170 lines
4.6 KiB
TypeScript
170 lines
4.6 KiB
TypeScript
import { useRecoilValue, useSetRecoilState } from 'recoil';
|
|
import { TPreset, TPlugin, TConversation, tConvoUpdateSchema } from 'librechat-data-provider';
|
|
import type { TSetExample, TSetOption, TSetOptionsPayload } from '~/common';
|
|
import usePresetIndexOptions from './usePresetIndexOptions';
|
|
import { useChatContext } from '~/Providers/ChatContext';
|
|
import store from '~/store';
|
|
|
|
type TUseSetOptions = (preset?: TPreset | boolean | null) => TSetOptionsPayload;
|
|
|
|
const useSetIndexOptions: TUseSetOptions = (preset = false) => {
|
|
const setShowPluginStoreDialog = useSetRecoilState(store.showPluginStoreDialog);
|
|
const availableTools = useRecoilValue(store.availableTools);
|
|
const { conversation, setConversation } = useChatContext();
|
|
|
|
const result = usePresetIndexOptions(preset);
|
|
|
|
if (result && typeof result !== 'boolean') {
|
|
return result;
|
|
}
|
|
|
|
const setOption: TSetOption = (param) => (newValue) => {
|
|
const update = {};
|
|
update[param] = newValue;
|
|
|
|
if (param === 'presetOverride') {
|
|
const currentOverride = conversation?.presetOverride || {};
|
|
update['presetOverride'] = {
|
|
...currentOverride,
|
|
...(newValue as unknown as Partial<TPreset>),
|
|
};
|
|
}
|
|
|
|
setConversation(
|
|
(prevState) =>
|
|
tConvoUpdateSchema.parse({
|
|
...prevState,
|
|
...update,
|
|
}) as TConversation,
|
|
);
|
|
};
|
|
|
|
const setExample: TSetExample = (i, type, newValue = null) => {
|
|
const update = {};
|
|
const current = conversation?.examples?.slice() || [];
|
|
const currentExample = { ...current[i] } || {};
|
|
currentExample[type] = { content: newValue };
|
|
current[i] = currentExample;
|
|
update['examples'] = current;
|
|
setConversation(
|
|
(prevState) =>
|
|
tConvoUpdateSchema.parse({
|
|
...prevState,
|
|
...update,
|
|
}) as TConversation,
|
|
);
|
|
};
|
|
|
|
const addExample: () => void = () => {
|
|
const update = {};
|
|
const current = conversation?.examples?.slice() || [];
|
|
current.push({ input: { content: '' }, output: { content: '' } });
|
|
update['examples'] = current;
|
|
setConversation(
|
|
(prevState) =>
|
|
tConvoUpdateSchema.parse({
|
|
...prevState,
|
|
...update,
|
|
}) as TConversation,
|
|
);
|
|
};
|
|
|
|
const removeExample: () => void = () => {
|
|
const update = {};
|
|
const current = conversation?.examples?.slice() || [];
|
|
if (current.length <= 1) {
|
|
update['examples'] = [{ input: { content: '' }, output: { content: '' } }];
|
|
setConversation(
|
|
(prevState) =>
|
|
tConvoUpdateSchema.parse({
|
|
...prevState,
|
|
...update,
|
|
}) as TConversation,
|
|
);
|
|
return;
|
|
}
|
|
current.pop();
|
|
update['examples'] = current;
|
|
setConversation(
|
|
(prevState) =>
|
|
tConvoUpdateSchema.parse({
|
|
...prevState,
|
|
...update,
|
|
}) as TConversation,
|
|
);
|
|
};
|
|
|
|
function checkPluginSelection(value: string) {
|
|
if (!conversation?.tools) {
|
|
return false;
|
|
}
|
|
return conversation.tools.find((el) => {
|
|
if (typeof el === 'string') {
|
|
return el === value;
|
|
}
|
|
return el.pluginKey === value;
|
|
})
|
|
? true
|
|
: false;
|
|
}
|
|
|
|
const setAgentOption: TSetOption = (param) => (newValue) => {
|
|
const editableConvo = JSON.stringify(conversation);
|
|
const convo = JSON.parse(editableConvo);
|
|
const { agentOptions } = convo;
|
|
agentOptions[param] = newValue;
|
|
|
|
setConversation(
|
|
(prevState) =>
|
|
tConvoUpdateSchema.parse({
|
|
...prevState,
|
|
agentOptions,
|
|
}) as TConversation,
|
|
);
|
|
};
|
|
|
|
const setTools: (newValue: string, remove?: boolean) => void = (newValue, remove) => {
|
|
if (newValue === 'pluginStore') {
|
|
setShowPluginStoreDialog(true);
|
|
return;
|
|
}
|
|
|
|
const update = {};
|
|
const current =
|
|
conversation?.tools
|
|
?.map((tool: string | TPlugin) => {
|
|
if (typeof tool === 'string') {
|
|
return availableTools[tool];
|
|
}
|
|
return tool;
|
|
})
|
|
?.filter((el) => !!el) || [];
|
|
const isSelected = checkPluginSelection(newValue);
|
|
const tool = availableTools[newValue];
|
|
if (isSelected || remove) {
|
|
update['tools'] = current.filter((el) => el.pluginKey !== newValue);
|
|
} else {
|
|
update['tools'] = [...current, tool];
|
|
}
|
|
|
|
setConversation(
|
|
(prevState) =>
|
|
tConvoUpdateSchema.parse({
|
|
...prevState,
|
|
...update,
|
|
}) as TConversation,
|
|
);
|
|
};
|
|
|
|
return {
|
|
setOption,
|
|
setExample,
|
|
addExample,
|
|
removeExample,
|
|
setAgentOption,
|
|
checkPluginSelection,
|
|
setTools,
|
|
};
|
|
};
|
|
|
|
export default useSetIndexOptions;
|