librechat-data-provider 0.7.430 → 0.7.692

package/src/request.ts

@@ -1,7 +1,8 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
-import axios, { AxiosRequestConfig, AxiosError } from 'axios';
-import { setTokenHeader } from './headers-helpers';
+import axios, { AxiosError, AxiosRequestConfig } from 'axios';
 import * as endpoints from './api-endpoints';
+import { setTokenHeader } from './headers-helpers';
+import type * as t from './types';
 
 async function _get<T>(url: string, options?: AxiosRequestConfig): Promise<T> {
   const response = await axios.get(url, { ...options });
@@ -63,7 +64,13 @@ async function _patch(url: string, data?: any) {
 let isRefreshing = false;
 let failedQueue: { resolve: (value?: any) => void; reject: (reason?: any) => void }[] = [];
 
-const refreshToken = (retry?: boolean) => _post(endpoints.refreshToken(retry));
+const refreshToken = (retry?: boolean): Promise<t.TRefreshTokenResponse | undefined> =>
+  _post(endpoints.refreshToken(retry));
+
+const dispatchTokenUpdatedEvent = (token: string) => {
+  setTokenHeader(token);
+  window.dispatchEvent(new CustomEvent('tokenUpdated', { detail: token }));
+};
 
 const processQueue = (error: AxiosError | null, token: string | null = null) => {
   failedQueue.forEach((prom) => {
@@ -85,6 +92,7 @@ axios.interceptors.response.use(
     }
 
     if (error.response.status === 401 && !originalRequest._retry) {
+      console.warn('401 error, refreshing token');
       originalRequest._retry = true;
 
       if (isRefreshing) {
@@ -102,17 +110,22 @@ axios.interceptors.response.use(
       isRefreshing = true;
 
       try {
-        const { token } = await refreshToken(
+        const response = await refreshToken(
           // Handle edge case where we get a blank screen if the initial 401 error is from a refresh token request
-          originalRequest.url?.includes('api/auth/refresh') ? true : false,
+          originalRequest.url?.includes('api/auth/refresh') === true ? true : false,
         );
 
+        const token = response?.token ?? '';
+
         if (token) {
           originalRequest.headers['Authorization'] = 'Bearer ' + token;
-          setTokenHeader(token);
-          window.dispatchEvent(new CustomEvent('tokenUpdated', { detail: token }));
+          dispatchTokenUpdatedEvent(token);
           processQueue(null, token);
           return await axios(originalRequest);
+        } else if (window.location.href.includes('share/')) {
+          console.log(
+            `Refresh token failed from shared link, attempting request to ${originalRequest.url}`,
+          );
         } else {
           window.location.href = '/login';
         }
@@ -139,4 +152,5 @@ export default {
   deleteWithOptions: _deleteWithOptions,
   patch: _patch,
   refreshToken,
+  dispatchTokenUpdatedEvent,
 };

package/src/schemas.ts

@@ -8,7 +8,7 @@ export const isUUID = z.string().uuid();
 export enum AuthType {
   OVERRIDE_AUTH = 'override_auth',
   USER_PROVIDED = 'user_provided',
-  SYSTEM_DEFINED = 'SYSTEM_DEFINED',
+  SYSTEM_DEFINED = 'system_defined',
 }
 
 export const authTypeSchema = z.nativeEnum(AuthType);
@@ -16,16 +16,19 @@ export const authTypeSchema = z.nativeEnum(AuthType);
 export enum EModelEndpoint {
   azureOpenAI = 'azureOpenAI',
   openAI = 'openAI',
-  bingAI = 'bingAI',
-  chatGPTBrowser = 'chatGPTBrowser',
   google = 'google',
-  gptPlugins = 'gptPlugins',
   anthropic = 'anthropic',
   assistants = 'assistants',
   azureAssistants = 'azureAssistants',
   agents = 'agents',
   custom = 'custom',
   bedrock = 'bedrock',
+  /** @deprecated */
+  bingAI = 'bingAI',
+  /** @deprecated */
+  chatGPTBrowser = 'chatGPTBrowser',
+  /** @deprecated */
+  gptPlugins = 'gptPlugins',
 }
 
 export const paramEndpoints = new Set<EModelEndpoint | string>([
@@ -49,7 +52,11 @@ export enum BedrockProviders {
 
 export const getModelKey = (endpoint: EModelEndpoint | string, model: string) => {
   if (endpoint === EModelEndpoint.bedrock) {
-    return model.split('.')[0] as BedrockProviders;
+    const parts = model.split('.');
+    const provider = [parts[0], parts[1]].find((part) =>
+      Object.values(BedrockProviders).includes(part as BedrockProviders),
+    );
+    return (provider ?? parts[0]) as BedrockProviders;
   }
   return model;
 };
@@ -128,6 +135,7 @@ export const defaultAssistantFormValues = {
   code_interpreter: false,
   image_vision: false,
   retrieval: false,
+  append_current_datetime: false,
 };
 
 export const defaultAgentFormValues = {
@@ -368,8 +376,8 @@ export const tPluginSchema = z.object({
   name: z.string(),
   pluginKey: z.string(),
   description: z.string(),
-  icon: z.string(),
-  authConfig: z.array(tPluginAuthConfigSchema),
+  icon: z.string().optional(),
+  authConfig: z.array(tPluginAuthConfigSchema).optional(),
   authenticated: z.boolean().optional(),
   isButton: z.boolean().optional(),
 });
@@ -445,12 +453,13 @@ export const tMessageSchema = z.object({
   bg: z.string().nullable().optional(),
   model: z.string().nullable().optional(),
   title: z.string().nullable().or(z.literal('New Chat')).default('New Chat'),
-  sender: z.string(),
+  sender: z.string().optional(),
   text: z.string(),
   generation: z.string().nullable().optional(),
   isEdited: z.boolean().optional(),
   isCreatedByUser: z.boolean(),
-  error: z.boolean(),
+  error: z.boolean().optional(),
+  clientTimestamp: z.string().optional(),
   createdAt: z
     .string()
     .optional()
@@ -485,6 +494,7 @@ export type TMessage = z.input<typeof tMessageSchema> & {
   depth?: number;
   siblingIndex?: number;
   attachments?: TAttachment[];
+  clientTimestamp?: string;
 };
 
 export const coerceNumber = z.union([z.number(), z.string()]).transform((val) => {
@@ -516,7 +526,7 @@ const DocumentType: z.ZodType<DocumentTypeValue> = z.lazy(() =>
 export const tConversationSchema = z.object({
   conversationId: z.string().nullable(),
   endpoint: eModelEndpointSchema.nullable(),
-  endpointType: eModelEndpointSchema.optional(),
+  endpointType: eModelEndpointSchema.nullable().optional(),
   isArchived: z.boolean().optional(),
   title: z.string().nullable().or(z.literal('New Chat')).default('New Chat'),
   user: z.string().optional(),
@@ -549,9 +559,9 @@ export const tConversationSchema = z.object({
   createdAt: z.string(),
   updatedAt: z.string(),
   /* Files */
+  resendFiles: z.boolean().optional(),
   file_ids: z.array(z.string()).optional(),
   /* vision */
-  resendFiles: z.boolean().optional(),
   imageDetail: eImageDetailSchema.optional(),
   /* assistant */
   assistant_id: z.string().optional(),
@@ -561,16 +571,17 @@ export const tConversationSchema = z.object({
   region: z.string().optional(),
   maxTokens: coerceNumber.optional(),
   additionalModelRequestFields: DocumentType.optional(),
-  /* assistant + agents */
+  /* assistants */
   instructions: z.string().optional(),
   additional_instructions: z.string().optional(),
+  append_current_datetime: z.boolean().optional(),
   /** Used to overwrite active conversation settings when saving a Preset */
   presetOverride: z.record(z.unknown()).optional(),
   stop: z.array(z.string()).optional(),
   /* frontend components */
-  iconURL: z.string().optional(),
   greeting: z.string().optional(),
-  spec: z.string().optional(),
+  spec: z.string().nullable().optional(),
+  iconURL: z.string().nullable().optional(),
   /*
   Deprecated fields
   */
@@ -622,11 +633,77 @@ export const tConvoUpdateSchema = tConversationSchema.merge(
   }),
 );
 
-export const tPresetUpdateSchema = tConversationSchema.merge(
-  z.object({
-    endpoint: extendedModelEndpointSchema.nullable(),
-  }),
-);
+export const tQueryParamsSchema = tConversationSchema
+  .pick({
+    // librechat settings
+    /** The AI context window, overrides the system-defined window as determined by `model` value */
+    maxContextTokens: true,
+    /**
+     * Whether or not to re-submit files from previous messages on subsequent messages
+     * */
+    resendFiles: true,
+    /**
+     * @endpoints openAI, custom, azureOpenAI
+     *
+     * System parameter that only affects the above endpoints.
+     * Image detail for re-sizing according to OpenAI spec, defaults to `auto`
+     * */
+    imageDetail: true,
+    /**
+     * AKA Custom Instructions, dynamically added to chat history as a system message;
+     * for `bedrock` endpoint, this is used as the `system` model param if the provider uses it;
+     * for `assistants` endpoint, this is used as the `additional_instructions` model param:
+     * https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-additional_instructions
+     * ; otherwise, a message with `system` role is added to the chat history
+     */
+    promptPrefix: true,
+    // Model parameters
+    /** @endpoints openAI, custom, azureOpenAI, google, anthropic, assistants, azureAssistants, bedrock */
+    model: true,
+    /** @endpoints openAI, custom, azureOpenAI, google, anthropic, bedrock */
+    temperature: true,
+    /** @endpoints openAI, custom, azureOpenAI */
+    presence_penalty: true,
+    /** @endpoints openAI, custom, azureOpenAI */
+    frequency_penalty: true,
+    /** @endpoints openAI, custom, azureOpenAI */
+    stop: true,
+    /** @endpoints openAI, custom, azureOpenAI */
+    top_p: true,
+    /** @endpoints openAI, custom, azureOpenAI */
+    max_tokens: true,
+    /** @endpoints google, anthropic, bedrock */
+    topP: true,
+    /** @endpoints google, anthropic */
+    topK: true,
+    /** @endpoints google, anthropic */
+    maxOutputTokens: true,
+    /** @endpoints anthropic */
+    promptCache: true,
+    /** @endpoints bedrock */
+    region: true,
+    /** @endpoints bedrock */
+    maxTokens: true,
+    /** @endpoints agents */
+    agent_id: true,
+    /** @endpoints assistants, azureAssistants */
+    assistant_id: true,
+    /** @endpoints assistants, azureAssistants */
+    append_current_datetime: true,
+    /**
+     * @endpoints assistants, azureAssistants
+     *
+     * Overrides existing assistant instructions, only used for the current run:
+     * https://platform.openai.com/docs/api-reference/runs/createRun#runs-createrun-instructions
+     * */
+    instructions: true,
+  })
+  .merge(
+    z.object({
+      /** @endpoints openAI, custom, azureOpenAI, google, anthropic, assistants, azureAssistants, bedrock, agents */
+      endpoint: extendedModelEndpointSchema.nullable(),
+    }),
+  );
 
 export type TPreset = z.infer<typeof tPresetSchema>;
 
@@ -849,6 +926,7 @@ export const assistantSchema = tConversationSchema
     iconURL: true,
     greeting: true,
     spec: true,
+    append_current_datetime: true,
   })
   .transform((obj) => ({
     ...obj,
@@ -859,6 +937,7 @@ export const assistantSchema = tConversationSchema
     iconURL: obj.iconURL ?? undefined,
     greeting: obj.greeting ?? undefined,
     spec: obj.spec ?? undefined,
+    append_current_datetime: obj.append_current_datetime ?? false,
   }))
   .catch(() => ({
     model: openAISettings.model.default,
@@ -868,6 +947,7 @@ export const assistantSchema = tConversationSchema
     iconURL: undefined,
     greeting: undefined,
     spec: undefined,
+    append_current_datetime: false,
   }));
 
 export const compactAssistantSchema = tConversationSchema
@@ -1096,13 +1176,14 @@ export type TBanner = z.infer<typeof tBannerSchema>;
 
 export const compactAgentsSchema = tConversationSchema
   .pick({
-    model: true,
+    spec: true,
+    // model: true,
+    iconURL: true,
+    greeting: true,
     agent_id: true,
+    resendFiles: true,
     instructions: true,
     additional_instructions: true,
-    iconURL: true,
-    greeting: true,
-    spec: true,
   })
   .transform(removeNullishValues)
   .catch(() => ({}));

package/src/types/agents.ts

@@ -1,6 +1,7 @@
 /* eslint-disable @typescript-eslint/no-namespace */
 import { StepTypes, ContentTypes, ToolCallTypes } from './runs';
 import type { FunctionToolCall } from './assistants';
+import type { TAttachment } from 'src/schemas';
 
 export namespace Agents {
   export type MessageType = 'human' | 'ai' | 'generic' | 'system' | 'function' | 'tool' | 'remove';
@@ -218,3 +219,14 @@ export namespace Agents {
   }
   export type ContentType = ContentTypes.TEXT | ContentTypes.IMAGE_URL | string;
 }
+
+export type ToolCallResult = {
+  user: string;
+  toolId: string;
+  result?: unknown;
+  messageId: string;
+  partIndex?: number;
+  blockIndex?: number;
+  conversationId: string;
+  attachments?: TAttachment[];
+};

package/src/types/assistants.ts

@@ -100,6 +100,7 @@ export type AssistantCreateParams = {
   tools?: Array<FunctionTool | string>;
   endpoint: AssistantsEndpoint;
   version: number | string;
+  append_current_datetime?: boolean;
 };
 
 export type AssistantUpdateParams = {
@@ -113,6 +114,7 @@ export type AssistantUpdateParams = {
   tools?: Array<FunctionTool | string>;
   tool_resources?: ToolResources;
   endpoint: AssistantsEndpoint;
+  append_current_datetime?: boolean;
 };
 
 export type AssistantListParams = {
@@ -147,6 +149,7 @@ export type File = {
 export type AgentParameterValue = number | null;
 
 export type AgentModelParameters = {
+  model?: string;
   temperature: AgentParameterValue;
   max_context_tokens: AgentParameterValue;
   max_output_tokens: AgentParameterValue;
@@ -165,6 +168,10 @@ export interface ExecuteCodeResource {
    * There can be a maximum of 20 files associated with the tool.
    */
   file_ids?: Array<string>;
+  /**
+   * A list of files already fetched.
+   */
+  files?: Array<TFile>;
 }
 
 export interface AgentFileSearchResource {
@@ -178,12 +185,18 @@ export interface AgentFileSearchResource {
    * To be used before vector stores are implemented.
    */
   file_ids?: Array<string>;
+  /**
+   * A list of files already fetched.
+   */
+  files?: Array<TFile>;
 }
 
 export type Agent = {
   id: string;
   name: string | null;
   author?: string | null;
+  /** The original custom endpoint name, lowercased */
+  endpoint?: string | null;
   authorName?: string | null;
   description: string | null;
   created_at: number;
@@ -199,6 +212,9 @@ export type Agent = {
   conversation_starters?: string[];
   isCollaborative?: boolean;
   tool_resources?: AgentToolResources;
+  agent_ids?: string[];
+  end_after_tools?: boolean;
+  hide_sequential_outputs?: boolean;
 };
 
 export type TAgentsMap = Record<string, Agent | undefined>;
@@ -213,7 +229,7 @@ export type AgentCreateParams = {
   provider: AgentProvider;
   model: string | null;
   model_parameters: AgentModelParameters;
-};
+} & Pick<Agent, 'agent_ids' | 'end_after_tools' | 'hide_sequential_outputs'>;
 
 export type AgentUpdateParams = {
   name?: string | null;
@@ -229,7 +245,7 @@ export type AgentUpdateParams = {
   projectIds?: string[];
   removeProjectIds?: string[];
   isCollaborative?: boolean;
-};
+} & Pick<Agent, 'agent_ids' | 'end_after_tools' | 'hide_sequential_outputs'>;
 
 export type AgentListParams = {
   limit?: number;
@@ -514,6 +530,7 @@ export type AssistantDocument = {
   actions?: string[];
   createdAt?: Date;
   updatedAt?: Date;
+  append_current_datetime?: boolean;
 };
 
 /* Agent types */

package/src/types/files.ts

@@ -69,6 +69,7 @@ export type TFile = {
   height?: number;
   expiresAt?: string | Date;
   preview?: string;
+  metadata?: { fileIdentifier?: string };
   createdAt?: string | Date;
   updatedAt?: string | Date;
 };

package/src/types/mutations.ts

@@ -1,6 +1,7 @@
 import * as types from '../types';
 import * as r from '../roles';
 import {
+  Tools,
   Assistant,
   AssistantCreateParams,
   AssistantUpdateParams,
@@ -125,6 +126,15 @@ export type UpdateAgentVariables = {
 
 export type UpdateAgentMutationOptions = MutationOptions<Agent, UpdateAgentVariables>;
 
+export type DuplicateAgentBody = {
+  agent_id: string;
+};
+
+export type DuplicateAgentMutationOptions = MutationOptions<
+  { agent: Agent; actions: Action[] },
+  Pick<DuplicateAgentBody, 'agent_id'>
+>;
+
 export type DeleteAgentBody = {
   agent_id: string;
 };
@@ -149,6 +159,11 @@ export type DeleteConversationOptions = MutationOptions<
   types.TDeleteConversationRequest
 >;
 
+export type DuplicateConvoOptions = MutationOptions<
+  types.TDuplicateConvoResponse,
+  types.TDuplicateConvoRequest
+>;
+
 export type ForkConvoOptions = MutationOptions<types.TForkConvoResponse, types.TForkConvoRequest>;
 
 export type CreateSharedLinkOptions = MutationOptions<
@@ -222,18 +237,29 @@ export type RegistrationOptions = MutationOptions<
   types.TError
 >;
 
-export type UpdatePromptPermVars = {
+export type UpdatePermVars<T> = {
   roleName: string;
-  updates: Partial<r.TPromptPermissions>;
+  updates: Partial<T>;
 };
 
-export type UpdatePromptPermResponse = r.TRole;
+export type UpdatePromptPermVars = UpdatePermVars<r.TPromptPermissions>;
+
+export type UpdateAgentPermVars = UpdatePermVars<r.TAgentPermissions>;
+
+export type UpdatePermResponse = r.TRole;
 
 export type UpdatePromptPermOptions = MutationOptions<
-  UpdatePromptPermResponse,
+  UpdatePermResponse,
   UpdatePromptPermVars,
   unknown,
-  types.TError
+  types.TError | null | undefined
+>;
+
+export type UpdateAgentPermOptions = MutationOptions<
+  UpdatePermResponse,
+  UpdateAgentPermVars,
+  unknown,
+  types.TError | null | undefined
 >;
 
 export type UpdateConversationTagOptions = MutationOptions<
@@ -248,3 +274,27 @@ export type AcceptTermsMutationOptions = MutationOptions<
   unknown,
   void
 >;
+
+/* Tools */
+export type UpdatePluginAuthOptions = MutationOptions<types.TUser, types.TUpdateUserPlugins>;
+
+export type ToolParamsMap = {
+  [Tools.execute_code]: {
+    lang: string;
+    code: string;
+  };
+};
+
+export type ToolId = keyof ToolParamsMap;
+
+export type ToolParams<T extends ToolId> = ToolParamsMap[T] & {
+  messageId: string;
+  partIndex?: number;
+  blockIndex?: number;
+  conversationId: string;
+};
+export type ToolCallResponse = { result: unknown; attachments?: types.TAttachment[] };
+export type ToolCallMutationOptions<T extends ToolId> = MutationOptions<
+  ToolCallResponse,
+  ToolParams<T>
+>;

package/src/types/queries.ts

@@ -1,13 +1,14 @@
 import type { InfiniteData } from '@tanstack/react-query';
+import type * as a from '../types/agents';
+import type * as s from '../schemas';
 import type * as t from '../types';
-import type { TMessage, TConversation, TSharedLink, TConversationTag } from '../schemas';
 
 export type Conversation = {
   id: string;
   createdAt: number;
   participants: string[];
   lastMessage: string;
-  conversations: TConversation[];
+  conversations: s.TConversation[];
 };
 
 // Parameters for listing conversations (e.g., for pagination)
@@ -24,33 +25,33 @@ export type ConversationListParams = {
 
 // Type for the response from the conversation list API
 export type ConversationListResponse = {
-  conversations: TConversation[];
+  conversations: s.TConversation[];
   pageNumber: string;
   pageSize: string | number;
   pages: string | number;
-  messages: TMessage[];
+  messages: s.TMessage[];
 };
 
 export type ConversationData = InfiniteData<ConversationListResponse>;
 export type ConversationUpdater = (
   data: ConversationData,
-  conversation: TConversation,
+  conversation: s.TConversation,
 ) => ConversationData;
 
-export type SharedMessagesResponse = Omit<TSharedLink, 'messages'> & {
-  messages: TMessage[];
+export type SharedMessagesResponse = Omit<s.TSharedLink, 'messages'> & {
+  messages: s.TMessage[];
 };
 export type SharedLinkListParams = Omit<ConversationListParams, 'isArchived' | 'conversationId'> & {
   isPublic?: boolean;
 };
 
 export type SharedLinksResponse = Omit<ConversationListResponse, 'conversations' | 'messages'> & {
-  sharedLinks: TSharedLink[];
+  sharedLinks: s.TSharedLink[];
 };
 
 // Type for the response from the conversation list API
 export type SharedLinkListResponse = {
-  sharedLinks: TSharedLink[];
+  sharedLinks: s.TSharedLink[];
   pageNumber: string;
   pageSize: string | number;
   pages: string | number;
@@ -71,4 +72,10 @@ export type AllPromptGroupsFilterRequest = {
 
 export type AllPromptGroupsResponse = t.TPromptGroup[];
 
-export type ConversationTagsResponse = TConversationTag[];
+export type ConversationTagsResponse = s.TConversationTag[];
+
+export type VerifyToolAuthParams = { toolId: string };
+export type VerifyToolAuthResponse = { authenticated: boolean; message?: string | s.AuthType };
+
+export type GetToolCallParams = { conversationId: string };
+export type ToolCallResults = a.ToolCallResult[];