librechat-data-provider 0.4.0 → 0.4.2

package/src/react-query/react-query-service.ts

@@ -9,6 +9,7 @@ import {
 import * as t from '../types';
 import * as s from '../schemas';
 import * as m from '../types/mutations';
+import { defaultOrderQuery } from '../config';
 import * as dataService from '../data-service';
 import request from '../request';
 import { QueryKeys } from '../keys';
@@ -136,6 +137,14 @@ export const useRevokeUserKeyMutation = (name: string): UseMutationResult<unknow
   return useMutation(() => dataService.revokeUserKey(name), {
     onSuccess: () => {
       queryClient.invalidateQueries([QueryKeys.name]);
+      if (name === s.EModelEndpoint.assistants) {
+        queryClient.invalidateQueries([QueryKeys.assistants, defaultOrderQuery]);
+        queryClient.invalidateQueries([QueryKeys.assistantDocs]);
+        queryClient.invalidateQueries([QueryKeys.assistants]);
+        queryClient.invalidateQueries([QueryKeys.assistant]);
+        queryClient.invalidateQueries([QueryKeys.actions]);
+        queryClient.invalidateQueries([QueryKeys.tools]);
+      }
     },
   });
 };
@@ -145,6 +154,12 @@ export const useRevokeAllUserKeysMutation = (): UseMutationResult<unknown> => {
   return useMutation(() => dataService.revokeAllUserKeys(), {
     onSuccess: () => {
       queryClient.invalidateQueries([QueryKeys.name]);
+      queryClient.invalidateQueries([QueryKeys.assistants, defaultOrderQuery]);
+      queryClient.invalidateQueries([QueryKeys.assistantDocs]);
+      queryClient.invalidateQueries([QueryKeys.assistants]);
+      queryClient.invalidateQueries([QueryKeys.assistant]);
+      queryClient.invalidateQueries([QueryKeys.actions]);
+      queryClient.invalidateQueries([QueryKeys.tools]);
     },
   });
 };
@@ -277,7 +292,7 @@ export const useLoginUserMutation = (): UseMutationResult<
       localStorage.removeItem('lastSelectedModel');
       localStorage.removeItem('lastSelectedTools');
       localStorage.removeItem('filesToDelete');
-      localStorage.removeItem('lastAssistant');
+      // localStorage.removeItem('lastAssistant');
     },
   });
 };

package/src/schemas.ts

@@ -1,4 +1,8 @@
 import { z } from 'zod';
+import type { TMessageContentParts } from './types/assistants';
+import type { TFile } from './types/files';
+
+export const isUUID = z.string().uuid();
 
 export enum EModelEndpoint {
   azureOpenAI = 'azureOpenAI',
@@ -8,10 +12,22 @@ export enum EModelEndpoint {
   google = 'google',
   gptPlugins = 'gptPlugins',
   anthropic = 'anthropic',
-  assistant = 'assistant',
+  assistants = 'assistants',
   custom = 'custom',
 }
 
+export const defaultAssistantFormValues = {
+  assistant: '',
+  id: '',
+  name: '',
+  description: '',
+  instructions: '',
+  model: 'gpt-3.5-turbo-1106',
+  functions: [],
+  code_interpreter: false,
+  retrieval: false,
+};
+
 export const endpointSettings = {
   [EModelEndpoint.google]: {
     model: {
@@ -153,21 +169,16 @@ export const tMessageSchema = z.object({
   unfinished: z.boolean().optional(),
   searchResult: z.boolean().optional(),
   finish_reason: z.string().optional(),
+  /* assistant */
+  thread_id: z.string().optional(),
 });
 
 export type TMessage = z.input<typeof tMessageSchema> & {
   children?: TMessage[];
   plugin?: TResPlugin | null;
   plugins?: TResPlugin[];
-  files?: {
-    file_id: string;
-    type?: string;
-    filename?: string;
-    preview?: string;
-    filepath?: string;
-    height?: number;
-    width?: number;
-  }[];
+  content?: TMessageContentParts[];
+  files?: Partial<TFile>[];
 };
 
 export const tConversationSchema = z.object({
@@ -204,16 +215,17 @@ export const tConversationSchema = z.object({
   toneStyle: z.string().nullable().optional(),
   maxOutputTokens: z.number().optional(),
   agentOptions: tAgentOptionsSchema.nullable().optional(),
+  file_ids: z.array(z.string()).optional(),
   /* vision */
   resendImages: z.boolean().optional(),
   imageDetail: eImageDetailSchema.optional(),
   /* assistant */
   assistant_id: z.string().optional(),
-  thread_id: z.string().optional(),
+  instructions: z.string().optional(),
+  /** Used to overwrite active conversation settings when saving a Preset */
+  presetOverride: z.record(z.unknown()).optional(),
 });
 
-export type TConversation = z.infer<typeof tConversationSchema>;
-
 export const tPresetSchema = tConversationSchema
   .omit({
     conversationId: true,
@@ -246,6 +258,10 @@ export const tPresetUpdateSchema = tConversationSchema.merge(
 
 export type TPreset = z.infer<typeof tPresetSchema>;
 
+export type TConversation = z.infer<typeof tConversationSchema> & {
+  presetOverride?: Partial<TPreset>;
+};
+
 // type DefaultSchemaValues = Partial<typeof google>;
 
 export const openAISchema = tConversationSchema
@@ -470,7 +486,8 @@ export const assistantSchema = tConversationSchema
   .pick({
     model: true,
     assistant_id: true,
-    thread_id: true,
+    instructions: true,
+    promptPrefix: true,
   })
   .transform(removeNullishValues)
   .catch(() => ({}));

package/src/types/assistants.ts

@@ -1,3 +1,8 @@
+import type { OpenAPIV3 } from 'openapi-types';
+
+export type Schema = OpenAPIV3.SchemaObject & { description?: string };
+export type Reference = OpenAPIV3.ReferenceObject & { description?: string };
+
 export type Metadata = {
   [key: string]: unknown;
 };
@@ -12,6 +17,15 @@ export type Tool = {
   [type: string]: Tools;
 };
 
+export type FunctionTool = {
+  type: Tools;
+  function?: {
+    description: string;
+    name: string;
+    parameters: Record<string, unknown>;
+  };
+};
+
 export type Assistant = {
   id: string;
   created_at: number;
@@ -22,7 +36,7 @@ export type Assistant = {
   model: string;
   name: string | null;
   object: string;
-  tools: Tool[];
+  tools: FunctionTool[];
 };
 
 export type AssistantCreateParams = {
@@ -32,7 +46,7 @@ export type AssistantCreateParams = {
   instructions?: string | null;
   metadata?: Metadata | null;
   name?: string | null;
-  tools?: Tool[];
+  tools?: Array<FunctionTool | string>;
 };
 
 export type AssistantUpdateParams = {
@@ -42,7 +56,7 @@ export type AssistantUpdateParams = {
   instructions?: string | null;
   metadata?: Metadata | null;
   name?: string | null;
-  tools?: Tool[];
+  tools?: Array<FunctionTool | string>;
 };
 
 export type AssistantListParams = {
@@ -70,3 +84,241 @@ export type File = {
   object: string;
   purpose: 'fine-tune' | 'fine-tune-results' | 'assistants' | 'assistants_output';
 };
+
+/**
+ * Details of the Code Interpreter tool call the run step was involved in.
+ * Includes the tool call ID, the code interpreter definition, and the type of tool call.
+ */
+export type CodeToolCall = {
+  id: string; // The ID of the tool call.
+  code_interpreter: {
+    input: string; // The input to the Code Interpreter tool call.
+    outputs: Array<Record<string, unknown>>; // The outputs from the Code Interpreter tool call.
+  };
+  type: 'code_interpreter'; // The type of tool call, always 'code_interpreter'.
+};
+
+/**
+ * Details of a Function tool call the run step was involved in.
+ * Includes the tool call ID, the function definition, and the type of tool call.
+ */
+export type FunctionToolCall = {
+  id: string; // The ID of the tool call object.
+  function: {
+    arguments: string; // The arguments passed to the function.
+    name: string; // The name of the function.
+    output: string | null; // The output of the function, null if not submitted.
+  };
+  type: 'function'; // The type of tool call, always 'function'.
+};
+
+/**
+ * Details of a Retrieval tool call the run step was involved in.
+ * Includes the tool call ID and the type of tool call.
+ */
+export type RetrievalToolCall = {
+  id: string; // The ID of the tool call object.
+  retrieval: unknown; // An empty object for now.
+  type: 'retrieval'; // The type of tool call, always 'retrieval'.
+};
+
+/**
+ * Details of the tool calls involved in a run step.
+ * Can be associated with one of three types of tools: `code_interpreter`, `retrieval`, or `function`.
+ */
+export type ToolCallsStepDetails = {
+  tool_calls: Array<CodeToolCall | RetrievalToolCall | FunctionToolCall>; // An array of tool calls the run step was involved in.
+  type: 'tool_calls'; // Always 'tool_calls'.
+};
+
+export type ImageFile = {
+  /**
+   * The [File](https://platform.openai.com/docs/api-reference/files) ID of the image
+   * in the message content.
+   */
+  file_id: string;
+  filename: string;
+  filepath: string;
+  height: number;
+  width: number;
+  /**
+   * Prompt used to generate the image if applicable.
+   */
+  prompt?: string;
+  /**
+   * Additional metadata used to generate or about the image/tool_call.
+   */
+  metadata?: Record<string, unknown>;
+};
+
+// FileCitation.ts
+export type FileCitation = {
+  end_index: number;
+  file_citation: FileCitationDetails;
+  start_index: number;
+  text: string;
+  type: 'file_citation';
+};
+
+export type FileCitationDetails = {
+  file_id: string;
+  quote: string;
+};
+
+export type FilePath = {
+  end_index: number;
+  file_path: FilePathDetails;
+  start_index: number;
+  text: string;
+  type: 'file_path';
+};
+
+export type FilePathDetails = {
+  file_id: string;
+};
+
+export type Text = {
+  annotations?: Array<FileCitation | FilePath>;
+  value: string;
+};
+
+export enum ContentTypes {
+  TEXT = 'text',
+  TOOL_CALL = 'tool_call',
+  IMAGE_FILE = 'image_file',
+}
+
+export enum StepTypes {
+  TOOL_CALLS = 'tool_calls',
+  MESSAGE_CREATION = 'message_creation',
+}
+
+export enum ToolCallTypes {
+  FUNCTION = 'function',
+  RETRIEVAL = 'retrieval',
+  CODE_INTERPRETER = 'code_interpreter',
+}
+
+export enum StepStatus {
+  IN_PROGRESS = 'in_progress',
+  CANCELLED = 'cancelled',
+  FAILED = 'failed',
+  COMPLETED = 'completed',
+  EXPIRED = 'expired',
+}
+
+export enum MessageContentTypes {
+  TEXT = 'text',
+  IMAGE_FILE = 'image_file',
+}
+
+//enum for RunStatus
+// The status of the run: queued, in_progress, requires_action, cancelling, cancelled, failed, completed, or expired.
+export enum RunStatus {
+  QUEUED = 'queued',
+  IN_PROGRESS = 'in_progress',
+  REQUIRES_ACTION = 'requires_action',
+  CANCELLING = 'cancelling',
+  CANCELLED = 'cancelled',
+  FAILED = 'failed',
+  COMPLETED = 'completed',
+  EXPIRED = 'expired',
+}
+
+export type PartMetadata = {
+  progress?: number;
+  asset_pointer?: string;
+  status?: string;
+  action?: boolean;
+};
+
+export type ContentPart = (CodeToolCall | RetrievalToolCall | FunctionToolCall | ImageFile | Text) &
+  PartMetadata;
+
+export type TMessageContentParts =
+  | { type: ContentTypes.TEXT; text: Text & PartMetadata }
+  | {
+      type: ContentTypes.TOOL_CALL;
+      tool_call: (CodeToolCall | RetrievalToolCall | FunctionToolCall) & PartMetadata;
+    }
+  | { type: ContentTypes.IMAGE_FILE; image_file: ImageFile & PartMetadata };
+
+export type TContentData = TMessageContentParts & {
+  messageId: string;
+  conversationId: string;
+  userMessageId: string;
+  thread_id: string;
+  index: number;
+  stream?: boolean;
+};
+
+export const actionDelimiter = '_action_';
+
+export enum AuthTypeEnum {
+  ServiceHttp = 'service_http',
+  OAuth = 'oauth',
+  None = 'none',
+}
+
+export enum AuthorizationTypeEnum {
+  Bearer = 'bearer',
+  Basic = 'basic',
+  Custom = 'custom',
+}
+
+export enum TokenExchangeMethodEnum {
+  DefaultPost = 'default_post',
+  BasicAuthHeader = 'basic_auth_header',
+}
+
+export type ActionAuth = {
+  authorization_type?: AuthorizationTypeEnum;
+  custom_auth_header?: string;
+  type?: AuthTypeEnum;
+  authorization_content_type?: string;
+  authorization_url?: string;
+  client_url?: string;
+  scope?: string;
+  token_exchange_method?: TokenExchangeMethodEnum;
+};
+
+export type ActionMetadata = {
+  api_key?: string;
+  auth?: ActionAuth;
+  domain?: string;
+  privacy_policy_url?: string;
+  raw_spec?: string;
+  oauth_client_id?: string;
+  oauth_client_secret?: string;
+};
+
+export type Action = {
+  action_id: string;
+  assistant_id: string;
+  type?: string;
+  settings?: Record<string, unknown>;
+  metadata: ActionMetadata;
+};
+
+export type AssistantAvatar = {
+  filepath: string;
+  source: string;
+};
+
+export type AssistantDocument = {
+  user: string;
+  assistant_id: string;
+  avatar?: AssistantAvatar;
+  access_level?: number;
+  file_ids?: string[];
+  actions?: string[];
+  createdAt?: Date;
+  updatedAt?: Date;
+};
+
+export enum FilePurpose {
+  FineTune = 'fine-tune',
+  FineTuneResults = 'fine-tune-results',
+  Assistants = 'assistants',
+  AssistantsOutput = 'assistants_output',
+}

package/src/types/files.ts

@@ -5,17 +5,54 @@ export enum FileSources {
   s3 = 's3',
 }
 
+export enum FileContext {
+  avatar = 'avatar',
+  unknown = 'unknown',
+  assistants = 'assistants',
+  image_generation = 'image_generation',
+  assistants_output = 'assistants_output',
+  message_attachment = 'message_attachment',
+}
+
+export type EndpointFileConfig = {
+  disabled?: boolean;
+  fileLimit?: number;
+  fileSizeLimit?: number;
+  totalSizeLimit?: number;
+  supportedMimeTypes?: RegExp[];
+};
+
+export type FileConfig = {
+  endpoints: {
+    [key: string]: EndpointFileConfig;
+  };
+  serverFileSizeLimit?: number;
+  avatarSizeLimit?: number;
+  checkType?: (fileType: string, supportedTypes: RegExp[]) => boolean;
+};
+
 export type TFile = {
-  message: string;
+  _id?: string;
+  __v?: number;
+  user: string;
+  conversationId?: string;
+  message?: string;
   file_id: string;
-  filepath: string;
+  temp_file_id?: string;
+  bytes: number;
   filename: string;
+  filepath: string;
+  object: 'file';
   type: string;
-  size: number;
-  temp_file_id?: string;
+  usage: number;
+  context?: FileContext;
   source?: FileSources;
-  height?: number;
   width?: number;
+  height?: number;
+  expiresAt?: string | Date;
+  preview?: string;
+  createdAt?: string | Date;
+  updatedAt?: string | Date;
 };
 
 export type TFileUpload = TFile & {
@@ -26,15 +63,10 @@ export type AvatarUploadResponse = {
   url: string;
 };
 
-export type FileUploadBody = {
-  formData: FormData;
-  file_id: string;
-};
-
 export type UploadMutationOptions = {
-  onSuccess?: (data: TFileUpload, variables: FileUploadBody, context?: unknown) => void;
-  onMutate?: (variables: FileUploadBody) => void | Promise<unknown>;
-  onError?: (error: unknown, variables: FileUploadBody, context?: unknown) => void;
+  onSuccess?: (data: TFileUpload, variables: FormData, context?: unknown) => void;
+  onMutate?: (variables: FormData) => void | Promise<unknown>;
+  onError?: (error: unknown, variables: FormData, context?: unknown) => void;
 };
 
 export type UploadAvatarOptions = {
@@ -56,6 +88,7 @@ export type BatchFile = {
 
 export type DeleteFilesBody = {
   files: BatchFile[];
+  assistant_id?: string;
 };
 
 export type DeleteMutationOptions = {

package/src/types/mutations.ts

@@ -1,4 +1,13 @@
-import { TPreset } from '../types';
+import { TPreset, TDeleteConversationResponse, TDeleteConversationRequest } from '../types';
+import {
+  Assistant,
+  AssistantCreateParams,
+  AssistantUpdateParams,
+  ActionMetadata,
+  FunctionTool,
+  AssistantDocument,
+  Action,
+} from './assistants';
 
 export type TGenTitleRequest = {
   conversationId: string;
@@ -34,3 +43,83 @@ export type LogoutOptions = {
   onMutate?: (variables: undefined) => void | Promise<unknown>;
   onError?: (error: unknown, variables: undefined, context?: unknown) => void;
 };
+
+export type AssistantAvatarVariables = {
+  assistant_id: string;
+  formData: FormData;
+  postCreation?: boolean;
+};
+
+export type UpdateActionVariables = {
+  assistant_id: string;
+  functions: FunctionTool[];
+  metadata: ActionMetadata;
+  action_id?: string;
+};
+
+export type UploadAssistantAvatarOptions = {
+  onSuccess?: (data: Assistant, variables: AssistantAvatarVariables, context?: unknown) => void;
+  onMutate?: (variables: AssistantAvatarVariables) => void | Promise<unknown>;
+  onError?: (error: unknown, variables: AssistantAvatarVariables, context?: unknown) => void;
+};
+
+export type CreateAssistantMutationOptions = {
+  onSuccess?: (data: Assistant, variables: AssistantCreateParams, context?: unknown) => void;
+  onMutate?: (variables: AssistantCreateParams) => void | Promise<unknown>;
+  onError?: (error: unknown, variables: AssistantCreateParams, context?: unknown) => void;
+};
+
+export type UpdateAssistantMutationOptions = {
+  onSuccess?: (
+    data: Assistant,
+    variables: { assistant_id: string; data: AssistantUpdateParams },
+    context?: unknown,
+  ) => void;
+  onMutate?: (variables: {
+    assistant_id: string;
+    data: AssistantUpdateParams;
+  }) => void | Promise<unknown>;
+  onError?: (
+    error: unknown,
+    variables: { assistant_id: string; data: AssistantUpdateParams },
+    context?: unknown,
+  ) => void;
+};
+
+export type DeleteAssistantMutationOptions = {
+  onSuccess?: (data: void, variables: { assistant_id: string }, context?: unknown) => void;
+  onMutate?: (variables: { assistant_id: string }) => void | Promise<unknown>;
+  onError?: (error: unknown, variables: { assistant_id: string }, context?: unknown) => void;
+};
+
+export type UpdateActionResponse = [AssistantDocument, Assistant, Action];
+export type UpdateActionOptions = {
+  onSuccess?: (
+    data: UpdateActionResponse,
+    variables: UpdateActionVariables,
+    context?: unknown,
+  ) => void;
+  onMutate?: (variables: UpdateActionVariables) => void | Promise<unknown>;
+  onError?: (error: unknown, variables: UpdateActionVariables, context?: unknown) => void;
+};
+
+export type DeleteActionVariables = {
+  assistant_id: string;
+  action_id: string;
+};
+
+export type DeleteActionOptions = {
+  onSuccess?: (data: void, variables: DeleteActionVariables, context?: unknown) => void;
+  onMutate?: (variables: DeleteActionVariables) => void | Promise<unknown>;
+  onError?: (error: unknown, variables: DeleteActionVariables, context?: unknown) => void;
+};
+
+export type DeleteConversationOptions = {
+  onSuccess?: (
+    data: TDeleteConversationResponse,
+    variables: TDeleteConversationRequest,
+    context?: unknown,
+  ) => void;
+  onMutate?: (variables: TDeleteConversationRequest) => void | Promise<unknown>;
+  onError?: (error: unknown, variables: TDeleteConversationRequest, context?: unknown) => void;
+};

package/src/types.ts

@@ -25,6 +25,8 @@ export type TEndpointOption = {
   modelLabel?: string | null;
   jailbreak?: boolean;
   key?: string | null;
+  /* assistant */
+  thread_id?: string;
 };
 
 export type TSubmission = {
@@ -45,11 +47,13 @@ export type TPluginAction = {
   pluginKey: string;
   action: 'install' | 'uninstall';
   auth?: unknown;
+  isAssistantTool?: boolean;
 };
 
 export type GroupedConversations = [key: string, TConversation[]][];
 
 export type TUpdateUserPlugins = {
+  isAssistantTool?: boolean;
   pluginKey: string;
   action: string;
   auth?: unknown;
@@ -108,6 +112,7 @@ export type TUpdateConversationResponse = TConversation;
 
 export type TDeleteConversationRequest = {
   conversationId?: string;
+  thread_id?: string;
   source?: string;
 };
 
@@ -140,6 +145,7 @@ export type TConfig = {
   modelDisplayLabel?: string;
   userProvide?: boolean | null;
   userProvideURL?: boolean | null;
+  disableBuilder?: boolean;
 };
 
 export type TEndpointsConfig =

package/tsconfig.spec.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "noEmit": true,
+    "outDir": "./dist/tests",
+    "baseUrl": "."
+  },
+  "include": ["specs/**/*", "src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}