librechat-data-provider 0.8.402 → 0.8.403

package/src/types.ts

@@ -1,676 +0,0 @@
-import type { InfiniteData } from '@tanstack/react-query';
-import type {
-  TConversationTag,
-  EModelEndpoint,
-  TConversation,
-  TSharedLink,
-  TAttachment,
-  TMessage,
-  TBanner,
-} from './schemas';
-import type { SettingDefinition } from './generate';
-import type { TMinimalFeedback } from './feedback';
-import type { ContentTypes } from './types/runs';
-import type { Agent } from './types/assistants';
-
-export * from './schemas';
-
-export type TMessages = TMessage[];
-
-/* TODO: Cleanup EndpointOption types */
-export type TEndpointOption = Pick<
-  TConversation,
-  // Core conversation fields
-  | 'endpoint'
-  | 'endpointType'
-  | 'model'
-  | 'modelLabel'
-  | 'chatGptLabel'
-  | 'promptPrefix'
-  | 'temperature'
-  | 'topP'
-  | 'topK'
-  | 'top_p'
-  | 'frequency_penalty'
-  | 'presence_penalty'
-  | 'maxOutputTokens'
-  | 'maxContextTokens'
-  | 'max_tokens'
-  | 'maxTokens'
-  | 'resendFiles'
-  | 'imageDetail'
-  | 'reasoning_effort'
-  | 'verbosity'
-  | 'instructions'
-  | 'additional_instructions'
-  | 'append_current_datetime'
-  | 'tools'
-  | 'stop'
-  | 'region'
-  | 'additionalModelRequestFields'
-  // Anthropic-specific
-  | 'promptCache'
-  | 'thinking'
-  | 'thinkingBudget'
-  | 'thinkingLevel'
-  | 'effort'
-  // Assistant/Agent fields
-  | 'assistant_id'
-  | 'agent_id'
-  // UI/Display fields
-  | 'iconURL'
-  | 'greeting'
-  | 'spec'
-  // Artifacts
-  | 'artifacts'
-  // Files
-  | 'file_ids'
-  // System field
-  | 'system'
-  // Google examples
-  | 'examples'
-  // Context
-  | 'context'
-> & {
-  // Fields specific to endpoint options that don't exist on TConversation
-  modelDisplayLabel?: string;
-  key?: string | null;
-  /** @deprecated Assistants API */
-  thread_id?: string;
-  // Conversation identifiers for multi-response streams
-  overrideConvoId?: string;
-  overrideUserMessageId?: string;
-  // Model parameters (used by different endpoints)
-  modelOptions?: Record<string, unknown>;
-  model_parameters?: Record<string, unknown>;
-  // Configuration data (added by middleware)
-  modelsConfig?: TModelsConfig;
-  // File attachments (processed by middleware)
-  attachments?: TAttachment[];
-  // Generated prompts
-  artifactsPrompt?: string;
-  // Agent-specific fields
-  agent?: Promise<Agent>;
-  // Client-specific options
-  clientOptions?: Record<string, unknown>;
-};
-
-export type TEphemeralAgent = {
-  mcp?: string[];
-  web_search?: boolean;
-  file_search?: boolean;
-  execute_code?: boolean;
-  artifacts?: string;
-};
-
-export type TPayload = Partial<TMessage> &
-  Partial<TEndpointOption> & {
-    isContinued: boolean;
-    isRegenerate?: boolean;
-    conversationId: string | null;
-    messages?: TMessages;
-    isTemporary: boolean;
-    ephemeralAgent?: TEphemeralAgent | null;
-    editedContent?: TEditedContent | null;
-    /** Added conversation for multi-convo feature */
-    addedConvo?: TConversation;
-  };
-
-export type TEditedContent =
-  | {
-      index: number;
-      type: ContentTypes.THINK;
-      [ContentTypes.THINK]: string;
-    }
-  | {
-      index: number;
-      type: ContentTypes.TEXT;
-      [ContentTypes.TEXT]: string;
-    };
-
-export type TSubmission = {
-  userMessage: TMessage;
-  isEdited?: boolean;
-  isContinued?: boolean;
-  isTemporary: boolean;
-  messages: TMessage[];
-  isRegenerate?: boolean;
-  initialResponse?: TMessage;
-  conversation: Partial<TConversation>;
-  endpointOption: TEndpointOption;
-  clientTimestamp?: string;
-  ephemeralAgent?: TEphemeralAgent | null;
-  editedContent?: TEditedContent | null;
-  /** Added conversation for multi-convo feature */
-  addedConvo?: TConversation;
-};
-
-export type EventSubmission = Omit<TSubmission, 'initialResponse'> & { initialResponse: TMessage };
-
-export type TPluginAction = {
-  pluginKey: string;
-  action: 'install' | 'uninstall';
-  auth?: Partial<Record<string, string>> | null;
-  isEntityTool?: boolean;
-};
-
-export type GroupedConversations = [key: string, TConversation[]][];
-
-export type TUpdateUserPlugins = {
-  isEntityTool?: boolean;
-  pluginKey: string;
-  action: string;
-  auth?: Partial<Record<string, string | null>> | null;
-};
-
-// TODO `label` needs to be changed to the proper `TranslationKeys`
-export type TCategory = {
-  id?: string;
-  value: string;
-  label: string;
-  description?: string;
-  custom?: boolean;
-};
-
-export type TMarketplaceCategory = TCategory & {
-  count: number;
-};
-
-export type TError = {
-  message: string;
-  code?: number | string;
-  response?: {
-    data?: {
-      message?: string;
-    };
-    status?: number;
-  };
-};
-
-export type TBackupCode = {
-  codeHash: string;
-  used: boolean;
-  usedAt: Date | null;
-};
-
-export type TUser = {
-  id: string;
-  username: string;
-  email: string;
-  name: string;
-  avatar: string;
-  role: string;
-  provider: string;
-  plugins?: string[];
-  twoFactorEnabled?: boolean;
-  backupCodes?: TBackupCode[];
-  personalization?: {
-    memories?: boolean;
-  };
-  createdAt: string;
-  updatedAt: string;
-};
-
-export type TGetConversationsResponse = {
-  conversations: TConversation[];
-  pageNumber: string;
-  pageSize: string | number;
-  pages: string | number;
-};
-
-export type TUpdateMessageRequest = {
-  conversationId: string;
-  messageId: string;
-  model: string;
-  text: string;
-};
-
-export type TUpdateMessageContent = {
-  conversationId: string;
-  messageId: string;
-  index: number;
-  text: string;
-};
-
-export type TUpdateUserKeyRequest = {
-  name: string;
-  value: string;
-  expiresAt: string;
-};
-
-export type TAgentApiKeyCreateRequest = {
-  name: string;
-  expiresAt?: string | null;
-};
-
-export type TAgentApiKeyCreateResponse = {
-  id: string;
-  name: string;
-  key: string;
-  keyPrefix: string;
-  createdAt: string;
-  expiresAt?: string;
-};
-
-export type TAgentApiKeyListItem = {
-  id: string;
-  name: string;
-  keyPrefix: string;
-  lastUsedAt?: string;
-  expiresAt?: string;
-  createdAt: string;
-};
-
-export type TAgentApiKeyListResponse = {
-  keys: TAgentApiKeyListItem[];
-};
-
-export type TUpdateConversationRequest = {
-  conversationId: string;
-  title: string;
-};
-
-export type TUpdateConversationResponse = TConversation;
-
-export type TDeleteConversationRequest = {
-  conversationId?: string;
-  thread_id?: string;
-  endpoint?: string;
-  source?: string;
-};
-
-export type TDeleteConversationResponse = {
-  acknowledged: boolean;
-  deletedCount: number;
-  messages: {
-    acknowledged: boolean;
-    deletedCount: number;
-  };
-};
-
-export type TArchiveConversationRequest = {
-  conversationId: string;
-  isArchived: boolean;
-};
-
-export type TArchiveConversationResponse = TConversation;
-
-export type TSharedMessagesResponse = Omit<TSharedLink, 'messages'> & {
-  messages: TMessage[];
-};
-
-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;
-  addToConversation?: boolean;
-};
-
-export type TConversationTagResponse = TConversationTag;
-
-export type TTagConversationRequest = {
-  tags: string[];
-  tag: string;
-};
-
-export type TTagConversationResponse = string[];
-
-export type TDuplicateConvoRequest = {
-  conversationId?: string;
-};
-
-export type TDuplicateConvoResponse = {
-  conversation: TConversation;
-  messages: TMessage[];
-};
-
-export type TForkConvoRequest = {
-  messageId: string;
-  conversationId: string;
-  option?: string;
-  splitAtTarget?: boolean;
-  latestMessageId?: string;
-};
-
-export type TForkConvoResponse = {
-  conversation: TConversation;
-  messages: TMessage[];
-};
-
-export type TSearchResults = {
-  conversations: TConversation[];
-  messages: TMessage[];
-  pageNumber: string;
-  pageSize: string | number;
-  pages: string | number;
-  filter: object;
-};
-
-export type TConfig = {
-  order: number;
-  type?: EModelEndpoint;
-  azure?: boolean;
-  availableTools?: [];
-  availableRegions?: string[];
-  plugins?: Record<string, string>;
-  name?: string;
-  iconURL?: string;
-  version?: string;
-  modelDisplayLabel?: string;
-  userProvide?: boolean | null;
-  userProvideURL?: boolean | null;
-  disableBuilder?: boolean;
-  retrievalModels?: string[];
-  capabilities?: string[];
-  customParams?: {
-    defaultParamsEndpoint?: string;
-    paramDefinitions?: Partial<SettingDefinition>[];
-  };
-};
-
-export type TEndpointsConfig =
-  | Record<EModelEndpoint | string, TConfig | null | undefined>
-  | undefined;
-
-export type TModelsConfig = Record<string, string[]>;
-
-export type TUpdateTokenCountResponse = {
-  count: number;
-};
-
-export type TMessageTreeNode = object;
-
-export type TSearchMessage = object;
-
-export type TSearchMessageTreeNode = object;
-
-export type TRegisterUserResponse = {
-  message: string;
-};
-
-export type TRegisterUser = {
-  name: string;
-  email: string;
-  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;
-  twoFAPending?: boolean;
-  tempToken?: string;
-};
-
-/** Shared payload for any operation that requires OTP or backup-code verification. */
-export type TOTPVerificationPayload = {
-  token?: string;
-  backupCode?: string;
-};
-
-export type TEnable2FARequest = TOTPVerificationPayload;
-
-export type TEnable2FAResponse = {
-  otpauthUrl: string;
-  backupCodes: string[];
-  message?: string;
-};
-
-export type TVerify2FARequest = TOTPVerificationPayload;
-
-export type TVerify2FAResponse = {
-  message: string;
-};
-
-/** For verifying 2FA during login with a temporary token. */
-export type TVerify2FATempRequest = TOTPVerificationPayload & {
-  tempToken: string;
-};
-
-export type TVerify2FATempResponse = {
-  token?: string;
-  user?: TUser;
-  message?: string;
-};
-
-export type TDisable2FARequest = TOTPVerificationPayload;
-
-export type TDisable2FAResponse = {
-  message: string;
-};
-
-export type TRegenerateBackupCodesRequest = TOTPVerificationPayload;
-
-export type TRegenerateBackupCodesResponse = {
-  message?: string;
-  backupCodes: string[];
-  backupCodesHash: TBackupCode[];
-};
-
-export type TDeleteUserRequest = TOTPVerificationPayload;
-
-export type TRequestPasswordReset = {
-  email: string;
-};
-
-export type TResetPassword = {
-  userId: string;
-  token: string;
-  password: string;
-  confirm_password?: string;
-};
-
-export type VerifyEmailResponse = { message: string };
-
-export type TVerifyEmail = {
-  email: string;
-  token: string;
-};
-
-export type TResendVerificationEmail = Omit<TVerifyEmail, 'token'>;
-
-export type TRefreshTokenResponse = {
-  token: string;
-  user: TUser;
-};
-
-export type TCheckUserKeyResponse = {
-  expiresAt: string;
-};
-
-export type TRequestPasswordResetResponse = {
-  link?: string;
-  message?: string;
-};
-
-/**
- * Represents the response from the import endpoint.
- */
-export type TImportResponse = {
-  /**
-   * The message associated with the response.
-   */
-  message: string;
-};
-
-/** Prompts */
-
-export type TPrompt = {
-  groupId: string;
-  author: string;
-  prompt: string;
-  type: 'text' | 'chat';
-  createdAt: string;
-  updatedAt: string;
-  _id?: string;
-};
-
-export type TPromptGroup = {
-  name: string;
-  numberOfGenerations?: number;
-  command?: string;
-  oneliner?: string;
-  category?: string;
-  productionId?: string | null;
-  productionPrompt?: Pick<TPrompt, 'prompt'> | null;
-  author: string;
-  authorName: string;
-  createdAt?: Date;
-  updatedAt?: Date;
-  _id?: string;
-};
-
-export type TCreatePrompt = {
-  prompt: Pick<TPrompt, 'prompt' | 'type'> & { groupId?: string };
-  group?: { name: string; category?: string; oneliner?: string; command?: string };
-};
-
-export type TCreatePromptRecord = TCreatePrompt & Pick<TPromptGroup, 'author' | 'authorName'>;
-
-export type TPromptsWithFilterRequest = {
-  groupId: string;
-  tags?: string[];
-  projectId?: string;
-  version?: number;
-};
-
-export type TPromptGroupsWithFilterRequest = {
-  category: string;
-  pageNumber?: string; // Made optional for cursor-based pagination
-  pageSize?: string | number;
-  limit?: string | number; // For cursor-based pagination
-  cursor?: string; // For cursor-based pagination
-  before?: string | null;
-  after?: string | null;
-  order?: 'asc' | 'desc';
-  name?: string;
-  author?: string;
-};
-
-export type PromptGroupListResponse = {
-  promptGroups: TPromptGroup[];
-  pageNumber: string;
-  pageSize: string | number;
-  pages: string | number;
-  has_more: boolean; // Added for cursor-based pagination
-  after: string | null; // Added for cursor-based pagination
-};
-
-export type PromptGroupListData = InfiniteData<PromptGroupListResponse>;
-
-export type TCreatePromptResponse = {
-  prompt: TPrompt;
-  group?: TPromptGroup;
-};
-
-export type TUpdatePromptGroupPayload = Partial<TPromptGroup>;
-
-export type TUpdatePromptGroupVariables = {
-  id: string;
-  payload: TUpdatePromptGroupPayload;
-};
-
-export type TUpdatePromptGroupResponse = TPromptGroup;
-
-export type TDeletePromptResponse = {
-  prompt: string;
-  promptGroup?: { message: string; id: string };
-};
-
-export type TDeletePromptVariables = {
-  _id: string;
-  groupId: string;
-};
-
-export type TMakePromptProductionResponse = {
-  message: string;
-};
-
-export type TMakePromptProductionRequest = {
-  id: string;
-  groupId: string;
-  productionPrompt: Pick<TPrompt, 'prompt'>;
-};
-
-export type TUpdatePromptLabelsRequest = {
-  id: string;
-  payload: {
-    labels: string[];
-  };
-};
-
-export type TUpdatePromptLabelsResponse = {
-  message: string;
-};
-
-export type TDeletePromptGroupResponse = TUpdatePromptLabelsResponse;
-
-export type TDeletePromptGroupRequest = {
-  id: string;
-};
-
-export type TGetCategoriesResponse = TCategory[];
-
-export type TGetRandomPromptsResponse = {
-  prompts: TPromptGroup[];
-};
-
-export type TGetRandomPromptsRequest = {
-  limit: number;
-  skip: number;
-};
-
-export type TCustomConfigSpeechResponse = { [key: string]: string };
-
-export type TUserTermsResponse = {
-  termsAccepted: boolean;
-};
-
-export type TAcceptTermsResponse = {
-  success: boolean;
-};
-
-export type TBannerResponse = TBanner | null;
-
-export type TUpdateFeedbackRequest = {
-  feedback?: TMinimalFeedback;
-};
-
-export type TUpdateFeedbackResponse = {
-  messageId: string;
-  conversationId: string;
-  feedback?: TMinimalFeedback;
-};
-
-export type TBalanceResponse = {
-  tokenCredits: number;
-  // Automatic refill settings
-  autoRefillEnabled: boolean;
-  refillIntervalValue?: number;
-  refillIntervalUnit?: 'seconds' | 'minutes' | 'hours' | 'days' | 'weeks' | 'months';
-  lastRefill?: Date;
-  refillAmount?: number;
-};