LibreChat/client/src/utils/collection.ts

105 lines
3.2 KiB
TypeScript
Raw Normal View History

🚀 feat: Shared Links (#2772) * ✨ feat(types): add necessary types for shared link feature * ✨ feat: add shared links functions to data service Added functions for retrieving, creating, updating, and deleting shared links and shared messages. * ✨ feat: Add useGetSharedMessages hook to fetch shared messages by shareId Adds a new hook `useGetSharedMessages` which fetches shared messages based on the provided shareId. * ✨ feat: Add share schema and data access functions to API models * ✨ feat: Add share endpoint to API The GET /api/share/${shareId} is exposed to the public, so authentication is not required. Other paths require authentication. * ♻️ refactor(utils): generalize react-query cache manipulation functions Introduces generic functions for manipulating react-query cache entries, marking a refinement in how query cache data is managed. It aims to enhance the flexibility and reusability of the cache interaction patterns within our application. - Replaced specific index names with more generic terms in queries.ts, enhancing consistency across data handling functions. - Introduced new utility functions in collection.ts for adding, updating, and deleting data entries in an InfiniteData<TCollection>. These utility functions (`addData`, `updateData`, `deleteData`, `findPage`) are designed to be re-usable across different data types and collections. - Adapted existing conversation utility functions in convos.ts to leverage these new generic utilities. * ✨ feat(shared-link): add functions to manipulate shared link cache list implemented new utility functions to handle additions, updates, and deletions in the shared link cache list. * ✨ feat: Add mutations and queries for shared links * ✨ feat(shared-link): add `Share` button to conversation list - Added a share button in each conversation in the conversation list. - Implemented functionality where clicking the share button triggers a POST request to the API. - The API checks if a share link was already created for the conversation today; if so, it returns the existing link. - If no link was created for today, the API will create a new share link and return it. - Each click on the share button results in a new API request, following the specification similar to ChatGPT's share link feature. * ♻️ refactor(hooks): generalize useNavScrolling for broader use - Modified `useNavScrolling` to accept a generic type parameter `TData`, allowing it to be used with different data structures besides `ConversationListResponse`. - Updated instances in `Nav.tsx` and `ArchivedChatsTable.tsx` to explicitly specify `ConversationListResponse` as the type argument when invoking `useNavScrolling`. * ✨ feat(settings): add shared links listing table with delete functionality in settings - Integrated a delete button for each shared link in the table, allowing users to remove links as needed. * ♻️ refactor(components): separate `EndpointIcon` from `Icon` component for standalone use * ♻️ refactor: update useGetSharedMessages to return TSharedLink - Modified the useGetSharedMessages hook to return not only a list of TMessage but also the TSharedLink itself. - This change was necessary to support displaying the title and date in the Shared Message UI, which requires data from TSharedLink. * ✨ feat(shared link): add UI for displaying shared conversations without authentication - Implemented a new UI component to display shared conversations, designed to be accessible without requiring authentication. - Reused components from the authenticated Messages module where possible. Copied and adapted components that could not be directly reused to fit the non-authenticated context. * 🔧 chore: Add translations Translate labels only. Messages remain in English as they are possibly subject to change. * ♻️ refactor: add icon and tooltip props to EditMenuButton component * moved icon and popover to arguments so that EditMenuButton can be reused. * modified so that when a ShareButton is closed, the parent DropdownMenu is also closed. * ♻️irefactor: added DropdownMenu for Export and Share * ♻️ refactor: renamed component names more intuitive * More accurate naming of the dropdown menu. * When the export button is closed, the parent dropdown menu is also closed. * 🌍 chore: updated translations * 🐞 Fix: OpenID Profile Image Download (#2757) * Add fetch requirement Fixes - error: [openidStrategy] downloadImage: Error downloading image at URL "https://graph.microsoft.com/v1.0/me/photo/$value": TypeError: response.buffer is not a function * Update openidStrategy.js --------- Co-authored-by: Danny Avila <danacordially@gmail.com> * 🚑 fix(export): Issue exporting Conversation with Assistants (#2769) * 🚑 fix(export): use content as text if content is present in the message If the endpoint is assistants, the text of the message goes into content, not message.text. * refactor(ExportModel): TypeScript, remove unused code --------- Co-authored-by: Yuichi Ohneda <ohneda@gmail.com> * 📤style: export button icon (#2752) * refactor(ShareDialog): logic and styling * refactor(ExportAndShareMenu): imports order and icon update * chore: imports * chore: imports/render logic * feat: message branching * refactor: add optional config to useGetStartupConfig * refactor: disable endpoints query * chore: fix search view styling gradient in light mode * style: ShareView gradient styling * refactor(Share): use select queries * style: shared link table buttons * localization and dark text styling * style: fix clipboard button layout shift app-wide and add localization for copy code * support assistants message content in shared links, add useCopyToClipboard, add copy buttons to Search Messages and Shared Link Messages * add localizations * comparisons --------- Co-authored-by: Yuichi Ohneda <ohneda@gmail.com> Co-authored-by: bsu3338 <bsu3338@users.noreply.github.com> Co-authored-by: Fuegovic <32828263+fuegovic@users.noreply.github.com>
2024-05-17 18:13:32 -04:00
import { InfiniteData } from '@tanstack/react-query';
export const addData = <TCollection, TData>(
data: InfiniteData<TCollection>,
collectionName: string,
newData: TData,
findIndex: (page: TCollection) => number,
) => {
const dataJson = JSON.parse(JSON.stringify(data)) as InfiniteData<TCollection>;
const { pageIndex, index } = findPage<TCollection>(data, findIndex);
if (pageIndex !== -1 && index !== -1) {
return updateData(data, collectionName, newData, findIndex);
}
dataJson.pages[0][collectionName].unshift({
...newData,
updatedAt: new Date().toISOString(),
});
return dataJson;
};
export function findPage<TData>(data: InfiniteData<TData>, findIndex: (page: TData) => number) {
for (let pageIndex = 0; pageIndex < data.pages.length; pageIndex++) {
const page = data.pages[pageIndex];
const index = findIndex(page);
if (index !== -1) {
return { pageIndex, index };
}
}
return { pageIndex: -1, index: -1 }; // Not found
}
export const updateData = <TCollection, TData>(
data: InfiniteData<TCollection>,
collectionName: string,
updatedData: TData,
findIndex: (page: TCollection) => number,
) => {
const newData = JSON.parse(JSON.stringify(data)) as InfiniteData<TCollection>;
const { pageIndex, index } = findPage<TCollection>(data, findIndex);
if (pageIndex !== -1 && index !== -1) {
// Remove the data from its current position
newData.pages[pageIndex][collectionName].splice(index, 1);
// Add the updated data to the top of the first page
newData.pages[0][collectionName].unshift({
...updatedData,
updatedAt: new Date().toISOString(),
});
}
return newData;
};
export const deleteData = <TCollection, TData>(
data: TData,
collectionName: string,
findIndex: (page: TCollection) => number,
): TData => {
const newData = JSON.parse(JSON.stringify(data));
const { pageIndex, index } = findPage<TCollection>(newData, findIndex);
if (pageIndex !== -1 && index !== -1) {
// Delete the data from its current page
newData.pages[pageIndex][collectionName].splice(index, 1);
}
return newData;
};
/**
* Normalize the data so that the number of data on each page is within pageSize
*/
export const normalizeData = <TCollection, TData>(
data: InfiniteData<TCollection>,
collectionName: string,
pageSize: number,
): InfiniteData<TCollection> => {
const infiniteData = JSON.parse(JSON.stringify(data)) as InfiniteData<TCollection>;
const pageCount = infiniteData.pages.length;
if (pageCount === 0) {
return infiniteData;
}
const pageParams = infiniteData.pageParams;
// Combine all conversations of all pages into one array
const collection = infiniteData.pages.flatMap((page) => page[collectionName]);
if (collection.length === 0) {
return infiniteData;
}
// Create the restructured pages
const restructuredPages = Array.from({ length: pageCount }, (_, i) => ({
...infiniteData.pages[i],
[collectionName]: collection.slice(i * pageSize, (i + 1) * pageSize),
})).filter((page) => page[collectionName].length > 0); // Remove empty pages
return {
pageParams: pageParams.slice(0, restructuredPages.length),
pages: restructuredPages,
};
};