Merge pull request #3 from danny-avila/main

Pulling Latest LibreChat Commits

.env.example

@@ -2,11 +2,9 @@
 #                       LibreChat Configuration                       #
 #=====================================================================#
 # Please refer to the reference documentation for assistance          #
-# with configuring your LibreChat environment. The guide is           #
-# available both online and within your local LibreChat               #
-# directory:                                                          #
-# Online: https://docs.librechat.ai/install/configuration/dotenv.html #
-# Locally: ./docs/install/configuration/dotenv.md                     #
+# with configuring your LibreChat environment.                        #
+#                                                                     #
+# https://www.librechat.ai/docs/configuration/dotenv                  #
 #=====================================================================#
 
 #==================================================#
@@ -62,15 +60,17 @@ PROXY=
 #===================================#
 # Known Endpoints - librechat.yaml  #
 #===================================#
-# https://docs.librechat.ai/install/configuration/ai_endpoints.html
+# https://www.librechat.ai/docs/configuration/librechat_yaml/ai_endpoints
 
-# GROQ_API_KEY=
-# SHUTTLEAI_KEY=
-# OPENROUTER_KEY=
-# MISTRAL_API_KEY=
 # ANYSCALE_API_KEY=
+# APIPIE_API_KEY=
 # FIREWORKS_API_KEY=
+# GROQ_API_KEY=
+# HUGGINGFACE_TOKEN=
+# MISTRAL_API_KEY=
+# OPENROUTER_KEY=
 # PERPLEXITY_API_KEY=
+# SHUTTLEAI_API_KEY=
 # TOGETHERAI_API_KEY=
 
 #============#
@@ -113,15 +113,34 @@ BINGAI_TOKEN=user_provided
 #============#
 
 GOOGLE_KEY=user_provided
-# GOOGLE_MODELS=gemini-pro,gemini-pro-vision,chat-bison,chat-bison-32k,codechat-bison,codechat-bison-32k,text-bison,text-bison-32k,text-unicorn,code-gecko,code-bison,code-bison-32k
 # GOOGLE_REVERSE_PROXY=
 
+# Gemini API
+# GOOGLE_MODELS=gemini-1.5-flash-latest,gemini-1.0-pro,gemini-1.0-pro-001,gemini-1.0-pro-latest,gemini-1.0-pro-vision-latest,gemini-1.5-pro-latest,gemini-pro,gemini-pro-vision
+
+# Vertex AI
+# GOOGLE_MODELS=gemini-1.5-flash-preview-0514,gemini-1.5-pro-preview-0409,gemini-1.0-pro-vision-001,gemini-pro,gemini-pro-vision,chat-bison,chat-bison-32k,codechat-bison,codechat-bison-32k,text-bison,text-bison-32k,text-unicorn,code-gecko,code-bison,code-bison-32k
+
+# Google Gemini Safety Settings
+# NOTE (Vertex AI): You do not have access to the BLOCK_NONE setting by default.
+# To use this restricted HarmBlockThreshold setting, you will need to either:
+#
+# (a) Get access through an allowlist via your Google account team
+# (b) Switch your account type to monthly invoiced billing following this instruction:
+#     https://cloud.google.com/billing/docs/how-to/invoiced-billing
+#
+# GOOGLE_SAFETY_SEXUALLY_EXPLICIT=BLOCK_ONLY_HIGH
+# GOOGLE_SAFETY_HATE_SPEECH=BLOCK_ONLY_HIGH
+# GOOGLE_SAFETY_HARASSMENT=BLOCK_ONLY_HIGH
+# GOOGLE_SAFETY_DANGEROUS_CONTENT=BLOCK_ONLY_HIGH
+
+
 #============#
 # OpenAI     #
 #============#
 
 OPENAI_API_KEY=user_provided
-# OPENAI_MODELS=gpt-3.5-turbo-0125,gpt-3.5-turbo-0301,gpt-3.5-turbo,gpt-4,gpt-4-0613,gpt-4-vision-preview,gpt-3.5-turbo-0613,gpt-3.5-turbo-16k-0613,gpt-4-0125-preview,gpt-4-turbo-preview,gpt-4-1106-preview,gpt-3.5-turbo-1106,gpt-3.5-turbo-instruct,gpt-3.5-turbo-instruct-0914,gpt-3.5-turbo-16k
+# OPENAI_MODELS=gpt-4o,gpt-3.5-turbo-0125,gpt-3.5-turbo-0301,gpt-3.5-turbo,gpt-4,gpt-4-0613,gpt-4-vision-preview,gpt-3.5-turbo-0613,gpt-3.5-turbo-16k-0613,gpt-4-0125-preview,gpt-4-turbo-preview,gpt-4-1106-preview,gpt-3.5-turbo-1106,gpt-3.5-turbo-instruct,gpt-3.5-turbo-instruct-0914,gpt-3.5-turbo-16k
 
 DEBUG_OPENAI=false
 
@@ -143,19 +162,19 @@ DEBUG_OPENAI=false
 
 ASSISTANTS_API_KEY=user_provided
 # ASSISTANTS_BASE_URL=
-# ASSISTANTS_MODELS=gpt-3.5-turbo-0125,gpt-3.5-turbo-16k-0613,gpt-3.5-turbo-16k,gpt-3.5-turbo,gpt-4,gpt-4-0314,gpt-4-32k-0314,gpt-4-0613,gpt-3.5-turbo-0613,gpt-3.5-turbo-1106,gpt-4-0125-preview,gpt-4-turbo-preview,gpt-4-1106-preview
+# ASSISTANTS_MODELS=gpt-4o,gpt-3.5-turbo-0125,gpt-3.5-turbo-16k-0613,gpt-3.5-turbo-16k,gpt-3.5-turbo,gpt-4,gpt-4-0314,gpt-4-32k-0314,gpt-4-0613,gpt-3.5-turbo-0613,gpt-3.5-turbo-1106,gpt-4-0125-preview,gpt-4-turbo-preview,gpt-4-1106-preview
 
 #============#
 # OpenRouter #
 #============#
-
+# !!!Warning: Use the variable above instead of this one. Using this one will override the OpenAI endpoint
 # OPENROUTER_API_KEY=
 
 #============#
 # Plugins    #
 #============#
 
-# PLUGIN_MODELS=gpt-4,gpt-4-turbo-preview,gpt-4-0125-preview,gpt-4-1106-preview,gpt-4-0613,gpt-3.5-turbo,gpt-3.5-turbo-0125,gpt-3.5-turbo-1106,gpt-3.5-turbo-0613
+# PLUGIN_MODELS=gpt-4o,gpt-4,gpt-4-turbo-preview,gpt-4-0125-preview,gpt-4-1106-preview,gpt-4-0613,gpt-3.5-turbo,gpt-3.5-turbo-0125,gpt-3.5-turbo-1106,gpt-3.5-turbo-0613
 
 DEBUG_PLUGINS=true
 
@@ -192,7 +211,7 @@ AZURE_AI_SEARCH_SEARCH_OPTION_SELECT=
 
 # Google
 #-----------------
-GOOGLE_API_KEY=
+GOOGLE_SEARCH_API_KEY=
 GOOGLE_CSE_ID=
 
 # SerpAPI

.eslintrc.js

@@ -132,6 +132,13 @@ module.exports = {
         },
       ],
     },
+    {
+      files: './config/translations/**/*.ts',
+      parser: '@typescript-eslint/parser',
+      parserOptions: {
+        project: './config/translations/tsconfig.json',
+      },
+    },
     {
       files: ['./packages/data-provider/specs/**/*.ts'],
       parserOptions: {

.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml

@@ -43,7 +43,7 @@ body:
     id: terms
     attributes:
       label: Code of Conduct
-      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/danny-avila/LibreChat/blob/main/CODE_OF_CONDUCT.md)
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/danny-avila/LibreChat/blob/main/.github/CODE_OF_CONDUCT.md)
       options:
         - label: I agree to follow this project's Code of Conduct
           required: true

.github/ISSUE_TEMPLATE/QUESTION.yml

@@ -44,7 +44,7 @@ body:
     id: terms
     attributes:
       label: Code of Conduct
-      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/danny-avila/LibreChat/blob/main/CODE_OF_CONDUCT.md)
+      description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/danny-avila/LibreChat/blob/main/.github/CODE_OF_CONDUCT.md)
       options:
         - label: I agree to follow this project's Code of Conduct
           required: true

.github/pull_request_template.md

@@ -1,7 +1,10 @@
 # Pull Request Template
 
+⚠️ Before Submitting a PR, Please Review:
+- Please ensure that you have thoroughly read and understood the [Contributing Docs](https://github.com/danny-avila/LibreChat/blob/main/.github/CONTRIBUTING.md) before submitting your Pull Request.
 
-### ⚠️ Before Submitting a PR, read the [Contributing Docs](https://github.com/danny-avila/LibreChat/blob/main/.github/CONTRIBUTING.md) in full!
+⚠️ Documentation Updates Notice:
+- Kindly note that documentation updates are managed in this repository: [librechat.ai](https://github.com/LibreChat-AI/librechat.ai)
 
 ## Summary
 
@@ -16,8 +19,6 @@ Please delete any irrelevant options.
 - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
 - [ ] This change requires a documentation update
 - [ ] Translation update
-- [ ] Documentation update
-
 
 ## Testing
 
@@ -37,4 +38,4 @@ Please delete any irrelevant options.
 - [ ] I have written tests demonstrating that my changes are effective or that my feature works
 - [ ] Local unit tests pass with my changes
 - [ ] Any changes dependent on mine have been merged and published in downstream modules.
-- [ ] New documents have been locally validated with mkdocs
+- [ ] A pull request for updating the documentation has been submitted.

.github/workflows/backend-review.yml

@@ -51,6 +51,9 @@ jobs:
             exit 1
           fi
 
+      - name: Prepare .env.test file
+        run: cp api/test/.env.test.example api/test/.env.test
+
       - name: Run unit tests
         run: cd api && npm run test:ci
 
@@ -60,4 +63,4 @@ jobs:
       - name: Run linters
         uses: wearerequired/lint-action@v2
         with:
-          eslint: true
+          eslint: true

.github/workflows/frontend-review.yml

@@ -1,11 +1,6 @@
-#github action to run unit tests for frontend with jest
 name: Frontend Unit Tests
+
 on:
-  # push:
-  #   branches: 
-  #     - main
-  #     - dev
-  #     - release/*
   pull_request:
     branches: 
       - main
@@ -14,9 +9,10 @@ on:
     paths:
       - 'client/**'
       - 'packages/**'
+
 jobs:
-  tests_frontend:
-    name: Run frontend unit tests
+  tests_frontend_ubuntu:
+    name: Run frontend unit tests on Ubuntu
     timeout-minutes: 60
     runs-on: ubuntu-latest
     steps:
@@ -35,4 +31,26 @@ jobs:
 
       - name: Run unit tests
         run: npm run test:ci --verbose
-        working-directory: client
+        working-directory: client
+
+  tests_frontend_windows:
+    name: Run frontend unit tests on Windows
+    timeout-minutes: 60
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js 20.x
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build Client
+        run: npm run frontend:ci
+
+      - name: Run unit tests
+        run: npm run test:ci --verbose
+        working-directory: client

.gitignore

@@ -21,6 +21,10 @@ coverage
 # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
 .grunt
 
+# translation services
+config/translations/stores/*
+client/src/localization/languages/*_missing_keys.json
+
 # Compiled Dirs (http://nodejs.org/api/addons.html)
 build/
 dist/
@@ -69,13 +73,16 @@ src/style - official.css
 /playwright/.cache/
 .DS_Store
 *.code-workspace
+.idx
+monospace.json
 .idea
 *.iml
 *.pem
 config.local.ts
 **/storageState.json
 junit.xml
 **/.venv/
+**/venv/
 
 # docker override file
 docker-compose.override.yaml

Dockerfile

@@ -1,10 +1,8 @@
-# v0.7.0
+# v0.7.2
 
 # Base node image
-FROM node:18-alpine3.18 AS node
+FROM node:20-alpine AS node
 
-RUN apk add g++ make py3-pip
-RUN npm install -g node-gyp
 RUN apk --no-cache add curl
 
 RUN mkdir -p /app && chown node:node /app
@@ -14,20 +12,20 @@ USER node
 
 COPY --chown=node:node . .
 
-# Allow mounting of these files, which have no default
-# values.
-RUN touch .env
-RUN npm config set fetch-retry-maxtimeout 600000
-RUN npm config set fetch-retries 5
-RUN npm config set fetch-retry-mintimeout 15000
-RUN npm install --no-audit
+RUN \
+    # Allow mounting of these files, which have no default
+    touch .env ; \
+    # Create directories for the volumes to inherit the correct permissions
+    mkdir -p /app/client/public/images /app/api/logs ; \
+    npm config set fetch-retry-maxtimeout 600000 ; \
+    npm config set fetch-retries 5 ; \
+    npm config set fetch-retry-mintimeout 15000 ; \
+    npm install --no-audit; \
+    # React client build
+    NODE_OPTIONS="--max-old-space-size=2048" npm run frontend; \
+    npm prune --production; \
+    npm cache clean --force
 
-# React client build
-ENV NODE_OPTIONS="--max-old-space-size=2048"
-RUN npm run frontend
-
-# Create directories for the volumes to inherit
-# the correct permissions
 RUN mkdir -p /app/client/public/images /app/api/logs
 
 # Node API setup

Dockerfile.multi

@@ -1,4 +1,4 @@
-# v0.7.0
+# v0.7.2
 
 # Build API, Client and Data Provider
 FROM node:20-alpine AS base
@@ -7,32 +7,31 @@ FROM node:20-alpine AS base
 FROM base AS data-provider-build
 WORKDIR /app/packages/data-provider
 COPY ./packages/data-provider ./
-RUN npm install
+RUN npm install; npm cache clean --force
 RUN npm run build
+RUN npm prune --production
 
 # React client build
-FROM data-provider-build AS client-build
+FROM base AS client-build
 WORKDIR /app/client
 COPY ./client/package*.json ./
 # Copy data-provider to client's node_modules
-RUN mkdir -p /app/client/node_modules/librechat-data-provider/
-RUN cp -R /app/packages/data-provider/* /app/client/node_modules/librechat-data-provider/
-RUN npm install
+COPY --from=data-provider-build /app/packages/data-provider/ /app/client/node_modules/librechat-data-provider/
+RUN npm install; npm cache clean --force
 COPY ./client/ ./
 ENV NODE_OPTIONS="--max-old-space-size=2048"
 RUN npm run build
 
 # Node API setup
-FROM data-provider-build AS api-build
+FROM base AS api-build
 WORKDIR /app/api
 COPY api/package*.json ./
 COPY api/ ./
 # Copy helper scripts
 COPY config/ ./
 # Copy data-provider to API's node_modules
-RUN mkdir -p /app/api/node_modules/librechat-data-provider/
-RUN cp -R /app/packages/data-provider/* /app/api/node_modules/librechat-data-provider/
-RUN npm install
+COPY --from=data-provider-build /app/packages/data-provider/ /app/api/node_modules/librechat-data-provider/
+RUN npm install --include prod; npm cache clean --force
 COPY --from=client-build /app/client/dist /app/client/dist
 EXPOSE 3080
 ENV HOST=0.0.0.0