Skip to content

Commit

Permalink
🌟 feat: Add LICENSE file and update package version to 0.0.2 with MIT…
Browse files Browse the repository at this point in the history
… license
  • Loading branch information
rubentalstra committed Mar 8, 2025
1 parent e3f6661 commit 1157b5f
Show file tree
Hide file tree
Showing 5 changed files with 138 additions and 4 deletions.
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

21 changes: 21 additions & 0 deletions packages/data-schemas/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2025 LibreChat

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
114 changes: 114 additions & 0 deletions packages/data-schemas/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
# `@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:

```bash
npm install @librechat/data-schemas
```

Or with yarn:

```bash
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:

```js
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:

```js
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 LibreChat’s use cases.


## Development

This package uses Rollup and TypeScript for building and bundling.

### Available Scripts

- **Build:**
Cleans the `dist` directory and builds the package.
```bash
npm run build
```

- **Build Watch:**
Rebuilds automatically on file changes.
```bash
npm run build:watch
```

- **Test:**
Runs tests with coverage in watch mode.
```bash
npm run test
```

- **Test (CI):**
Runs tests with coverage for CI environments.
```bash
npm run test:ci
```

- **Verify:**
Runs tests in CI mode to verify code integrity.
```bash
npm run verify
```

- **Clean:**
Removes the `dist` directory.
```bash
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.
- **Repository:** [LibreChat Repository](https://github.com/danny-avila/LibreChat.git)
- **Issues & Bug Reports:** [LibreChat Issues](https://github.com/danny-avila/LibreChat/issues)


## License

This project is licensed under the [MIT License](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](https://github.com/danny-avila/LibreChat/issues).

For more detailed documentation on each schema and model, please refer to the source code or visit the [LibreChat website](https://librechat.ai).
4 changes: 2 additions & 2 deletions packages/data-schemas/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@librechat/data-schemas",
"version": "0.0.1",
"version": "0.0.2",
"type": "module",
"description": "Mongoose schemas and models for LibreChat",
"main": "dist/index.cjs",
Expand Down Expand Up @@ -28,7 +28,7 @@
"url": "git+https://github.com/danny-avila/LibreChat.git"
},
"author": "",
"license": "ISC",
"license": "MIT",
"bugs": {
"url": "https://github.com/danny-avila/LibreChat/issues"
},
Expand Down
1 change: 0 additions & 1 deletion packages/data-schemas/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
// index.ts
import actionSchema from './schema/action';
import agentSchema from './schema/agent';
import assistantSchema from './schema/assistant';
Expand Down

0 comments on commit 1157b5f

Please sign in to comment.