librechat-data-provider 0.1.2 → 0.1.4

package/src/types.ts

@@ -1,31 +1,11 @@
-export type TMessage = {
-  messageId: string;
-  conversationId: string;
-  clientId: string;
-  parentMessageId: string;
-  sender: string;
-  text: string;
-  isCreatedByUser: boolean;
-  error: boolean;
-  createdAt: string;
-  updatedAt: string;
-};
+import * as React from 'react';
+import { TExample, TMessage, EModelEndpoint, TPlugin, TConversation, TPreset } from './schemas';
 
-export type TExample = {
-  input: string;
-  output: string;
-};
+export * from './schemas';
 
-export enum EModelEndpoint {
-  azureOpenAI = 'azureOpenAI',
-  openAI = 'openAI',
-  bingAI = 'bingAI',
-  chatGPT = 'chatGPT',
-  chatGPTBrowser = 'chatGPTBrowser',
-  google = 'google',
-  gptPlugins = 'gptPlugins',
-  anthropic = 'anthropic',
-}
+export type TMessages = TMessage[];
+
+export type TMessagesAtom = TMessages | null;
 
 export type TSubmission = {
   clientId?: string;
@@ -33,7 +13,7 @@ export type TSubmission = {
   conversationId?: string;
   conversationSignature?: string;
   current: boolean;
-  endpoint: EModelEndpoint;
+  endpoint: EModelEndpoint | null;
   invocationId: number;
   isCreatedByUser: boolean;
   jailbreak: boolean;
@@ -57,25 +37,20 @@ export type TSubmission = {
 };
 
 export type TEndpointOption = {
-  endpoint: EModelEndpoint;
+  endpoint: EModelEndpoint | null;
   model?: string;
   promptPrefix?: string;
   temperature?: number;
 };
 
-export type TPluginAuthConfig = {
-  authField: string;
-  label: string;
-  description: string;
+export type TPluginAction = {
+  pluginKey: string;
+  action: 'install' | 'uninstall';
+  auth?: unknown;
 };
 
-export type TPlugin = {
-  name: string;
-  pluginKey: string;
-  description: string;
-  icon: string;
-  authConfig: TPluginAuthConfig[];
-  authenticated: boolean;
+export type TTemplate = {
+  [key: string]: TPlugin;
 };
 
 export type TUpdateUserPlugins = {
@@ -84,64 +59,9 @@ export type TUpdateUserPlugins = {
   auth?: unknown;
 };
 
-export type TConversation = {
-  conversationId: string;
-  title: string;
-  user?: string;
-  endpoint: EModelEndpoint;
-  suggestions?: string[];
-  messages?: TMessage[];
-  tools?: TPlugin[];
-  createdAt: string;
-  updatedAt: string;
-  // google only
-  modelLabel?: string;
-  examples?: TExample[];
-  // for azureOpenAI, openAI only
-  chatGptLabel?: string;
-  userLabel?: string;
-  model?: string;
-  promptPrefix?: string;
-  temperature?: number;
-  topP?: number;
-  topK?: number;
-  // bing and google
-  context?: string;
-  top_p?: number;
-  presence_penalty?: number;
-  // for bingAI only
-  jailbreak?: boolean;
-  jailbreakConversationId?: string;
-  conversationSignature?: string;
-  parentMessageId?: string;
-  clientId?: string;
-  invocationId?: string;
-  toneStyle?: string;
-};
-
-export type TPreset = {
-  title: string;
-  endpoint: EModelEndpoint;
-  conversationSignature?: string;
-  createdAt?: string;
-  updatedAt?: string;
-  presetId?: string;
-  user?: string;
-  // for azureOpenAI, openAI only
-  chatGptLabel?: string;
-  frequence_penalty?: number;
-  model?: string;
-  presence_penalty?: number;
-  promptPrefix?: string;
-  temperature?: number;
-  top_p?: number;
-  //for BingAI
-  clientId?: string;
-  invocationId?: number;
-  jailbreak?: boolean;
-  jailbreakPresetId?: string;
-  presetSignature?: string;
-  toneStyle?: string;
+export type TOptionSettings = {
+  showExamples?: boolean;
+  isCodeChat?: boolean;
 };
 
 export type TUser = {
@@ -196,15 +116,30 @@ export type TSearchResults = {
   filter: object;
 };
 
-export type TEndpoints = {
-  azureOpenAI: boolean;
-  bingAI: boolean;
-  ChatGptBrowser: {
+export type TEndpointsConfig = {
+  azureOpenAI: {
     availableModels: [];
-  };
-  OpenAI: {
+  } | null;
+  bingAI: {
     availableModels: [];
-  };
+  } | null;
+  chatGPTBrowser: {
+    availableModels: [];
+  } | null;
+  anthropic: {
+    availableModels: [];
+  } | null;
+  google: {
+    availableModels: [];
+  } | null;
+  openAI: {
+    availableModels: [];
+  } | null;
+  gptPlugins: {
+    availableModels: [];
+    availableTools?: [];
+    plugins?: [];
+  } | null;
 };
 
 export type TUpdateTokenCountResponse = {
@@ -257,6 +192,7 @@ export type TStartupConfig = {
   serverDomain: string;
   registrationEnabled: boolean;
   socialLoginEnabled: boolean;
+  emailEnabled: boolean;
 };
 
 export type TRefreshTokenResponse = {
@@ -265,7 +201,8 @@ export type TRefreshTokenResponse = {
 };
 
 export type TRequestPasswordResetResponse = {
-  link: string;
+  link?: string;
+  message?: string;
 };
 
 export type File = {
@@ -273,3 +210,137 @@ export type File = {
   date: number;
   size: number;
 };
+
+export type SetOption = (param: number | string) => (newValue: number | string | boolean) => void;
+export type SetExample = (
+  i: number,
+  type: string,
+  newValue: number | string | boolean | null,
+) => void;
+
+export enum Side {
+  Top = 'top',
+  Right = 'right',
+  Bottom = 'bottom',
+  Left = 'left',
+}
+
+export type OptionHoverProps = {
+  endpoint: string;
+  type: string;
+  side: Side;
+};
+
+export type BaseProps = {
+  conversation: TConversation | TPreset | null;
+  className?: string;
+  isPreset?: boolean;
+  readonly?: boolean;
+};
+
+export type SettingsProps = BaseProps & {
+  setOption: SetOption;
+};
+
+export type TModels = {
+  models: string[];
+};
+
+export type ModelSelectProps = SettingsProps & TModels;
+
+export type ExamplesProps = {
+  readonly?: boolean;
+  className?: string;
+  examples: TExample[];
+  setExample: SetExample;
+  addExample: () => void;
+  removeExample: () => void;
+};
+
+export type GoogleProps = {
+  showExamples: boolean;
+  isCodeChat: boolean;
+};
+
+export type GoogleViewProps = SettingsProps & GoogleProps;
+export type OptionComponent = React.FC<ModelSelectProps>;
+export type MultiViewComponent = React.FC<BaseProps & TModels>;
+
+export type SelectProps = {
+  conversation: TConversation | null;
+  setOption: SetOption;
+  extraProps?: GoogleProps;
+};
+
+export type SetOptionsPayload = {
+  setOption: SetOption;
+  setExample: SetExample;
+  addExample: () => void;
+  removeExample: () => void;
+  setAgentOption: SetOption;
+  getConversation: () => TConversation | TPreset | null;
+  checkPluginSelection: (value: string) => boolean;
+  setTools: (newValue: string) => void;
+};
+
+export type UseSetOptions = (preset?: TPreset | boolean | null) => SetOptionsPayload;
+export type UsePresetOptions = (preset?: TPreset | boolean | null) => SetOptionsPayload | boolean;
+
+export type PopoverButton = {
+  label: string;
+  buttonClass: string;
+  handler: () => void;
+  icon: React.ReactNode;
+};
+
+export type EndpointOptionsPopoverProps = {
+  children: React.ReactNode;
+  visible: boolean;
+  endpoint: EModelEndpoint;
+  saveAsPreset: () => void;
+  closePopover: () => void;
+};
+
+export type EditPresetProps = {
+  open: boolean;
+  onOpenChange: React.Dispatch<React.SetStateAction<boolean>>;
+  preset: TPreset;
+  title?: string;
+};
+
+export type MultiSelectDropDownProps = {
+  title?: string;
+  value: Array<{ icon?: string; name?: string; isButton?: boolean }>;
+  disabled?: boolean;
+  setSelected: (option: string) => void;
+  availableValues: TPlugin[];
+  showAbove?: boolean;
+  showLabel?: boolean;
+  containerClassName?: string;
+  isSelected: (value: string) => boolean;
+  className?: string;
+  optionValueKey?: string;
+};
+
+export type TError = {
+  message: string;
+  code?: number;
+  response?: {
+    data?: {
+      message?: string;
+    };
+  };
+};
+
+export type CleanupPreset = {
+  preset: Partial<TPreset>;
+  endpointsConfig?: TEndpointsConfig | Record<string, unknown>;
+};
+
+export type PagesProps = {
+  pages: number;
+  pageNumber: number;
+  setPageNumber: (pageNumber: number) => void;
+  nextPage: () => Promise<void>;
+  previousPage: () => Promise<void>;
+};

package/types/createPayload.d.ts

@@ -2,19 +2,19 @@ import type { TSubmission, EModelEndpoint } from './types';
 export default function createPayload(submission: TSubmission): {
     server: string;
     payload: {
-        conversationId: string;
-        endpoint: EModelEndpoint;
+        conversationId: string | null;
+        endpoint: EModelEndpoint | null;
         model?: string | undefined;
         promptPrefix?: string | undefined;
         temperature?: number | undefined;
-        messageId: string;
-        clientId: string;
+        error: boolean;
+        createdAt: string;
+        updatedAt: string;
         parentMessageId: string;
+        clientId: string;
+        messageId: string;
         sender: string;
         text: string;
         isCreatedByUser: boolean;
-        error: boolean;
-        createdAt: string;
-        updatedAt: string;
     };
 };

package/types/data-service.d.ts

@@ -1,15 +1,16 @@
 import * as t from './types';
+import * as s from './schemas';
 export declare function getConversations(pageNumber: string): Promise<t.TGetConversationsResponse>;
 export declare function abortRequestWithMessage(endpoint: string, abortKey: string, message: string): Promise<void>;
 export declare function deleteConversation(payload: t.TDeleteConversationRequest): Promise<any>;
 export declare function clearAllConversations(): Promise<unknown>;
-export declare function getMessagesByConvoId(id: string): Promise<t.TMessage[]>;
-export declare function getConversationById(id: string): Promise<t.TConversation>;
+export declare function getMessagesByConvoId(id: string): Promise<s.TMessage[]>;
+export declare function getConversationById(id: string): Promise<s.TConversation>;
 export declare function updateConversation(payload: t.TUpdateConversationRequest): Promise<t.TUpdateConversationResponse>;
-export declare function getPresets(): Promise<t.TPreset[]>;
-export declare function createPreset(payload: t.TPreset): Promise<t.TPreset[]>;
-export declare function updatePreset(payload: t.TPreset): Promise<t.TPreset[]>;
-export declare function deletePreset(arg: t.TPreset | object): Promise<t.TPreset[]>;
+export declare function getPresets(): Promise<s.TPreset[]>;
+export declare function createPreset(payload: s.TPreset): Promise<s.TPreset[]>;
+export declare function updatePreset(payload: s.TPreset): Promise<s.TPreset[]>;
+export declare function deletePreset(arg: s.TPreset | object): Promise<s.TPreset[]>;
 export declare function getSearchEnabled(): Promise<boolean>;
 export declare function getUser(): Promise<t.TUser>;
 export declare const searchConversations: (q: string, pageNumber: string) => Promise<t.TSearchResults>;
@@ -22,6 +23,6 @@ export declare const refreshToken: () => Promise<any>;
 export declare const getLoginGoogle: () => Promise<unknown>;
 export declare const requestPasswordReset: (payload: t.TRequestPasswordReset) => Promise<t.TRequestPasswordResetResponse>;
 export declare const resetPassword: (payload: t.TResetPassword) => Promise<any>;
-export declare const getAvailablePlugins: () => Promise<t.TPlugin[]>;
+export declare const getAvailablePlugins: () => Promise<s.TPlugin[]>;
 export declare const updateUserPlugins: (payload: t.TUpdateUserPlugins) => Promise<any>;
 export declare const getStartupConfig: () => Promise<t.TStartupConfig>;

package/types/react-query-service.d.ts

@@ -1,5 +1,6 @@
 import { UseQueryOptions, UseMutationResult, QueryObserverResult } from '@tanstack/react-query';
 import * as t from './types';
+import * as s from './schemas';
 export declare enum QueryKeys {
     messages = "messsages",
     allConversations = "allConversations",
@@ -19,27 +20,29 @@ export declare const useAbortRequestWithMessage: () => UseMutationResult<void, E
     message: string;
 }>;
 export declare const useGetUserQuery: (config?: UseQueryOptions<t.TUser>) => QueryObserverResult<t.TUser>;
-export declare const useGetMessagesByConvoId: (id: string, config?: UseQueryOptions<t.TMessage[]>) => QueryObserverResult<t.TMessage[]>;
-export declare const useGetConversationByIdQuery: (id: string, config?: UseQueryOptions<t.TConversation>) => QueryObserverResult<t.TConversation>;
-export declare const useGetConversationByIdMutation: (id: string) => UseMutationResult<t.TConversation>;
+export declare const useGetMessagesByConvoId: (id: string, config?: UseQueryOptions<s.TMessage[]>) => QueryObserverResult<s.TMessage[]>;
+export declare const useGetConversationByIdQuery: (id: string, config?: UseQueryOptions<s.TConversation>) => QueryObserverResult<s.TConversation>;
+export declare const useGetConversationByIdMutation: (id: string) => UseMutationResult<s.TConversation>;
 export declare const useUpdateConversationMutation: (id: string) => UseMutationResult<t.TUpdateConversationResponse, unknown, t.TUpdateConversationRequest, unknown>;
 export declare const useDeleteConversationMutation: (id?: string) => UseMutationResult<t.TDeleteConversationResponse, unknown, t.TDeleteConversationRequest, unknown>;
 export declare const useClearConversationsMutation: () => UseMutationResult<unknown>;
 export declare const useGetConversationsQuery: (pageNumber: string, config?: UseQueryOptions<t.TGetConversationsResponse>) => QueryObserverResult<t.TGetConversationsResponse>;
 export declare const useGetSearchEnabledQuery: (config?: UseQueryOptions<boolean>) => QueryObserverResult<boolean>;
-export declare const useGetEndpointsQuery: () => QueryObserverResult<t.TEndpoints>;
-export declare const useCreatePresetMutation: () => UseMutationResult<t.TPreset[], unknown, t.TPreset, unknown>;
-export declare const useUpdatePresetMutation: () => UseMutationResult<t.TPreset[], unknown, t.TPreset, unknown>;
-export declare const useGetPresetsQuery: (config?: UseQueryOptions<t.TPreset[]>) => QueryObserverResult<t.TPreset[], unknown>;
-export declare const useDeletePresetMutation: () => UseMutationResult<t.TPreset[], unknown, t.TPreset | object, unknown>;
+export declare const useGetEndpointsQuery: () => QueryObserverResult<t.TEndpointsConfig>;
+export declare const useCreatePresetMutation: () => UseMutationResult<s.TPreset[], unknown, s.TPreset, unknown>;
+export declare const useUpdatePresetMutation: () => UseMutationResult<s.TPreset[], unknown, s.TPreset, unknown>;
+export declare const useGetPresetsQuery: (config?: UseQueryOptions<s.TPreset[]>) => QueryObserverResult<s.TPreset[], unknown>;
+export declare const useDeletePresetMutation: () => UseMutationResult<s.TPreset[], unknown, s.TPreset | object, unknown>;
 export declare const useSearchQuery: (searchQuery: string, pageNumber: string, config?: UseQueryOptions<t.TSearchResults>) => QueryObserverResult<t.TSearchResults>;
-export declare const useUpdateTokenCountMutation: () => UseMutationResult<t.TUpdateTokenCountResponse, unknown, string, unknown>;
+export declare const useUpdateTokenCountMutation: () => UseMutationResult<t.TUpdateTokenCountResponse, unknown, {
+    text: string;
+}, unknown>;
 export declare const useLoginUserMutation: () => UseMutationResult<t.TLoginResponse, unknown, t.TLoginUser, unknown>;
 export declare const useRegisterUserMutation: () => UseMutationResult<unknown, unknown, t.TRegisterUser, unknown>;
 export declare const useLogoutUserMutation: () => UseMutationResult<unknown>;
 export declare const useRefreshTokenMutation: () => UseMutationResult<t.TRefreshTokenResponse, unknown, unknown, unknown>;
 export declare const useRequestPasswordResetMutation: () => UseMutationResult<t.TRequestPasswordResetResponse, unknown, t.TRequestPasswordReset, unknown>;
 export declare const useResetPasswordMutation: () => UseMutationResult<unknown, unknown, t.TResetPassword, unknown>;
-export declare const useAvailablePluginsQuery: () => QueryObserverResult<t.TPlugin[]>;
+export declare const useAvailablePluginsQuery: () => QueryObserverResult<s.TPlugin[]>;
 export declare const useUpdateUserPluginsMutation: () => UseMutationResult<t.TUser, unknown, t.TUpdateUserPlugins, unknown>;
 export declare const useGetStartupConfig: () => QueryObserverResult<t.TStartupConfig>;