librechat-data-provider 0.7.1 → 0.7.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "librechat-data-provider",
-  "version": "0.7.1",
+  "version": "0.7.2",
   "description": "data services for librechat apps",
   "main": "dist/index.js",
   "module": "dist/index.es.js",

package/src/api-endpoints.ts

@@ -128,14 +128,18 @@ export const images = () => `${files()}/images`;
 
 export const avatar = () => `${images()}/avatar`;
 
-export const speechToText = () => `${files()}/stt`;
+export const speech = () => `${files()}/speech`;
 
-export const textToSpeech = () => `${files()}/tts`;
+export const speechToText = () => `${speech()}/stt`;
+
+export const textToSpeech = () => `${speech()}/tts`;
 
 export const textToSpeechManual = () => `${textToSpeech()}/manual`;
 
 export const textToSpeechVoices = () => `${textToSpeech()}/voices`;
 
+export const getCustomConfigSpeech = () => `${speech()}/config/get`;
+
 export const getPromptGroup = (_id: string) => `${prompts()}/groups/${_id}`;
 
 export const getPromptGroupsWithFilters = (filter: object) => {
@@ -177,6 +181,8 @@ export const deletePrompt = ({ _id, groupId }: { _id: string; groupId: string })
 
 export const getCategories = () => '/api/categories';
 
+export const getAllPromptGroups = () => `${prompts()}/all`;
+
 /* Roles */
 export const roles = () => '/api/roles';
 export const getRole = (roleName: string) => `${roles()}/${roleName.toLowerCase()}`;

package/src/config.ts

@@ -136,71 +136,81 @@ export const defaultAssistantsVersion = {
   [EModelEndpoint.azureAssistants]: 1,
 };
 
-export const assistantEndpointSchema = z.object({
-  /* assistants specific */
-  disableBuilder: z.boolean().optional(),
-  pollIntervalMs: z.number().optional(),
-  timeoutMs: z.number().optional(),
-  version: z.union([z.string(), z.number()]).default(2),
-  supportedIds: z.array(z.string()).min(1).optional(),
-  excludedIds: z.array(z.string()).min(1).optional(),
-  privateAssistants: z.boolean().optional(),
-  retrievalModels: z.array(z.string()).min(1).optional().default(defaultRetrievalModels),
-  capabilities: z
-    .array(z.nativeEnum(Capabilities))
-    .optional()
-    .default([
-      Capabilities.code_interpreter,
-      Capabilities.image_vision,
-      Capabilities.retrieval,
-      Capabilities.actions,
-      Capabilities.tools,
-    ]),
-  /* general */
-  apiKey: z.string().optional(),
-  baseURL: z.string().optional(),
-  models: z
-    .object({
-      default: z.array(z.string()).min(1),
-      fetch: z.boolean().optional(),
-      userIdQuery: z.boolean().optional(),
-    })
-    .optional(),
-  titleConvo: z.boolean().optional(),
-  titleMethod: z.union([z.literal('completion'), z.literal('functions')]).optional(),
-  titleModel: z.string().optional(),
-  headers: z.record(z.any()).optional(),
+export const baseEndpointSchema = z.object({
+  streamRate: z.number().optional(),
 });
 
+export type TBaseEndpoint = z.infer<typeof baseEndpointSchema>;
+
+export const assistantEndpointSchema = baseEndpointSchema.merge(
+  z.object({
+    /* assistants specific */
+    disableBuilder: z.boolean().optional(),
+    pollIntervalMs: z.number().optional(),
+    timeoutMs: z.number().optional(),
+    version: z.union([z.string(), z.number()]).default(2),
+    supportedIds: z.array(z.string()).min(1).optional(),
+    excludedIds: z.array(z.string()).min(1).optional(),
+    privateAssistants: z.boolean().optional(),
+    retrievalModels: z.array(z.string()).min(1).optional().default(defaultRetrievalModels),
+    capabilities: z
+      .array(z.nativeEnum(Capabilities))
+      .optional()
+      .default([
+        Capabilities.code_interpreter,
+        Capabilities.image_vision,
+        Capabilities.retrieval,
+        Capabilities.actions,
+        Capabilities.tools,
+      ]),
+    /* general */
+    apiKey: z.string().optional(),
+    baseURL: z.string().optional(),
+    models: z
+      .object({
+        default: z.array(z.string()).min(1),
+        fetch: z.boolean().optional(),
+        userIdQuery: z.boolean().optional(),
+      })
+      .optional(),
+    titleConvo: z.boolean().optional(),
+    titleMethod: z.union([z.literal('completion'), z.literal('functions')]).optional(),
+    titleModel: z.string().optional(),
+    headers: z.record(z.any()).optional(),
+  }),
+);
+
 export type TAssistantEndpoint = z.infer<typeof assistantEndpointSchema>;
 
-export const endpointSchema = z.object({
-  name: z.string().refine((value) => !eModelEndpointSchema.safeParse(value).success, {
-    message: `Value cannot be one of the default endpoint (EModelEndpoint) values: ${Object.values(
-      EModelEndpoint,
-    ).join(', ')}`,
-  }),
-  apiKey: z.string(),
-  baseURL: z.string(),
-  models: z.object({
-    default: z.array(z.string()).min(1),
-    fetch: z.boolean().optional(),
-    userIdQuery: z.boolean().optional(),
+export const endpointSchema = baseEndpointSchema.merge(
+  z.object({
+    name: z.string().refine((value) => !eModelEndpointSchema.safeParse(value).success, {
+      message: `Value cannot be one of the default endpoint (EModelEndpoint) values: ${Object.values(
+        EModelEndpoint,
+      ).join(', ')}`,
+    }),
+    apiKey: z.string(),
+    baseURL: z.string(),
+    models: z.object({
+      default: z.array(z.string()).min(1),
+      fetch: z.boolean().optional(),
+      userIdQuery: z.boolean().optional(),
+    }),
+    titleConvo: z.boolean().optional(),
+    titleMethod: z.union([z.literal('completion'), z.literal('functions')]).optional(),
+    titleModel: z.string().optional(),
+    summarize: z.boolean().optional(),
+    summaryModel: z.string().optional(),
+    forcePrompt: z.boolean().optional(),
+    modelDisplayLabel: z.string().optional(),
+    headers: z.record(z.any()).optional(),
+    addParams: z.record(z.any()).optional(),
+    dropParams: z.array(z.string()).optional(),
+    customOrder: z.number().optional(),
+    directEndpoint: z.boolean().optional(),
+    titleMessageRole: z.string().optional(),
   }),
-  titleConvo: z.boolean().optional(),
-  titleMethod: z.union([z.literal('completion'), z.literal('functions')]).optional(),
-  titleModel: z.string().optional(),
-  summarize: z.boolean().optional(),
-  summaryModel: z.string().optional(),
-  forcePrompt: z.boolean().optional(),
-  modelDisplayLabel: z.string().optional(),
-  headers: z.record(z.any()).optional(),
-  addParams: z.record(z.any()).optional(),
-  dropParams: z.array(z.string()).optional(),
-  customOrder: z.number().optional(),
-  directEndpoint: z.boolean().optional(),
-  titleMessageRole: z.string().optional(),
-});
+);
 
 export type TEndpoint = z.infer<typeof endpointSchema>;
 
@@ -213,6 +223,7 @@ export const azureEndpointSchema = z
   .and(
     endpointSchema
       .pick({
+        streamRate: true,
         titleConvo: true,
         titleMethod: true,
         titleModel: true,
@@ -233,6 +244,15 @@ const ttsOpenaiSchema = z.object({
   voices: z.array(z.string()),
 });
 
+const ttsAzureOpenAISchema = z.object({
+  instanceName: z.string(),
+  apiKey: z.string(),
+  deploymentName: z.string(),
+  apiVersion: z.string(),
+  model: z.string(),
+  voices: z.array(z.string()),
+});
+
 const ttsElevenLabsSchema = z.object({
   url: z.string().optional(),
   websocketUrl: z.string().optional(),
@@ -259,20 +279,63 @@ const ttsLocalaiSchema = z.object({
 
 const ttsSchema = z.object({
   openai: ttsOpenaiSchema.optional(),
+  azureOpenAI: ttsAzureOpenAISchema.optional(),
   elevenLabs: ttsElevenLabsSchema.optional(),
   localai: ttsLocalaiSchema.optional(),
 });
 
+const sttOpenaiSchema = z.object({
+  url: z.string().optional(),
+  apiKey: z.string(),
+  model: z.string(),
+});
+
+const sttAzureOpenAISchema = z.object({
+  instanceName: z.string(),
+  apiKey: z.string(),
+  deploymentName: z.string(),
+  apiVersion: z.string(),
+});
+
 const sttSchema = z.object({
-  openai: z
-    .object({
-      url: z.string().optional(),
-      apiKey: z.string().optional(),
-      model: z.string().optional(),
-    })
-    .optional(),
+  openai: sttOpenaiSchema.optional(),
+  azureOpenAI: sttAzureOpenAISchema.optional(),
 });
 
+const speechTab = z
+  .object({
+    conversationMode: z.boolean().optional(),
+    advancedMode: z.boolean().optional(),
+    speechToText: z
+      .boolean()
+      .optional()
+      .or(
+        z.object({
+          engineSTT: z.string().optional(),
+          languageSTT: z.string().optional(),
+          autoTranscribeAudio: z.boolean().optional(),
+          decibelValue: z.number().optional(),
+          autoSendText: z.number().optional(),
+        }),
+      )
+      .optional(),
+    textToSpeech: z
+      .boolean()
+      .optional()
+      .or(
+        z.object({
+          engineTTS: z.string().optional(),
+          voice: z.string().optional(),
+          languageTTS: z.string().optional(),
+          automaticPlayback: z.boolean().optional(),
+          playbackRate: z.number().optional(),
+          cacheTTS: z.boolean().optional(),
+        }),
+      )
+      .optional(),
+  })
+  .optional();
+
 export enum RateLimitPrefix {
   FILE_UPLOAD = 'FILE_UPLOAD',
   IMPORT = 'IMPORT',
@@ -362,17 +425,27 @@ export const configSchema = z.object({
       allowedDomains: z.array(z.string()).optional(),
     })
     .default({ socialLogins: defaultSocialLogins }),
-  tts: ttsSchema.optional(),
-  stt: sttSchema.optional(),
+  speech: z
+    .object({
+      tts: ttsSchema.optional(),
+      stt: sttSchema.optional(),
+      speechTab: speechTab.optional(),
+    })
+    .optional(),
   rateLimits: rateLimitSchema.optional(),
   fileConfig: fileConfigSchema.optional(),
   modelSpecs: specsConfigSchema.optional(),
   endpoints: z
     .object({
+      all: baseEndpointSchema.optional(),
+      [EModelEndpoint.openAI]: baseEndpointSchema.optional(),
+      [EModelEndpoint.google]: baseEndpointSchema.optional(),
+      [EModelEndpoint.anthropic]: baseEndpointSchema.optional(),
+      [EModelEndpoint.gptPlugins]: baseEndpointSchema.optional(),
       [EModelEndpoint.azureOpenAI]: azureEndpointSchema.optional(),
       [EModelEndpoint.azureAssistants]: assistantEndpointSchema.optional(),
       [EModelEndpoint.assistants]: assistantEndpointSchema.optional(),
-      custom: z.array(endpointSchema.partial()).optional(),
+      [EModelEndpoint.custom]: z.array(endpointSchema.partial()).optional(),
     })
     .strict()
     .refine((data) => Object.keys(data).length > 0, {
@@ -600,6 +673,16 @@ export enum InfiniteCollections {
   SHARED_LINKS = 'sharedLinks',
 }
 
+/**
+ * Enum for time intervals
+ */
+export enum Time {
+  THIRTY_MINUTES = 1800000,
+  TEN_MINUTES = 600000,
+  FIVE_MINUTES = 300000,
+  TWO_MINUTES = 120000,
+}
+
 /**
  * Enum for cache keys.
  */
@@ -670,6 +753,10 @@ export enum CacheKeys {
    * Key for the cached audio run Ids.
    */
   AUDIO_RUNS = 'audioRuns',
+  /**
+   * Key for in-progress messages.
+   */
+  MESSAGES = 'messages',
 }
 
 /**
@@ -785,9 +872,9 @@ export enum SettingsTabValues {
    */
   GENERAL = 'general',
   /**
-   * Tab for Messages Settings
+   * Tab for Chat Settings
    */
-  MESSAGES = 'messages',
+  CHAT = 'chat',
   /**
    * Tab for Speech Settings
    */
@@ -806,12 +893,42 @@ export enum SettingsTabValues {
   ACCOUNT = 'account',
 }
 
+export enum STTProviders {
+  /**
+   * Provider for OpenAI STT
+   */
+  OPENAI = 'openai',
+  /**
+   * Provider for Microsoft Azure STT
+   */
+  AZURE_OPENAI = 'azureOpenAI',
+}
+
+export enum TTSProviders {
+  /**
+   * Provider for OpenAI TTS
+   */
+  OPENAI = 'openai',
+  /**
+   * Provider for Microsoft Azure OpenAI TTS
+   */
+  AZURE_OPENAI = 'azureOpenAI',
+  /**
+   * Provider for ElevenLabs TTS
+   */
+  ELEVENLABS = 'elevenlabs',
+  /**
+   * Provider for LocalAI TTS
+   */
+  LOCALAI = 'localai',
+}
+
 /** Enum for app-wide constants */
 export enum Constants {
   /** Key for the app's version. */
   VERSION = 'v0.7.4-rc1',
   /** Key for the Custom Config's version (librechat.yaml). */
-  CONFIG_VERSION = '1.1.4',
+  CONFIG_VERSION = '1.1.5',
   /** Standard value for the first message's `parentMessageId` value, to indicate no parent exists. */
   NO_PARENT = '00000000-0000-0000-0000-000000000000',
   /** Standard value for the initial conversationId before a request is sent */
@@ -822,6 +939,10 @@ export enum Constants {
   CURRENT_MODEL = 'current_model',
   /** Common divider for text values */
   COMMON_DIVIDER = '__',
+  /** Max length for commands */
+  COMMANDS_MAX_LENGTH = 56,
+  /** Default Stream Rate (ms) */
+  DEFAULT_STREAM_RATE = 1,
 }
 
 export enum LocalStorageKeys {

package/src/data-service.ts

@@ -355,6 +355,10 @@ export const getVoices = (): Promise<f.VoiceResponse> => {
   return request.get(endpoints.textToSpeechVoices());
 };
 
+export const getCustomConfigSpeech = (): Promise<t.TCustomConfigSpeechResponse> => {
+  return request.get(endpoints.getCustomConfigSpeech());
+};
+
 /* actions */
 
 export const updateAction = (data: m.UpdateActionVariables): Promise<m.UpdateActionResponse> => {
@@ -475,6 +479,10 @@ export function getPrompts(filter: t.TPromptsWithFilterRequest): Promise<t.TProm
   return request.get(endpoints.getPromptsWithFilters(filter));
 }
 
+export function getAllPromptGroups(): Promise<q.AllPromptGroupsResponse> {
+  return request.get(endpoints.getAllPromptGroups());
+}
+
 export function getPromptGroups(
   filter: t.TPromptGroupsWithFilterRequest,
 ): Promise<t.PromptGroupListResponse> {

package/src/keys.ts

@@ -27,9 +27,11 @@ export enum QueryKeys {
   assistantDocs = 'assistantDocs',
   fileDownload = 'fileDownload',
   voices = 'voices',
+  customConfigSpeech = 'customConfigSpeech',
   prompts = 'prompts',
   prompt = 'prompt',
   promptGroups = 'promptGroups',
+  allPromptGroups = 'allPromptGroups',
   promptGroup = 'promptGroup',
   categories = 'categories',
   randomPrompts = 'randomPrompts',

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

@@ -422,3 +422,18 @@ export const useGetStartupConfig = (
     },
   );
 };
+
+export const useGetCustomConfigSpeechQuery = (
+  config?: UseQueryOptions<t.TCustomConfigSpeechResponse>,
+): QueryObserverResult<t.TCustomConfigSpeechResponse> => {
+  return useQuery<t.TCustomConfigSpeechResponse>(
+    [QueryKeys.customConfigSpeech],
+    () => dataService.getCustomConfigSpeech(),
+    {
+      refetchOnWindowFocus: false,
+      refetchOnReconnect: false,
+      refetchOnMount: false,
+      ...config,
+    },
+  );
+};

package/src/types/queries.ts

@@ -1,5 +1,6 @@
 import type { InfiniteData } from '@tanstack/react-query';
 import type { TMessage, TConversation, TSharedLink } from '../schemas';
+import type * as t from '../types';
 export type Conversation = {
   id: string;
   createdAt: number;
@@ -54,3 +55,16 @@ export type SharedLinkListResponse = {
 };
 
 export type SharedLinkListData = InfiniteData<SharedLinkListResponse>;
+
+export type AllPromptGroupsFilterRequest = {
+  category: string;
+  pageNumber: string;
+  pageSize: string | number;
+  before?: string | null;
+  after?: string | null;
+  order?: 'asc' | 'desc';
+  name?: string;
+  author?: string;
+};
+
+export type AllPromptGroupsResponse = t.TPromptGroup[];

package/src/types.ts

@@ -351,6 +351,7 @@ export type TPrompt = {
 export type TPromptGroup = {
   name: string;
   numberOfGenerations?: number;
+  command?: string;
   oneliner?: string;
   category?: string;
   projectIds?: string[];
@@ -365,7 +366,7 @@ export type TPromptGroup = {
 
 export type TCreatePrompt = {
   prompt: Pick<TPrompt, 'prompt' | 'type'> & { groupId?: string };
-  group?: { name: string; category?: string; oneliner?: string };
+  group?: { name: string; category?: string; oneliner?: string; command?: string };
 };
 
 export type TCreatePromptRecord = TCreatePrompt & Pick<TPromptGroup, 'author' | 'authorName'>;
@@ -385,6 +386,7 @@ export type TPromptGroupsWithFilterRequest = {
   after?: string | null;
   order?: 'asc' | 'desc';
   name?: string;
+  author?: string;
 };
 
 export type PromptGroupListResponse = {
@@ -461,3 +463,5 @@ export type TGetRandomPromptsRequest = {
   limit: number;
   skip: number;
 };
+
+export type TCustomConfigSpeechResponse = { [key: string]: string };