LibreChat/packages/data-schemas
Ruben Talstra 4cbab86b45
📈 feat: Chat rating for feedback (#5878)
* feat: working started for feedback implementation.

TODO:
- needs some refactoring.
- needs some UI animations.

* feat: working rate functionality

* feat: works now as well to reader the already rated responses from the server.

* feat: added the option to give feedback in text (optional)

* feat: added Dismiss option `x` to the `FeedbackTagOptions`

*  feat: Add rating and ratingContent fields to message schema

* 🔧 chore: Bump version to 0.0.3 in package.json

*  feat: Enhance feedback localization and update UI elements

* 🚀 feat: Implement feedback tagging system with thumbs up/down options

* 🚀 feat: Add data-provider package to unused i18n keys detection

* 🎨 style: update HoverButtons' style

* 🎨 style: Update HoverButtons and Fork components for improved styling and visibility

* 🔧 feat: Implement feedback system with rating and content options

* 🔧 feat: Enhance feedback handling with improved rating toggle and tag options

* 🔧 feat: Integrate toast notifications for feedback submission and clean up unused state

* 🔧 feat: Remove unused feedback tag options from translation file

*  refactor: clean up Feedback component and improve HoverButtons structure

*  refactor: remove unused settings switches for auto scroll, hide side panel, and user message markdown

* refactor: reorganize import order

*  refactor: enhance HoverButtons and Fork components with improved styles and animations

*  refactor: update feedback response phrases for improved user engagement

*  refactor: add CheckboxOption component and streamline fork options rendering

* Refactor feedback components and logic

- Consolidated feedback handling into a single Feedback component, removing FeedbackButtons and FeedbackTagOptions.
- Introduced new feedback tagging system with detailed tags for both thumbs up and thumbs down ratings.
- Updated feedback schema to include new tags and improved type definitions.
- Enhanced user interface for feedback collection, including a dialog for additional comments.
- Removed obsolete files and adjusted imports accordingly.
- Updated translations for new feedback tags and placeholders.

*  refactor: update feedback handling by replacing rating fields with feedback in message updates

* fix: add missing validateMessageReq middleware to feedback route and refactor feedback system

* 🗑️ chore: Remove redundant fork option explanations from translation file

* 🔧 refactor: Remove unused dependency from feedback callback

* 🔧 refactor: Simplify message update response structure and improve error logging

* Chore: removed unused tests.

---------

Co-authored-by: Marco Beretta <81851188+berry-13@users.noreply.github.com>
2025-05-30 12:16:34 -04:00
..
src 📈 feat: Chat rating for feedback (#5878) 2025-05-30 12:16:34 -04:00
.gitignore 📦 refactor: Move DB Models to @librechat/data-schemas (#6210) 2025-03-07 11:55:44 -05:00
babel.config.cjs 📦 refactor: Move DB Models to @librechat/data-schemas (#6210) 2025-03-07 11:55:44 -05:00
jest.config.mjs 📦 refactor: Move DB Models to @librechat/data-schemas (#6210) 2025-03-07 11:55:44 -05:00
LICENSE 🔏 fix: Enhance Two-Factor Authentication (#6247) 2025-03-08 15:28:27 -05:00
package.json v0.7.8 (#7287) 2025-05-08 13:28:40 -04:00
README.md 🔏 fix: Enhance Two-Factor Authentication (#6247) 2025-03-08 15:28:27 -05:00
rollup.config.js 🚀 feat: Refactor schema exports and update package version to 0.0.4 (#6455) 2025-03-21 08:20:23 -04:00
tsconfig.json 🚀 feat: Refactor schema exports and update package version to 0.0.4 (#6455) 2025-03-21 08:20:23 -04:00
tsconfig.spec.json 📦 refactor: Move DB Models to @librechat/data-schemas (#6210) 2025-03-07 11:55:44 -05:00

@librechat/data-schemas

Mongoose schemas and models for LibreChat. This package provides a comprehensive collection of Mongoose schemas used across the LibreChat project, enabling robust data modeling and validation for various entities such as actions, agents, messages, users, and more.

Features

  • Modular Schemas: Includes schemas for actions, agents, assistants, balance, banners, categories, conversation tags, conversations, files, keys, messages, plugin authentication, presets, projects, prompts, prompt groups, roles, sessions, shared links, tokens, tool calls, transactions, and users.
  • TypeScript Support: Provides TypeScript definitions for type-safe development.
  • Ready for Mongoose Integration: Easily integrate with Mongoose to create models and interact with your MongoDB database.
  • Flexible & Extensible: Designed to support the evolving needs of LibreChat while being adaptable to other projects.

Installation

Install the package via npm or yarn:

npm install @librechat/data-schemas

Or with yarn:

yarn add @librechat/data-schemas

Usage

After installation, you can import and use the schemas in your project. For example, to create a Mongoose model for a user:

import mongoose from 'mongoose';
import { userSchema } from '@librechat/data-schemas';

const UserModel = mongoose.model('User', userSchema);

// Now you can use UserModel to create, read, update, and delete user documents.

You can also import other schemas as needed:

import { actionSchema, agentSchema, messageSchema } from '@librechat/data-schemas';

Each schema is designed to integrate seamlessly with Mongoose and provides indexes, timestamps, and validations tailored for LibreChats use cases.

Development

This package uses Rollup and TypeScript for building and bundling.

Available Scripts

  • Build:
    Cleans the dist directory and builds the package.

    npm run build
    
  • Build Watch:
    Rebuilds automatically on file changes.

    npm run build:watch
    
  • Test:
    Runs tests with coverage in watch mode.

    npm run test
    
  • Test (CI):
    Runs tests with coverage for CI environments.

    npm run test:ci
    
  • Verify:
    Runs tests in CI mode to verify code integrity.

    npm run verify
    
  • Clean:
    Removes the dist directory.

    npm run clean
    

For those using Bun, equivalent scripts are available:

  • Bun Clean: bun run b:clean
  • Bun Build: bun run b:build

Repository & Issues

The source code is maintained on GitHub.

License

This project is licensed under the MIT License.

Contributing

Contributions to improve and expand the data schemas are welcome. If you have suggestions, improvements, or bug fixes, please open an issue or submit a pull request on the GitHub repository.

For more detailed documentation on each schema and model, please refer to the source code or visit the LibreChat website.