mirror of
https://github.com/danny-avila/LibreChat.git
synced 2026-01-24 19:26:14 +01:00
WIP: first pass, factory models and methods
This commit is contained in:
parent
a2a3f5c044
commit
c201d54cac
6 changed files with 67 additions and 105 deletions
|
|
@ -1,97 +0,0 @@
|
|||
# Methods
|
||||
|
||||
This directory contains pure functions that replace the static methods from the schema files. This refactoring improves testability, type safety, and code modularity.
|
||||
|
||||
## Structure
|
||||
|
||||
- `userMethods.ts` - Functions for user operations
|
||||
- `sessionMethods.ts` - Functions for session operations
|
||||
- `tokenMethods.ts` - Functions for token operations
|
||||
- `index.ts` - Exports all methods for convenient importing
|
||||
|
||||
## Migration from Static Methods
|
||||
|
||||
Instead of calling static methods on models:
|
||||
|
||||
```typescript
|
||||
// OLD: Using static methods
|
||||
const user = await UserModel.findUser({ email: 'test@example.com' });
|
||||
const result = await UserModel.deleteUserById(userId);
|
||||
```
|
||||
|
||||
Use the pure functions with the model as the first parameter:
|
||||
|
||||
```typescript
|
||||
// NEW: Using pure functions
|
||||
import { findUser, deleteUserById } from '~/methods';
|
||||
import UserModel from '~/schema/user';
|
||||
|
||||
const user = await findUser(UserModel, { email: 'test@example.com' });
|
||||
const result = await deleteUserById(UserModel, userId);
|
||||
```
|
||||
|
||||
## Benefits
|
||||
|
||||
1. **Pure Functions**: Methods are now side-effect free and testable
|
||||
2. **Better Types**: Proper TypeScript typing throughout
|
||||
3. **Dependency Injection**: Models are passed as parameters
|
||||
4. **Modular**: Functions can be imported individually or as a group
|
||||
5. **No Magic**: Clear explicit dependencies
|
||||
|
||||
## Usage Examples
|
||||
|
||||
### User Methods
|
||||
|
||||
```typescript
|
||||
import { createUser, findUser, updateUser } from '~/methods';
|
||||
import UserModel from '~/schema/user';
|
||||
|
||||
// Create a user
|
||||
const newUser = await createUser(
|
||||
UserModel,
|
||||
{ email: 'user@example.com', name: 'John' },
|
||||
{ enabled: true, startBalance: 100 }
|
||||
);
|
||||
|
||||
// Find a user
|
||||
const user = await findUser(UserModel, { email: 'user@example.com' });
|
||||
|
||||
// Update a user
|
||||
const updated = await updateUser(UserModel, userId, { name: 'Jane' });
|
||||
```
|
||||
|
||||
### Session Methods
|
||||
|
||||
```typescript
|
||||
import { createSession, findSession, deleteSession } from '~/methods';
|
||||
import SessionModel from '~/schema/session';
|
||||
|
||||
// Create session
|
||||
const { session, refreshToken } = await createSession(SessionModel, userId);
|
||||
|
||||
// Find session
|
||||
const foundSession = await findSession(SessionModel, { refreshToken });
|
||||
|
||||
// Delete session
|
||||
await deleteSession(SessionModel, { sessionId });
|
||||
```
|
||||
|
||||
### Token Methods
|
||||
|
||||
```typescript
|
||||
import { createToken, findToken, deleteTokens } from '~/methods';
|
||||
import TokenModel from '~/schema/token';
|
||||
|
||||
// Create token
|
||||
const token = await createToken(TokenModel, {
|
||||
userId,
|
||||
token: 'abc123',
|
||||
expiresIn: 3600
|
||||
});
|
||||
|
||||
// Find token
|
||||
const foundToken = await findToken(TokenModel, { token: 'abc123' });
|
||||
|
||||
// Delete tokens
|
||||
await deleteTokens(TokenModel, { userId });
|
||||
```
|
||||
50
packages/data-schemas/src/methods/role.ts
Normal file
50
packages/data-schemas/src/methods/role.ts
Normal file
|
|
@ -0,0 +1,50 @@
|
|||
import { roleDefaults, SystemRoles } from 'librechat-data-provider';
|
||||
|
||||
// Factory function that takes mongoose instance and returns the methods
|
||||
export function createRoleMethods(mongoose: typeof import('mongoose')) {
|
||||
/**
|
||||
* Initialize default roles in the system.
|
||||
* Creates the default roles (ADMIN, USER) if they don't exist in the database.
|
||||
* Updates existing roles with new permission types if they're missing.
|
||||
*/
|
||||
async function initializeRoles() {
|
||||
const Role = mongoose.models.Role;
|
||||
|
||||
for (const roleName of [SystemRoles.ADMIN, SystemRoles.USER]) {
|
||||
let role = await Role.findOne({ name: roleName });
|
||||
const defaultPerms = roleDefaults[roleName].permissions;
|
||||
|
||||
if (!role) {
|
||||
// Create new role if it doesn't exist.
|
||||
role = new Role(roleDefaults[roleName]);
|
||||
} else {
|
||||
// Ensure role.permissions is defined.
|
||||
role.permissions = role.permissions || {};
|
||||
// For each permission type in defaults, add it if missing.
|
||||
for (const permType of Object.keys(defaultPerms)) {
|
||||
if (role.permissions[permType] == null) {
|
||||
role.permissions[permType] = defaultPerms[permType as keyof typeof defaultPerms];
|
||||
}
|
||||
}
|
||||
}
|
||||
await role.save();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* List all roles in the system (for testing purposes)
|
||||
* Returns an array of all roles with their names and permissions
|
||||
*/
|
||||
async function listRoles() {
|
||||
const Role = mongoose.models.Role;
|
||||
return await Role.find({}).select('name permissions').lean();
|
||||
}
|
||||
|
||||
// Return all methods you want to expose
|
||||
return {
|
||||
listRoles,
|
||||
initializeRoles,
|
||||
};
|
||||
}
|
||||
|
||||
export type RoleMethods = ReturnType<typeof createRoleMethods>;
|
||||
Loading…
Add table
Add a link
Reference in a new issue