📦 refactor: Consolidate DB models, encapsulating Mongoose usage in data-schemas (#11830)

* chore: move database model methods to /packages/data-schemas

* chore: add TypeScript ESLint rule to warn on unused variables

* refactor: model imports to streamline access

- Consolidated model imports across various files to improve code organization and reduce redundancy.
- Updated imports for models such as Assistant, Message, Conversation, and others to a unified import path.
- Adjusted middleware and service files to reflect the new import structure, ensuring functionality remains intact.
- Enhanced test files to align with the new import paths, maintaining test coverage and integrity.

* chore: migrate database models to packages/data-schemas and refactor all direct Mongoose Model usage outside of data-schemas

* test: update agent model mocks in unit tests

- Added `getAgent` mock to `client.test.js` to enhance test coverage for agent-related functionality.
- Removed redundant `getAgent` and `getAgents` mocks from `openai.spec.js` and `responses.unit.spec.js` to streamline test setup and reduce duplication.
- Ensured consistency in agent mock implementations across test files.

* fix: update types in data-schemas

* refactor: enhance type definitions in transaction and spending methods

- Updated type definitions in `checkBalance.ts` to use specific request and response types.
- Refined `spendTokens.ts` to utilize a new `SpendTxData` interface for better clarity and type safety.
- Improved transaction handling in `transaction.ts` by introducing `TransactionResult` and `TxData` interfaces, ensuring consistent data structures across methods.
- Adjusted unit tests in `transaction.spec.ts` to accommodate new type definitions and enhance robustness.

* refactor: streamline model imports and enhance code organization

- Consolidated model imports across various controllers and services to a unified import path, improving code clarity and reducing redundancy.
- Updated multiple files to reflect the new import structure, ensuring all functionalities remain intact.
- Enhanced overall code organization by removing duplicate import statements and optimizing the usage of model methods.

* feat: implement loadAddedAgent and refactor agent loading logic

- Introduced `loadAddedAgent` function to handle loading agents from added conversations, supporting multi-convo parallel execution.
- Created a new `load.ts` file to encapsulate agent loading functionalities, including `loadEphemeralAgent` and `loadAgent`.
- Updated the `index.ts` file to export the new `load` module instead of the deprecated `loadAgent`.
- Enhanced type definitions and improved error handling in the agent loading process.
- Adjusted unit tests to reflect changes in the agent loading structure and ensure comprehensive coverage.

* refactor: enhance balance handling with new update interface

- Introduced `IBalanceUpdate` interface to streamline balance update operations across the codebase.
- Updated `upsertBalanceFields` method signatures in `balance.ts`, `transaction.ts`, and related tests to utilize the new interface for improved type safety.
- Adjusted type imports in `balance.spec.ts` to include `IBalanceUpdate`, ensuring consistency in balance management functionalities.
- Enhanced overall code clarity and maintainability by refining type definitions related to balance operations.

* feat: add unit tests for loadAgent functionality and enhance agent loading logic

- Introduced comprehensive unit tests for the `loadAgent` function, covering various scenarios including null and empty agent IDs, loading of ephemeral agents, and permission checks.
- Enhanced the `initializeClient` function by moving `getConvoFiles` to the correct position in the database method exports, ensuring proper functionality.
- Improved test coverage for agent loading, including handling of non-existent agents and user permissions.

* chore: reorder memory method exports for consistency

- Moved `deleteAllUserMemories` to the correct position in the exported memory methods, ensuring a consistent and logical order of method exports in `memory.ts`.

api/server/middleware/abortMiddleware.js

@@ -1,17 +1,16 @@
 const { logger } = require('@librechat/data-schemas');
+const { isAssistantsEndpoint, ErrorTypes } = require('librechat-data-provider');
 const {
-  countTokens,
   isEnabled,
   sendEvent,
+  countTokens,
   GenerationJobManager,
   sanitizeMessageForTransmit,
 } = require('@librechat/api');
-const { isAssistantsEndpoint, ErrorTypes } = require('librechat-data-provider');
-const { spendTokens, spendStructuredTokens } = require('~/models/spendTokens');
+const { spendTokens, spendStructuredTokens, saveMessage, getConvo } = require('~/models');
 const { truncateText, smartTruncateText } = require('~/app/clients/prompts');
 const clearPendingReq = require('~/cache/clearPendingReq');
 const { sendError } = require('~/server/middleware/error');
-const { saveMessage, getConvo } = require('~/models');
 const { abortRun } = require('./abortRun');
 
 /**
@@ -154,7 +153,11 @@ async function abortMessage(req, res) {
   }
 
   await saveMessage(
-    req,
+    {
+      userId: req?.user?.id,
+      isTemporary: req?.body?.isTemporary,
+      interfaceConfig: req?.config?.interfaceConfig,
+    },
     { ...responseMessage, user: userId },
     { context: 'api/server/middleware/abortMiddleware.js' },
   );

api/server/middleware/abortMiddleware.spec.js

@@ -9,11 +9,6 @@
 const mockSpendTokens = jest.fn().mockResolvedValue();
 const mockSpendStructuredTokens = jest.fn().mockResolvedValue();
 
-jest.mock('~/models/spendTokens', () => ({
-  spendTokens: (...args) => mockSpendTokens(...args),
-  spendStructuredTokens: (...args) => mockSpendStructuredTokens(...args),
-}));
-
 jest.mock('@librechat/data-schemas', () => ({
   logger: {
     debug: jest.fn(),
@@ -52,6 +47,8 @@ jest.mock('~/server/middleware/error', () => ({
 jest.mock('~/models', () => ({
   saveMessage: jest.fn().mockResolvedValue(),
   getConvo: jest.fn().mockResolvedValue({ title: 'Test Chat' }),
+  spendTokens: (...args) => mockSpendTokens(...args),
+  spendStructuredTokens: (...args) => mockSpendStructuredTokens(...args),
 }));
 
 jest.mock('./abortRun', () => ({

api/server/middleware/abortRun.js

@@ -3,8 +3,7 @@ const { logger } = require('@librechat/data-schemas');
 const { CacheKeys, RunStatus, isUUID } = require('librechat-data-provider');
 const { initializeClient } = require('~/server/services/Endpoints/assistants');
 const { checkMessageGaps, recordUsage } = require('~/server/services/Threads');
-const { deleteMessages } = require('~/models/Message');
-const { getConvo } = require('~/models/Conversation');
+const { deleteMessages, getConvo } = require('~/models');
 const getLogStores = require('~/cache/getLogStores');
 
 const three_minutes = 1000 * 60 * 3;

api/server/middleware/accessResources/canAccessAgentFromBody.js

@@ -6,7 +6,7 @@ const {
   isEphemeralAgentId,
 } = require('librechat-data-provider');
 const { canAccessResource } = require('./canAccessResource');
-const { getAgent } = require('~/models/Agent');
+const { getAgent } = require('~/models');
 
 /**
  * Agent ID resolver function for agent_id from request body

api/server/middleware/accessResources/canAccessAgentResource.js

@@ -1,6 +1,6 @@
 const { ResourceType } = require('librechat-data-provider');
 const { canAccessResource } = require('./canAccessResource');
-const { getAgent } = require('~/models/Agent');
+const { getAgent } = require('~/models');
 
 /**
  * Agent ID resolver function

api/server/middleware/accessResources/canAccessAgentResource.spec.js

@@ -3,7 +3,7 @@ const { ResourceType, PrincipalType, PrincipalModel } = require('librechat-data-
 const { MongoMemoryServer } = require('mongodb-memory-server');
 const { canAccessAgentResource } = require('./canAccessAgentResource');
 const { User, Role, AclEntry } = require('~/db/models');
-const { createAgent } = require('~/models/Agent');
+const { createAgent } = require('~/models');
 
 describe('canAccessAgentResource middleware', () => {
   let mongoServer;
@@ -373,7 +373,7 @@ describe('canAccessAgentResource middleware', () => {
       jest.clearAllMocks();
 
       // Update the agent
-      const { updateAgent } = require('~/models/Agent');
+      const { updateAgent } = require('~/models');
       await updateAgent({ id: agentId }, { description: 'Updated description' });
 
       // Test edit access

api/server/middleware/accessResources/canAccessPromptGroupResource.js

@@ -1,6 +1,6 @@
 const { ResourceType } = require('librechat-data-provider');
 const { canAccessResource } = require('./canAccessResource');
-const { getPromptGroup } = require('~/models/Prompt');
+const { getPromptGroup } = require('~/models');
 
 /**
  * PromptGroup ID resolver function

api/server/middleware/accessResources/canAccessPromptViaGroup.js

@@ -1,6 +1,6 @@
 const { ResourceType } = require('librechat-data-provider');
 const { canAccessResource } = require('./canAccessResource');
-const { getPrompt } = require('~/models/Prompt');
+const { getPrompt } = require('~/models');
 
 /**
  * Prompt to PromptGroup ID resolver function

api/server/middleware/accessResources/fileAccess.js

@@ -1,8 +1,7 @@
 const { logger } = require('@librechat/data-schemas');
 const { PermissionBits, hasPermissions, ResourceType } = require('librechat-data-provider');
 const { getEffectivePermissions } = require('~/server/services/PermissionService');
-const { getAgents } = require('~/models/Agent');
-const { getFiles } = require('~/models');
+const { getAgents, getFiles } = require('~/models');
 
 /**
  * Checks if user has access to a file through agent permissions

api/server/middleware/accessResources/fileAccess.spec.js

@@ -3,8 +3,7 @@ const { ResourceType, PrincipalType, PrincipalModel } = require('librechat-data-
 const { MongoMemoryServer } = require('mongodb-memory-server');
 const { fileAccess } = require('./fileAccess');
 const { User, Role, AclEntry } = require('~/db/models');
-const { createAgent } = require('~/models/Agent');
-const { createFile } = require('~/models');
+const { createAgent, createFile } = require('~/models');
 
 describe('fileAccess middleware', () => {
   let mongoServer;

api/server/middleware/assistants/validateAuthor.js

@@ -1,5 +1,5 @@
 const { SystemRoles } = require('librechat-data-provider');
-const { getAssistant } = require('~/models/Assistant');
+const { getAssistant } = require('~/models');
 
 /**
  * Checks if the assistant is supported or excluded

api/server/middleware/checkInviteUser.js

@@ -1,5 +1,8 @@
-const { getInvite } = require('~/models/inviteUser');
-const { deleteTokens } = require('~/models');
+const { getInvite: getInviteFn } = require('@librechat/api');
+const { createToken, findToken, deleteTokens } = require('~/models');
+
+const getInvite = (encodedToken, email) =>
+  getInviteFn(encodedToken, email, { createToken, findToken });
 
 async function checkInviteUser(req, res, next) {
   const token = req.body.token;

api/server/middleware/checkPeoplePickerAccess.js

@@ -1,6 +1,6 @@
 const { logger } = require('@librechat/data-schemas');
 const { PrincipalType, PermissionTypes, Permissions } = require('librechat-data-provider');
-const { getRoleByName } = require('~/models/Role');
+const { getRoleByName } = require('~/models');
 
 /**
  * Middleware to check if user has permission to access people picker functionality

api/server/middleware/checkPeoplePickerAccess.spec.js

@@ -1,9 +1,9 @@
 const { logger } = require('@librechat/data-schemas');
 const { PrincipalType, PermissionTypes, Permissions } = require('librechat-data-provider');
 const { checkPeoplePickerAccess } = require('./checkPeoplePickerAccess');
-const { getRoleByName } = require('~/models/Role');
+const { getRoleByName } = require('~/models');
 
-jest.mock('~/models/Role');
+jest.mock('~/models');
 jest.mock('@librechat/data-schemas', () => ({
   ...jest.requireActual('@librechat/data-schemas'),
   logger: {

api/server/middleware/checkSharePublicAccess.js

@@ -1,6 +1,6 @@
 const { logger } = require('@librechat/data-schemas');
 const { ResourceType, PermissionTypes, Permissions } = require('librechat-data-provider');
-const { getRoleByName } = require('~/models/Role');
+const { getRoleByName } = require('~/models');
 
 /**
  * Maps resource types to their corresponding permission types

api/server/middleware/checkSharePublicAccess.spec.js

@@ -1,8 +1,8 @@
 const { ResourceType, PermissionTypes, Permissions } = require('librechat-data-provider');
 const { checkSharePublicAccess } = require('./checkSharePublicAccess');
-const { getRoleByName } = require('~/models/Role');
+const { getRoleByName } = require('~/models');
 
-jest.mock('~/models/Role');
+jest.mock('~/models');
 
 describe('checkSharePublicAccess middleware', () => {
   let mockReq;

api/server/middleware/denyRequest.js

@@ -43,7 +43,11 @@ const denyRequest = async (req, res, errorMessage) => {
 
   if (shouldSaveMessage) {
     await saveMessage(
-      req,
+      {
+        userId: req?.user?.id,
+        isTemporary: req?.body?.isTemporary,
+        interfaceConfig: req?.config?.interfaceConfig,
+      },
       { ...userMessage, user: req.user.id },
       { context: `api/server/middleware/denyRequest.js - ${responseText}` },
     );

api/server/middleware/error.js

@@ -2,8 +2,7 @@ const crypto = require('crypto');
 const { logger } = require('@librechat/data-schemas');
 const { parseConvo } = require('librechat-data-provider');
 const { sendEvent, handleError, sanitizeMessageForTransmit } = require('@librechat/api');
-const { saveMessage, getMessages } = require('~/models/Message');
-const { getConvo } = require('~/models/Conversation');
+const { saveMessage, getMessages, getConvo } = require('~/models');
 
 /**
  * Processes an error with provided options, saves the error message and sends a corresponding SSE response
@@ -49,7 +48,11 @@ const sendError = async (req, res, options, callback) => {
 
   if (shouldSaveMessage) {
     await saveMessage(
-      req,
+      {
+        userId: req?.user?.id,
+        isTemporary: req?.body?.isTemporary,
+        interfaceConfig: req?.config?.interfaceConfig,
+      },
       { ...errorMessage, user },
       {
         context: 'api/server/utils/streamResponse.js - sendError',

api/server/middleware/roles/access.spec.js

@@ -2,7 +2,7 @@ const mongoose = require('mongoose');
 const { MongoMemoryServer } = require('mongodb-memory-server');
 const { checkAccess, generateCheckAccess } = require('@librechat/api');
 const { PermissionTypes, Permissions } = require('librechat-data-provider');
-const { getRoleByName } = require('~/models/Role');
+const { getRoleByName } = require('~/models');
 const { Role } = require('~/db/models');
 
 // Mock the logger from @librechat/data-schemas

api/server/middleware/validate/convoAccess.js

@@ -1,8 +1,8 @@
 const { isEnabled } = require('@librechat/api');
 const { Constants, ViolationTypes, Time } = require('librechat-data-provider');
-const { searchConversation } = require('~/models/Conversation');
 const denyRequest = require('~/server/middleware/denyRequest');
 const { logViolation, getLogStores } = require('~/cache');
+const { searchConversation } = require('~/models');
 
 const { USE_REDIS, CONVO_ACCESS_VIOLATION_SCORE: score = 0 } = process.env ?? {};