librechat-data-provider 0.7.4 → 0.7.7

package/src/types/mutations.ts

@@ -1,6 +1,7 @@
 import * as types from '../types';
 import * as r from '../roles';
 import {
+  Tools,
   Assistant,
   AssistantCreateParams,
   AssistantUpdateParams,
@@ -8,6 +9,9 @@ import {
   FunctionTool,
   AssistantDocument,
   Action,
+  Agent,
+  AgentCreateParams,
+  AgentUpdateParams,
 } from './assistants';
 
 export type MutationOptions<
@@ -20,6 +24,12 @@ export type MutationOptions<
   onSuccess?: (data: Response, variables: Request, context?: Context) => void;
   onMutate?: (variables: Request) => Snapshot | Promise<Snapshot>;
   onError?: (error: Error, variables: Request, context?: Context, snapshot?: Snapshot) => void;
+  onSettled?: (
+    data: Response | undefined,
+    error: Error | null,
+    variables: Request,
+    context?: Context,
+  ) => void;
 };
 
 export type TGenTitleRequest = {
@@ -39,7 +49,7 @@ export type UpdatePresetOptions = MutationOptions<types.TPreset, types.TPreset>;
 
 export type DeletePresetOptions = MutationOptions<PresetDeleteResponse, types.TPreset | undefined>;
 
-export type LogoutOptions = MutationOptions<unknown, undefined>;
+/* Assistant mutations */
 
 export type AssistantAvatarVariables = {
   assistant_id: string;
@@ -94,22 +104,98 @@ export type DeleteActionVariables = {
 
 export type DeleteActionOptions = MutationOptions<void, DeleteActionVariables>;
 
+/* Agent mutations */
+
+export type AgentAvatarVariables = {
+  agent_id: string;
+  formData: FormData;
+  postCreation?: boolean;
+};
+
+export type UpdateAgentActionVariables = {
+  agent_id: string;
+  action_id?: string;
+  metadata: ActionMetadata;
+  functions: FunctionTool[];
+};
+
+export type UploadAgentAvatarOptions = MutationOptions<Agent, AgentAvatarVariables>;
+
+export type CreateAgentMutationOptions = MutationOptions<Agent, AgentCreateParams>;
+
+export type UpdateAgentVariables = {
+  agent_id: string;
+  data: AgentUpdateParams;
+};
+
+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;
+};
+
+export type DeleteAgentMutationOptions = MutationOptions<void, Pick<DeleteAgentBody, 'agent_id'>>;
+
+export type UpdateAgentActionResponse = [Agent, Action];
+export type UpdateAgentActionOptions = MutationOptions<
+  UpdateAgentActionResponse,
+  UpdateAgentActionVariables
+>;
+
+export type DeleteAgentActionVariables = {
+  agent_id: string;
+  action_id: string;
+};
+
+export type DeleteAgentActionOptions = MutationOptions<void, DeleteAgentActionVariables>;
+
 export type DeleteConversationOptions = MutationOptions<
   types.TDeleteConversationResponse,
   types.TDeleteConversationRequest
 >;
 
+export type DuplicateConvoOptions = MutationOptions<
+  types.TDuplicateConvoResponse,
+  types.TDuplicateConvoRequest
+>;
+
 export type ForkConvoOptions = MutationOptions<types.TForkConvoResponse, types.TForkConvoRequest>;
 
 export type CreateSharedLinkOptions = MutationOptions<
   types.TSharedLink,
   Partial<types.TSharedLink>
 >;
+
+export type updateTagsInConvoOptions = MutationOptions<
+  types.TTagConversationResponse,
+  types.TTagConversationRequest
+>;
+
 export type UpdateSharedLinkOptions = MutationOptions<
   types.TSharedLink,
   Partial<types.TSharedLink>
 >;
-export type DeleteSharedLinkOptions = MutationOptions<types.TSharedLink, { shareId: string }>;
+
+export type ArchiveConvoOptions = MutationOptions<
+  types.TArchiveConversationResponse,
+  types.TArchiveConversationRequest
+>;
+
+export type DeleteSharedLinkContext = { previousQueries?: Map<string, TDeleteSharedLinkResponse> };
+export type DeleteSharedLinkOptions = MutationOptions<
+  TDeleteSharedLinkResponse,
+  { shareId: string },
+  DeleteSharedLinkContext
+>;
 
 export type TUpdatePromptContext =
   | {
@@ -160,16 +246,93 @@ 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<
+  types.TConversationTag,
+  types.TConversationTagRequest
+>;
+export type DeleteConversationTagOptions = MutationOptions<types.TConversationTag, string>;
+
+export type AcceptTermsMutationOptions = MutationOptions<
+  types.TAcceptTermsResponse,
+  void,
+  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>
 >;
+
+export type TDeleteSharedLinkResponse = {
+  success: boolean;
+  shareId: string;
+  message: string;
+};
+
+export type TEditArtifactRequest = {
+  index: number;
+  messageId: string;
+  original: string;
+  updated: string;
+};
+
+export type TEditArtifactResponse = Pick<types.TMessage, 'content' | 'text' | 'conversationId'>;
+
+export type EditArtifactOptions = MutationOptions<
+  TEditArtifactResponse,
+  TEditArtifactRequest,
+  unknown,
+  Error
+>;
+
+export type TLogoutResponse = {
+  message: string;
+  redirect?: string;
+};
+
+export type LogoutOptions = MutationOptions<TLogoutResponse, undefined>;

package/src/types/queries.ts

@@ -1,12 +1,14 @@
 import type { InfiniteData } from '@tanstack/react-query';
-import type { TMessage, TConversation, TSharedLink } from '../schemas';
+import type * as a from '../types/agents';
+import type * as s from '../schemas';
 import type * as t from '../types';
+
 export type Conversation = {
   id: string;
   createdAt: number;
   participants: string[];
   lastMessage: string;
-  conversations: TConversation[];
+  conversations: s.TConversation[];
 };
 
 // Parameters for listing conversations (e.g., for pagination)
@@ -15,46 +17,58 @@ export type ConversationListParams = {
   before?: string | null;
   after?: string | null;
   order?: 'asc' | 'desc';
-  pageNumber: string; // Add this line
+  pageNumber: string;
   conversationId?: string;
   isArchived?: boolean;
+  tags?: string[];
 };
 
 // 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 SharedLinkListParams = Omit<ConversationListParams, 'isArchived' | 'conversationId'> & {
-  isPublic?: boolean;
+export type SharedMessagesResponse = Omit<s.TSharedLink, 'messages'> & {
+  messages: s.TMessage[];
 };
 
-export type SharedLinksResponse = Omit<ConversationListResponse, 'conversations' | 'messages'> & {
-  sharedLinks: TSharedLink[];
-};
+export interface SharedLinksListParams {
+  pageSize: number;
+  isPublic: boolean;
+  sortBy: 'title' | 'createdAt';
+  sortDirection: 'asc' | 'desc';
+  search?: string;
+  cursor?: string;
+}
 
-// Type for the response from the conversation list API
-export type SharedLinkListResponse = {
-  sharedLinks: TSharedLink[];
-  pageNumber: string;
-  pageSize: string | number;
-  pages: string | number;
+export type SharedLinkItem = {
+  shareId: string;
+  title: string;
+  isPublic: boolean;
+  createdAt: Date;
+  conversationId: string;
 };
 
-export type SharedLinkListData = InfiniteData<SharedLinkListResponse>;
+export interface SharedLinksResponse {
+  links: SharedLinkItem[];
+  nextCursor: string | null;
+  hasNextPage: boolean;
+}
+
+export interface SharedLinkQueryData {
+  pages: SharedLinksResponse[];
+  pageParams: (string | null)[];
+}
 
 export type AllPromptGroupsFilterRequest = {
   category: string;
@@ -68,3 +82,11 @@ export type AllPromptGroupsFilterRequest = {
 };
 
 export type AllPromptGroupsResponse = t.TPromptGroup[];
+
+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[];

package/src/types/runs.ts

@@ -0,0 +1,23 @@
+export enum ContentTypes {
+  TEXT = 'text',
+  THINK = 'think',
+  TEXT_DELTA = 'text_delta',
+  TOOL_CALL = 'tool_call',
+  IMAGE_FILE = 'image_file',
+  IMAGE_URL = 'image_url',
+  ERROR = 'error',
+}
+
+export enum StepTypes {
+  TOOL_CALLS = 'tool_calls',
+  MESSAGE_CREATION = 'message_creation',
+}
+
+export enum ToolCallTypes {
+  FUNCTION = 'function',
+  RETRIEVAL = 'retrieval',
+  FILE_SEARCH = 'file_search',
+  CODE_INTERPRETER = 'code_interpreter',
+  /* Agents Tool Call */
+  TOOL_CALL = 'tool_call',
+}

package/src/types.ts

@@ -1,4 +1,4 @@
-import OpenAI from 'openai';
+import type OpenAI from 'openai';
 import type { InfiniteData } from '@tanstack/react-query';
 import type {
   TMessage,
@@ -7,24 +7,22 @@ import type {
   TSharedLink,
   TConversation,
   EModelEndpoint,
+  TConversationTag,
+  TBanner,
 } from './schemas';
-import type { TSpecsConfig } from './models';
 export type TOpenAIMessage = OpenAI.Chat.ChatCompletionMessageParam;
-export type TOpenAIFunction = OpenAI.Chat.ChatCompletionCreateParams.Function;
-export type TOpenAIFunctionCall = OpenAI.Chat.ChatCompletionCreateParams.FunctionCallOption;
 
 export * from './schemas';
 
 export type TMessages = TMessage[];
 
-export type TMessagesAtom = TMessages | null;
-
 /* TODO: Cleanup EndpointOption types */
 export type TEndpointOption = {
   endpoint: EModelEndpoint;
   endpointType?: EModelEndpoint;
   modelDisplayLabel?: string;
   resendFiles?: boolean;
+  promptCache?: boolean;
   maxContextTokens?: number;
   imageDetail?: ImageDetail;
   model?: string | null;
@@ -46,38 +44,45 @@ export type TPayload = Partial<TMessage> &
     isContinued: boolean;
     conversationId: string | null;
     messages?: TMessages;
+    isTemporary: boolean;
   };
 
 export type TSubmission = {
+  artifacts?: string;
   plugin?: TResPlugin;
   plugins?: TResPlugin[];
   userMessage: TMessage;
   isEdited?: boolean;
   isContinued?: boolean;
+  isTemporary: boolean;
   messages: TMessage[];
   isRegenerate?: boolean;
   conversationId?: string;
-  initialResponse: TMessage;
+  initialResponse?: TMessage;
   conversation: Partial<TConversation>;
   endpointOption: TEndpointOption;
+  clientTimestamp?: string;
 };
 
+export type EventSubmission = Omit<TSubmission, 'initialResponse'> & { initialResponse: TMessage };
+
 export type TPluginAction = {
   pluginKey: string;
   action: 'install' | 'uninstall';
   auth?: unknown;
-  isAssistantTool?: boolean;
+  isEntityTool?: boolean;
 };
 
 export type GroupedConversations = [key: string, TConversation[]][];
 
 export type TUpdateUserPlugins = {
-  isAssistantTool?: boolean;
+  isEntityTool?: boolean;
   pluginKey: string;
   action: string;
   auth?: unknown;
 };
 
+// TODO `label` needs to be changed to the proper `TranslationKeys`
 export type TCategory = {
   id?: string;
   value: string;
@@ -86,7 +91,7 @@ export type TCategory = {
 
 export type TError = {
   message: string;
-  code?: number;
+  code?: number | string;
   response?: {
     data?: {
       message?: string;
@@ -95,6 +100,12 @@ export type TError = {
   };
 };
 
+export type TBackupCode = {
+  codeHash: string;
+  used: boolean;
+  usedAt: Date | null;
+};
+
 export type TUser = {
   id: string;
   username: string;
@@ -103,7 +114,8 @@ export type TUser = {
   avatar: string;
   role: string;
   provider: string;
-  plugins: string[];
+  plugins?: string[];
+  backupCodes?: TBackupCode[];
   createdAt: string;
   updatedAt: string;
 };
@@ -122,6 +134,13 @@ export type TUpdateMessageRequest = {
   text: string;
 };
 
+export type TUpdateMessageContent = {
+  conversationId: string;
+  messageId: string;
+  index: number;
+  text: string;
+};
+
 export type TUpdateUserKeyRequest = {
   name: string;
   value: string;
@@ -138,6 +157,7 @@ export type TUpdateConversationResponse = TConversation;
 export type TDeleteConversationRequest = {
   conversationId?: string;
   thread_id?: string;
+  endpoint?: string;
   source?: string;
 };
 
@@ -160,15 +180,45 @@ export type TArchiveConversationResponse = TConversation;
 export type TSharedMessagesResponse = Omit<TSharedLink, 'messages'> & {
   messages: TMessage[];
 };
-export type TSharedLinkRequest = Partial<
-  Omit<TSharedLink, 'messages' | 'createdAt' | 'updatedAt'>
+
+export type TCreateShareLinkRequest = Pick<TConversation, 'conversationId'>;
+
+export type TUpdateShareLinkRequest = Pick<TSharedLink, 'shareId'>;
+
+export type TSharedLinkResponse = Pick<TSharedLink, 'shareId'> &
+  Pick<TConversation, 'conversationId'>;
+
+export type TSharedLinkGetResponse = TSharedLinkResponse & {
+  success: boolean;
+};
+
+// type for getting conversation tags
+export type TConversationTagsResponse = TConversationTag[];
+// type for creating conversation tag
+export type TConversationTagRequest = Partial<
+  Omit<TConversationTag, 'createdAt' | 'updatedAt' | 'count' | 'user'>
 > & {
-  conversationId: string;
+  conversationId?: string;
+  addToConversation?: boolean;
+};
+
+export type TConversationTagResponse = TConversationTag;
+
+export type TTagConversationRequest = {
+  tags: string[];
+  tag: string;
+};
+
+export type TTagConversationResponse = string[];
+
+export type TDuplicateConvoRequest = {
+  conversationId?: string;
 };
 
-export type TSharedLinkResponse = TSharedLink;
-export type TSharedLinksResponse = TSharedLink[];
-export type TDeleteSharedLinkResponse = TSharedLink;
+export type TDuplicateConvoResponse = {
+  conversation: TConversation;
+  messages: TMessage[];
+};
 
 export type TForkConvoRequest = {
   messageId: string;
@@ -197,6 +247,7 @@ export type TConfig = {
   type?: EModelEndpoint;
   azure?: boolean;
   availableTools?: [];
+  availableRegions?: string[];
   plugins?: Record<string, string>;
   name?: string;
   iconURL?: string;
@@ -235,16 +286,67 @@ export type TRegisterUser = {
   username: string;
   password: string;
   confirm_password?: string;
+  token?: string;
 };
 
 export type TLoginUser = {
   email: string;
   password: string;
+  token?: string;
+  backupCode?: string;
 };
 
 export type TLoginResponse = {
-  token: string;
-  user: TUser;
+  token?: string;
+  user?: TUser;
+  twoFAPending?: boolean;
+  tempToken?: string;
+};
+
+export type TEnable2FAResponse = {
+  otpauthUrl: string;
+  backupCodes: string[];
+  message?: string;
+};
+
+export type TVerify2FARequest = {
+  token?: string;
+  backupCode?: string;
+};
+
+export type TVerify2FAResponse = {
+  message: string;
+};
+
+/**
+ * For verifying 2FA during login with a temporary token.
+ */
+export type TVerify2FATempRequest = {
+  tempToken: string;
+  token?: string;
+  backupCode?: string;
+};
+
+export type TVerify2FATempResponse = {
+  token?: string;
+  user?: TUser;
+  message?: string;
+};
+
+/**
+ * Response from disabling 2FA.
+ */
+export type TDisable2FAResponse = {
+  message: string;
+};
+
+/**
+ * Response from regenerating backup codes.
+ */
+export type TRegenerateBackupCodesResponse = {
+  message: string;
+  backupCodes: string[];
+  backupCodesHash: string[];
 };
 
 export type TRequestPasswordReset = {
@@ -267,51 +369,6 @@ export type TVerifyEmail = {
 
 export type TResendVerificationEmail = Omit<TVerifyEmail, 'token'>;
 
-export type TInterfaceConfig = {
-  privacyPolicy?: {
-    externalUrl?: string;
-    openNewTab?: boolean;
-  };
-  termsOfService?: {
-    externalUrl?: string;
-    openNewTab?: boolean;
-  };
-  endpointsMenu: boolean;
-  modelSelect: boolean;
-  parameters: boolean;
-  sidePanel: boolean;
-  presets: boolean;
-};
-
-export type TStartupConfig = {
-  appTitle: string;
-  socialLogins?: string[];
-  interface?: TInterfaceConfig;
-  discordLoginEnabled: boolean;
-  facebookLoginEnabled: boolean;
-  githubLoginEnabled: boolean;
-  googleLoginEnabled: boolean;
-  openidLoginEnabled: boolean;
-  openidLabel: string;
-  openidImageUrl: string;
-  ldapLoginEnabled: boolean;
-  serverDomain: string;
-  emailLoginEnabled: boolean;
-  registrationEnabled: boolean;
-  socialLoginEnabled: boolean;
-  passwordResetEnabled: boolean;
-  emailEnabled: boolean;
-  checkBalance: boolean;
-  showBirthdayIcon: boolean;
-  helpAndFaqURL: string;
-  customFooter?: string;
-  modelSpecs?: TSpecsConfig;
-  sharedLinksEnabled: boolean;
-  publicSharedLinksEnabled: boolean;
-  analyticsGtmId?: string;
-  instanceProjectId: string;
-};
-
 export type TRefreshTokenResponse = {
   token: string;
   user: TUser;
@@ -445,9 +502,7 @@ export type TUpdatePromptLabelsResponse = {
   message: string;
 };
 
-export type TDeletePromptGroupResponse = {
-  promptGroup: string;
-};
+export type TDeletePromptGroupResponse = TUpdatePromptLabelsResponse;
 
 export type TDeletePromptGroupRequest = {
   id: string;
@@ -465,3 +520,13 @@ export type TGetRandomPromptsRequest = {
 };
 
 export type TCustomConfigSpeechResponse = { [key: string]: string };
+
+export type TUserTermsResponse = {
+  termsAccepted: boolean;
+};
+
+export type TAcceptTermsResponse = {
+  success: boolean;
+};
+
+export type TBannerResponse = TBanner | null;