🔧 refactor: Add and use PrincipalType Enum

- Replaced string literals for principal types ('user', 'group', 'public') with the new PrincipalType enum across various models, services, and tests for improved type safety and consistency.
- Updated permission handling in multiple files to utilize the PrincipalType enum, enhancing maintainability and reducing potential errors.
- Ensured all relevant tests reflect these changes to maintain coverage and functionality.

api/server/routes/files/files.agents.test.js

@@ -2,9 +2,9 @@ const express = require('express');
 const request = require('supertest');
 const mongoose = require('mongoose');
 const { v4: uuidv4 } = require('uuid');
-const { MongoMemoryServer } = require('mongodb-memory-server');
 const { createMethods } = require('@librechat/data-schemas');
-const { AccessRoleIds, ResourceType } = require('librechat-data-provider');
+const { MongoMemoryServer } = require('mongodb-memory-server');
+const { AccessRoleIds, ResourceType, PrincipalType } = require('librechat-data-provider');
 const { createAgent } = require('~/models/Agent');
 const { createFile } = require('~/models/File');
 
@@ -185,7 +185,7 @@ describe('File Routes - Agent Files Endpoint', () => {
       // Grant EDIT permission to user on the agent using PermissionService
       const { grantPermission } = require('~/server/services/PermissionService');
       await grantPermission({
-        principalType: 'user',
+        principalType: PrincipalType.USER,
         principalId: otherUserId,
         resourceType: ResourceType.AGENT,
         resourceId: agent._id,
@@ -240,7 +240,7 @@ describe('File Routes - Agent Files Endpoint', () => {
       // Grant only VIEW permission to user on the agent
       const { grantPermission } = require('~/server/services/PermissionService');
       await grantPermission({
-        principalType: 'user',
+        principalType: PrincipalType.USER,
         principalId: otherUserId,
         resourceType: ResourceType.AGENT,
         resourceId: agent._id,

api/server/routes/files/files.test.js

@@ -4,7 +4,7 @@ const mongoose = require('mongoose');
 const { v4: uuidv4 } = require('uuid');
 const { createMethods } = require('@librechat/data-schemas');
 const { MongoMemoryServer } = require('mongodb-memory-server');
-const { AccessRoleIds, ResourceType } = require('librechat-data-provider');
+const { AccessRoleIds, ResourceType, PrincipalType } = require('librechat-data-provider');
 const { createAgent } = require('~/models/Agent');
 const { createFile } = require('~/models/File');
 
@@ -227,7 +227,7 @@ describe('File Routes - Delete with Agent Access', () => {
       // Grant EDIT permission to user on the agent
       const { grantPermission } = require('~/server/services/PermissionService');
       await grantPermission({
-        principalType: 'user',
+        principalType: PrincipalType.USER,
         principalId: otherUserId,
         resourceType: ResourceType.AGENT,
         resourceId: agent._id,
@@ -281,7 +281,7 @@ describe('File Routes - Delete with Agent Access', () => {
       // Grant EDIT permission to user on the agent
       const { grantPermission } = require('~/server/services/PermissionService');
       await grantPermission({
-        principalType: 'user',
+        principalType: PrincipalType.USER,
         principalId: otherUserId,
         resourceType: ResourceType.AGENT,
         resourceId: agent._id,
@@ -347,7 +347,7 @@ describe('File Routes - Delete with Agent Access', () => {
       // Grant EDIT permission to user on the agent
       const { grantPermission } = require('~/server/services/PermissionService');
       await grantPermission({
-        principalType: 'user',
+        principalType: PrincipalType.USER,
         principalId: otherUserId,
         resourceType: ResourceType.AGENT,
         resourceId: agent._id,
@@ -390,7 +390,7 @@ describe('File Routes - Delete with Agent Access', () => {
       // Grant only VIEW permission to user on the agent
       const { grantPermission } = require('~/server/services/PermissionService');
       await grantPermission({
-        principalType: 'user',
+        principalType: PrincipalType.USER,
         principalId: otherUserId,
         resourceType: ResourceType.AGENT,
         resourceId: agent._id,

api/server/routes/prompts.js

@@ -6,8 +6,9 @@ const {
   SystemRoles,
   ResourceType,
   AccessRoleIds,
-  PermissionTypes,
+  PrincipalType,
   PermissionBits,
+  PermissionTypes,
 } = require('librechat-data-provider');
 const {
   makePromptProduction,
@@ -189,7 +190,7 @@ const createNewPromptGroup = async (req, res) => {
     if (result.prompt && result.prompt._id && result.prompt.groupId) {
       try {
         await grantPermission({
-          principalType: 'user',
+          principalType: PrincipalType.USER,
           principalId: req.user.id,
           resourceType: ResourceType.PROMPTGROUP,
           resourceId: result.prompt.groupId,

api/server/routes/prompts.test.js

@@ -7,6 +7,7 @@ const {
   SystemRoles,
   ResourceType,
   AccessRoleIds,
+  PrincipalType,
   PermissionBits,
 } = require('librechat-data-provider');
 
@@ -223,7 +224,7 @@ describe('Prompt Routes - ACL Permissions', () => {
       const aclEntry = await AclEntry.findOne({
         resourceType: ResourceType.PROMPTGROUP,
         resourceId: response.body.prompt.groupId,
-        principalType: 'user',
+        principalType: PrincipalType.USER,
         principalId: testUsers.owner._id,
       });
 
@@ -253,7 +254,7 @@ describe('Prompt Routes - ACL Permissions', () => {
       const aclEntry = await AclEntry.findOne({
         resourceType: ResourceType.PROMPTGROUP,
         resourceId: response.body.group._id,
-        principalType: 'user',
+        principalType: PrincipalType.USER,
         principalId: testUsers.owner._id,
       });
 
@@ -294,7 +295,7 @@ describe('Prompt Routes - ACL Permissions', () => {
     it('should retrieve prompt when user has view permissions', async () => {
       // Grant view permissions on the promptGroup
       await grantPermission({
-        principalType: 'user',
+        principalType: PrincipalType.USER,
         principalId: testUsers.owner._id,
         resourceType: ResourceType.PROMPTGROUP,
         resourceId: testGroup._id,
@@ -379,7 +380,7 @@ describe('Prompt Routes - ACL Permissions', () => {
 
       // Grant owner permissions on the promptGroup
       await grantPermission({
-        principalType: 'user',
+        principalType: PrincipalType.USER,
         principalId: testUsers.owner._id,
         resourceType: ResourceType.PROMPTGROUP,
         resourceId: testGroup._id,
@@ -426,7 +427,7 @@ describe('Prompt Routes - ACL Permissions', () => {
 
       // Grant only viewer permissions to viewer user on the promptGroup
       await grantPermission({
-        principalType: 'user',
+        principalType: PrincipalType.USER,
         principalId: testUsers.viewer._id,
         resourceType: ResourceType.PROMPTGROUP,
         resourceId: testGroup._id,
@@ -493,7 +494,7 @@ describe('Prompt Routes - ACL Permissions', () => {
     it('should make prompt production when user has edit permissions', async () => {
       // Grant edit permissions on the promptGroup
       await grantPermission({
-        principalType: 'user',
+        principalType: PrincipalType.USER,
         principalId: testUsers.owner._id,
         resourceType: ResourceType.PROMPTGROUP,
         resourceId: testGroup._id,
@@ -531,7 +532,7 @@ describe('Prompt Routes - ACL Permissions', () => {
     it('should deny making production when user lacks edit permissions', async () => {
       // Grant only view permissions to viewer on the promptGroup
       await grantPermission({
-        principalType: 'user',
+        principalType: PrincipalType.USER,
         principalId: testUsers.viewer._id,
         resourceType: ResourceType.PROMPTGROUP,
         resourceId: testGroup._id,
@@ -588,7 +589,7 @@ describe('Prompt Routes - ACL Permissions', () => {
 
       // Grant public viewer access on the promptGroup
       await grantPermission({
-        principalType: 'public',
+        principalType: PrincipalType.PUBLIC,
         principalId: null,
         resourceType: ResourceType.PROMPTGROUP,
         resourceId: publicGroup._id,