Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new role permission to disable conversation deletion #4197

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions api/models/Role.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ const {
promptPermissionsSchema,
bookmarkPermissionsSchema,
multiConvoPermissionsSchema,
deleteConvoPermissionsSchema,
} = require('librechat-data-provider');
const getLogStores = require('~/cache/getLogStores');
const Role = require('~/models/schema/roleSchema');
Expand Down Expand Up @@ -77,6 +78,7 @@ const permissionSchemas = {
[PermissionTypes.PROMPTS]: promptPermissionsSchema,
[PermissionTypes.BOOKMARKS]: bookmarkPermissionsSchema,
[PermissionTypes.MULTI_CONVO]: multiConvoPermissionsSchema,
[PermissionTypes.DELETE_CONVO]: deleteConvoPermissionsSchema,
};

/**
Expand Down
6 changes: 6 additions & 0 deletions api/models/schema/roleSchema.js
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,12 @@ const roleSchema = new mongoose.Schema({
default: true,
},
},
[PermissionTypes.DELETE_CONVO]: {
[Permissions.USE]: {
type: Boolean,
default: true,
},
},
});

const Role = mongoose.model('Role', roleSchema);
Expand Down
8 changes: 5 additions & 3 deletions api/server/routes/convos.js
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
const multer = require('multer');
const express = require('express');
const { CacheKeys } = require('librechat-data-provider');
const { CacheKeys, PermissionTypes, Permissions } = require('librechat-data-provider');
const { initializeClient } = require('~/server/services/Endpoints/assistants');
const { getConvosByPage, deleteConvos, getConvo, saveConvo } = require('~/models/Conversation');
const { storage, importFileFilter } = require('~/server/routes/files/multer');
const requireJwtAuth = require('~/server/middleware/requireJwtAuth');
const { forkConversation } = require('~/server/utils/import/fork');
const { importConversations } = require('~/server/utils/import');
const { createImportLimiters } = require('~/server/middleware');
const { createImportLimiters, generateCheckAccess } = require('~/server/middleware');
const getLogStores = require('~/cache/getLogStores');
const { sleep } = require('~/server/utils');
const { logger } = require('~/config');
Expand Down Expand Up @@ -72,7 +72,9 @@ router.post('/gen_title', async (req, res) => {
}
});

router.post('/clear', async (req, res) => {
const checkDeleteConvoAccess = generateCheckAccess(PermissionTypes.DELETE_CONVO, [Permissions.USE]);

router.post('/clear', checkDeleteConvoAccess, async (req, res) => {
let filter = {};
const { conversationId, source, thread_id } = req.body.arg;
if (conversationId) {
Expand Down
3 changes: 3 additions & 0 deletions api/server/services/start/interface.js
Original file line number Diff line number Diff line change
Expand Up @@ -32,17 +32,20 @@ async function loadDefaultInterface(config, configDefaults, roleName = SystemRol
bookmarks: interfaceConfig?.bookmarks ?? defaults.bookmarks,
prompts: interfaceConfig?.prompts ?? defaults.prompts,
multiConvo: interfaceConfig?.multiConvo ?? defaults.multiConvo,
deleteConvo: interfaceConfig?.deleteConvo ?? defaults.deleteConvo,
});

await updateAccessPermissions(roleName, {
[PermissionTypes.PROMPTS]: { [Permissions.USE]: loadedInterface.prompts },
[PermissionTypes.BOOKMARKS]: { [Permissions.USE]: loadedInterface.bookmarks },
[PermissionTypes.MULTI_CONVO]: { [Permissions.USE]: loadedInterface.multiConvo },
[PermissionTypes.DELETE_CONVO]: { [Permissions.USE]: loadedInterface.deleteConvo },
});
await updateAccessPermissions(SystemRoles.ADMIN, {
[PermissionTypes.PROMPTS]: { [Permissions.USE]: loadedInterface.prompts },
[PermissionTypes.BOOKMARKS]: { [Permissions.USE]: loadedInterface.bookmarks },
[PermissionTypes.MULTI_CONVO]: { [Permissions.USE]: loadedInterface.multiConvo },
[PermissionTypes.DELETE_CONVO]: { [Permissions.USE]: loadedInterface.deleteConvo },
});

let i = 0;
Expand Down
22 changes: 17 additions & 5 deletions client/src/components/Conversations/Convo.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import { useToastContext } from '~/Providers';
import { ConvoOptions } from './ConvoOptions';
import { cn } from '~/utils';
import store from '~/store';
import { useLocalize } from '~/hooks'
import { useLocalize } from '~/hooks';

type KeyEvent = KeyboardEvent<HTMLInputElement>;

Expand Down Expand Up @@ -151,11 +151,23 @@ export default function Conversation({
aria-label={`${localize('com_ui_rename')} ${localize('com_ui_chat')}`}
/>
<div className="flex gap-1">
<button onClick={cancelRename} aria-label={`${localize('com_ui_cancel')} ${localize('com_ui_rename')}`}>
<X aria-hidden={true} className="transition-colors h-4 w-4 duration-200 ease-in-out hover:opacity-70" />
<button
onClick={cancelRename}
aria-label={`${localize('com_ui_cancel')} ${localize('com_ui_rename')}`}
>
<X
aria-hidden={true}
className="h-4 w-4 transition-colors duration-200 ease-in-out hover:opacity-70"
/>
</button>
<button onClick={onRename} aria-label={`${localize('com_ui_submit')} ${localize('com_ui_rename')}`}>
<Check aria-hidden={true} className="transition-colors h-4 w-4 duration-200 ease-in-out hover:opacity-70" />
<button
onClick={onRename}
aria-label={`${localize('com_ui_submit')} ${localize('com_ui_rename')}`}
>
<Check
aria-hidden={true}
className="h-4 w-4 transition-colors duration-200 ease-in-out hover:opacity-70"
/>
</button>
</div>
</div>
Expand Down
17 changes: 13 additions & 4 deletions client/src/components/Conversations/ConvoOptions/ConvoOptions.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@ import { useState, useId } from 'react';
import * as Ariakit from '@ariakit/react';
import { Ellipsis, Share2, Archive, Pen, Trash } from 'lucide-react';
import { useGetStartupConfig } from 'librechat-data-provider/react-query';
import { useLocalize, useArchiveHandler } from '~/hooks';
import { useLocalize, useArchiveHandler, useHasAccess } from '~/hooks';
import { DropdownPopup } from '~/components/ui';
import DeleteButton from './DeleteButton';
import ShareButton from './ShareButton';
import { cn } from '~/utils';
import { PermissionTypes, Permissions } from 'librechat-data-provider';

export default function ConvoOptions({
conversation,
Expand All @@ -33,6 +34,11 @@ export default function ConvoOptions({
setShowDeleteDialog(true);
};

const hasAccessToDeleteConvo = useHasAccess({
permissionType: PermissionTypes.DELETE_CONVO,
permission: Permissions.USE,
});

const dropdownItems = [
{
label: localize('com_ui_rename'),
Expand All @@ -50,12 +56,15 @@ export default function ConvoOptions({
onClick: archiveHandler,
icon: <Archive className="icon-md mr-2 text-text-secondary" />,
},
{
];

if (hasAccessToDeleteConvo) {
dropdownItems.push({
label: localize('com_ui_delete'),
onClick: deleteHandler,
icon: <Trash className="icon-md mr-2 text-text-secondary" />,
},
];
});
}

const menuId = useId();

Expand Down
2 changes: 2 additions & 0 deletions packages/data-provider/src/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -465,6 +465,7 @@ export const configSchema = z.object({
parameters: z.boolean().optional(),
sidePanel: z.boolean().optional(),
multiConvo: z.boolean().optional(),
deleteConvo: z.boolean().optional(),
bookmarks: z.boolean().optional(),
presets: z.boolean().optional(),
prompts: z.boolean().optional(),
Expand All @@ -476,6 +477,7 @@ export const configSchema = z.object({
sidePanel: true,
presets: true,
multiConvo: true,
deleteConvo: true,
bookmarks: true,
prompts: true,
}),
Expand Down
15 changes: 15 additions & 0 deletions packages/data-provider/src/roles.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ export enum PermissionTypes {
* Type for Multi-Conversation Permissions
*/
MULTI_CONVO = 'MULTI_CONVO',
/**
* Type for Delete Conversation Permissions
*/
DELETE_CONVO = 'DELETE_CONVO',
}

/**
Expand Down Expand Up @@ -68,12 +72,17 @@ export const multiConvoPermissionsSchema = z.object({
[Permissions.USE]: z.boolean().default(false),
});

export const deleteConvoPermissionsSchema = z.object({
[Permissions.USE]: z.boolean().default(false),
});

export const roleSchema = z.object({
name: z.string(),
[PermissionTypes.PROMPTS]: promptPermissionsSchema,
[PermissionTypes.BOOKMARKS]: bookmarkPermissionsSchema,
[PermissionTypes.AGENTS]: agentPermissionsSchema,
[PermissionTypes.MULTI_CONVO]: multiConvoPermissionsSchema,
[PermissionTypes.DELETE_CONVO]: deleteConvoPermissionsSchema,
});

export type TRole = z.infer<typeof roleSchema>;
Expand Down Expand Up @@ -103,13 +112,17 @@ const defaultRolesSchema = z.object({
[PermissionTypes.MULTI_CONVO]: multiConvoPermissionsSchema.extend({
[Permissions.USE]: z.boolean().default(true),
}),
[PermissionTypes.DELETE_CONVO]: deleteConvoPermissionsSchema.extend({
[Permissions.USE]: z.boolean().default(true),
}),
}),
[SystemRoles.USER]: roleSchema.extend({
name: z.literal(SystemRoles.USER),
[PermissionTypes.PROMPTS]: promptPermissionsSchema,
[PermissionTypes.BOOKMARKS]: bookmarkPermissionsSchema,
[PermissionTypes.AGENTS]: agentPermissionsSchema,
[PermissionTypes.MULTI_CONVO]: multiConvoPermissionsSchema,
[PermissionTypes.DELETE_CONVO]: multiConvoPermissionsSchema,
}),
});

Expand All @@ -120,12 +133,14 @@ export const roleDefaults = defaultRolesSchema.parse({
[PermissionTypes.BOOKMARKS]: {},
[PermissionTypes.AGENTS]: {},
[PermissionTypes.MULTI_CONVO]: {},
[PermissionTypes.DELETE_CONVO]: {},
},
[SystemRoles.USER]: {
name: SystemRoles.USER,
[PermissionTypes.PROMPTS]: {},
[PermissionTypes.BOOKMARKS]: {},
[PermissionTypes.AGENTS]: {},
[PermissionTypes.MULTI_CONVO]: {},
[PermissionTypes.DELETE_CONVO]: {},
},
});
1 change: 1 addition & 0 deletions packages/data-provider/src/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -319,6 +319,7 @@ export type TInterfaceConfig = {
sidePanel: boolean;
presets: boolean;
multiConvo: boolean;
deleteConvo: boolean;
bookmarks: boolean;
prompts: boolean;
};
Expand Down