@librechat/data-schemas 0.0.8 → 0.0.11

package/dist/types/models/plugins/mongoMeili.d.ts

@@ -23,13 +23,57 @@
 /// <reference types="mongoose/types/virtuals" />
 /// <reference types="mongoose/types/inferschematype" />
 /// <reference types="mongoose/types/inferrawdoctype" />
-import type { Schema } from 'mongoose';
+import type { SearchResponse, Index } from 'meilisearch';
+import type { CallbackWithoutResultAndOptionalError, Document, Schema, Model } from 'mongoose';
+import type { IConversation, IMessage } from '~/types';
 interface MongoMeiliOptions {
     host: string;
     apiKey: string;
     indexName: string;
     primaryKey: string;
     mongoose: typeof import('mongoose');
+    syncBatchSize?: number;
+    syncDelayMs?: number;
+}
+interface MeiliIndexable {
+    [key: string]: unknown;
+    _meiliIndex?: boolean;
+}
+interface SyncProgress {
+    lastSyncedId?: string;
+    totalProcessed: number;
+    totalDocuments: number;
+    isComplete: boolean;
+}
+interface _DocumentWithMeiliIndex extends Document {
+    _meiliIndex?: boolean;
+    preprocessObjectForIndex?: () => Record<string, unknown>;
+    addObjectToMeili?: (next: CallbackWithoutResultAndOptionalError) => Promise<void>;
+    updateObjectToMeili?: (next: CallbackWithoutResultAndOptionalError) => Promise<void>;
+    deleteObjectFromMeili?: (next: CallbackWithoutResultAndOptionalError) => Promise<void>;
+    postSaveHook?: (next: CallbackWithoutResultAndOptionalError) => void;
+    postUpdateHook?: (next: CallbackWithoutResultAndOptionalError) => void;
+    postRemoveHook?: (next: CallbackWithoutResultAndOptionalError) => void;
+}
+export type DocumentWithMeiliIndex = _DocumentWithMeiliIndex & IConversation & Partial<IMessage>;
+export interface SchemaWithMeiliMethods extends Model<DocumentWithMeiliIndex> {
+    syncWithMeili(options?: {
+        resumeFromId?: string;
+    }): Promise<void>;
+    getSyncProgress(): Promise<SyncProgress>;
+    processSyncBatch(index: Index<MeiliIndexable>, documents: Array<Record<string, unknown>>, updateOps: Array<{
+        updateOne: {
+            filter: Record<string, unknown>;
+            update: {
+                $set: {
+                    _meiliIndex: boolean;
+                };
+            };
+        };
+    }>): Promise<void>;
+    cleanupMeiliIndex(index: Index<MeiliIndexable>, primaryKey: string, batchSize: number, delayMs: number): Promise<void>;
+    setMeiliIndexSettings(settings: Record<string, unknown>): Promise<unknown>;
+    meiliSearch(q: string, params?: Record<string, unknown>, populate?: boolean): Promise<SearchResponse<MeiliIndexable, Record<string, unknown>>>;
 }
 /**
  * Mongoose plugin to synchronize MongoDB collections with a MeiliSearch index.
@@ -47,6 +91,8 @@ interface MongoMeiliOptions {
  * @param options.apiKey - The MeiliSearch API key.
  * @param options.indexName - The name of the MeiliSearch index.
  * @param options.primaryKey - The primary key field for indexing.
+ * @param options.syncBatchSize - Batch size for sync operations.
+ * @param options.syncDelayMs - Delay between batches in milliseconds.
  */
 export default function mongoMeili(schema: Schema, options: MongoMeiliOptions): void;
 export {};

package/dist/types/schema/defaults.d.ts

@@ -162,8 +162,21 @@ export declare const conversationPreset: {
     max_tokens: {
         type: NumberConstructor;
     };
-    /** omni models only */
+    useResponsesApi: {
+        type: BooleanConstructor;
+    };
+    /** OpenAI Responses API / Anthropic API / Google API */
+    web_search: {
+        type: BooleanConstructor;
+    };
+    disableStreaming: {
+        type: BooleanConstructor;
+    };
+    /** Reasoning models only */
     reasoning_effort: {
         type: StringConstructor;
     };
+    reasoning_summary: {
+        type: StringConstructor;
+    };
 };

package/dist/types/schema/index.d.ts

@@ -21,3 +21,4 @@ export { default as tokenSchema } from './token';
 export { default as toolCallSchema } from './toolCall';
 export { default as transactionSchema } from './transaction';
 export { default as userSchema } from './user';
+export { default as memorySchema } from './memory';

package/dist/types/schema/memory.d.ts

@@ -0,0 +1,29 @@
+/// <reference types="mongoose/types/aggregate" />
+/// <reference types="mongoose/types/callback" />
+/// <reference types="mongoose/types/collection" />
+/// <reference types="mongoose/types/connection" />
+/// <reference types="mongoose/types/cursor" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/error" />
+/// <reference types="mongoose/types/expressions" />
+/// <reference types="mongoose/types/helpers" />
+/// <reference types="mongoose/types/middlewares" />
+/// <reference types="mongoose/types/indexes" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/mongooseoptions" />
+/// <reference types="mongoose/types/pipelinestage" />
+/// <reference types="mongoose/types/populate" />
+/// <reference types="mongoose/types/query" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/schematypes" />
+/// <reference types="mongoose/types/session" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/validation" />
+/// <reference types="mongoose/types/virtuals" />
+/// <reference types="mongoose/types/inferschematype" />
+/// <reference types="mongoose/types/inferrawdoctype" />
+import { Schema } from 'mongoose';
+import type { IMemoryEntry } from '~/types/memory';
+declare const MemoryEntrySchema: Schema<IMemoryEntry>;
+export default MemoryEntrySchema;

package/dist/types/schema/pluginAuth.d.ts

@@ -23,14 +23,7 @@
 /// <reference types="mongoose/types/virtuals" />
 /// <reference types="mongoose/types/inferschematype" />
 /// <reference types="mongoose/types/inferrawdoctype" />
-import { Schema, Document } from 'mongoose';
-export interface IPluginAuth extends Document {
-    authField: string;
-    value: string;
-    userId: string;
-    pluginKey?: string;
-    createdAt?: Date;
-    updatedAt?: Date;
-}
+import { Schema } from 'mongoose';
+import type { IPluginAuth } from '~/types';
 declare const pluginAuthSchema: Schema<IPluginAuth>;
 export default pluginAuthSchema;

package/dist/types/schema/preset.d.ts

@@ -67,6 +67,10 @@ export interface IPreset extends Document {
     maxContextTokens?: number;
     max_tokens?: number;
     reasoning_effort?: string;
+    reasoning_summary?: string;
+    useResponsesApi?: boolean;
+    web_search?: boolean;
+    disableStreaming?: boolean;
     agentOptions?: unknown;
 }
 declare const presetSchema: Schema<IPreset>;

package/dist/types/types/convo.d.ts

@@ -67,6 +67,10 @@ export interface IConversation extends Document {
     maxContextTokens?: number;
     max_tokens?: number;
     reasoning_effort?: string;
+    reasoning_summary?: string;
+    useResponsesApi?: boolean;
+    web_search?: boolean;
+    disableStreaming?: boolean;
     files?: string[];
     expiredAt?: Date;
     createdAt?: Date;

package/dist/types/types/index.d.ts

@@ -1,3 +1,30 @@
+/// <reference types="mongoose/types/aggregate" />
+/// <reference types="mongoose/types/callback" />
+/// <reference types="mongoose/types/collection" />
+/// <reference types="mongoose/types/connection" />
+/// <reference types="mongoose/types/cursor" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/error" />
+/// <reference types="mongoose/types/expressions" />
+/// <reference types="mongoose/types/helpers" />
+/// <reference types="mongoose/types/middlewares" />
+/// <reference types="mongoose/types/indexes" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/mongooseoptions" />
+/// <reference types="mongoose/types/pipelinestage" />
+/// <reference types="mongoose/types/populate" />
+/// <reference types="mongoose/types/query" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/schematypes" />
+/// <reference types="mongoose/types/session" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/validation" />
+/// <reference types="mongoose/types/virtuals" />
+/// <reference types="mongoose/types/inferschematype" />
+/// <reference types="mongoose/types/inferrawdoctype" />
+import type { Types } from 'mongoose';
+export type ObjectId = Types.ObjectId;
 export * from './user';
 export * from './token';
 export * from './convo';
@@ -10,3 +37,6 @@ export * from './role';
 export * from './action';
 export * from './assistant';
 export * from './file';
+export * from './share';
+export * from './pluginAuth';
+export * from './memory';

package/dist/types/types/memory.d.ts

@@ -0,0 +1,63 @@
+/// <reference types="mongoose/types/aggregate" />
+/// <reference types="mongoose/types/callback" />
+/// <reference types="mongoose/types/collection" />
+/// <reference types="mongoose/types/connection" />
+/// <reference types="mongoose/types/cursor" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/error" />
+/// <reference types="mongoose/types/expressions" />
+/// <reference types="mongoose/types/helpers" />
+/// <reference types="mongoose/types/middlewares" />
+/// <reference types="mongoose/types/indexes" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/mongooseoptions" />
+/// <reference types="mongoose/types/pipelinestage" />
+/// <reference types="mongoose/types/populate" />
+/// <reference types="mongoose/types/query" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/schematypes" />
+/// <reference types="mongoose/types/session" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/validation" />
+/// <reference types="mongoose/types/virtuals" />
+/// <reference types="mongoose/types/inferschematype" />
+/// <reference types="mongoose/types/inferrawdoctype" />
+import type { Types, Document } from 'mongoose';
+export interface IMemoryEntry extends Document {
+    userId: Types.ObjectId;
+    key: string;
+    value: string;
+    tokenCount?: number;
+    updated_at?: Date;
+}
+export interface IMemoryEntryLean {
+    _id: Types.ObjectId;
+    userId: Types.ObjectId;
+    key: string;
+    value: string;
+    tokenCount?: number;
+    updated_at?: Date;
+    __v?: number;
+}
+export interface SetMemoryParams {
+    userId: string | Types.ObjectId;
+    key: string;
+    value: string;
+    tokenCount?: number;
+}
+export interface DeleteMemoryParams {
+    userId: string | Types.ObjectId;
+    key: string;
+}
+export interface GetFormattedMemoriesParams {
+    userId: string | Types.ObjectId;
+}
+export interface MemoryResult {
+    ok: boolean;
+}
+export interface FormattedMemoriesResult {
+    withKeys: string;
+    withoutKeys: string;
+    totalTokens?: number;
+}

package/dist/types/types/pluginAuth.d.ts

@@ -0,0 +1,59 @@
+/// <reference types="mongoose/types/aggregate" />
+/// <reference types="mongoose/types/callback" />
+/// <reference types="mongoose/types/collection" />
+/// <reference types="mongoose/types/connection" />
+/// <reference types="mongoose/types/cursor" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/error" />
+/// <reference types="mongoose/types/expressions" />
+/// <reference types="mongoose/types/helpers" />
+/// <reference types="mongoose/types/middlewares" />
+/// <reference types="mongoose/types/indexes" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/mongooseoptions" />
+/// <reference types="mongoose/types/pipelinestage" />
+/// <reference types="mongoose/types/populate" />
+/// <reference types="mongoose/types/query" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/schematypes" />
+/// <reference types="mongoose/types/session" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/validation" />
+/// <reference types="mongoose/types/virtuals" />
+/// <reference types="mongoose/types/inferschematype" />
+/// <reference types="mongoose/types/inferrawdoctype" />
+import type { Document } from 'mongoose';
+export interface IPluginAuth extends Document {
+    authField: string;
+    value: string;
+    userId: string;
+    pluginKey?: string;
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+export interface PluginAuthQuery {
+    userId: string;
+    authField?: string;
+    pluginKey?: string;
+}
+export interface FindPluginAuthParams {
+    userId: string;
+    authField: string;
+}
+export interface FindPluginAuthsByKeysParams {
+    userId: string;
+    pluginKeys: string[];
+}
+export interface UpdatePluginAuthParams {
+    userId: string;
+    authField: string;
+    pluginKey: string;
+    value: string;
+}
+export interface DeletePluginAuthParams {
+    userId: string;
+    authField?: string;
+    pluginKey?: string;
+    all?: boolean;
+}

package/dist/types/types/share.d.ts

@@ -0,0 +1,82 @@
+/// <reference types="mongoose/types/aggregate" />
+/// <reference types="mongoose/types/callback" />
+/// <reference types="mongoose/types/collection" />
+/// <reference types="mongoose/types/connection" />
+/// <reference types="mongoose/types/cursor" />
+/// <reference types="mongoose/types/document" />
+/// <reference types="mongoose/types/error" />
+/// <reference types="mongoose/types/expressions" />
+/// <reference types="mongoose/types/helpers" />
+/// <reference types="mongoose/types/middlewares" />
+/// <reference types="mongoose/types/indexes" />
+/// <reference types="mongoose/types/models" />
+/// <reference types="mongoose/types/mongooseoptions" />
+/// <reference types="mongoose/types/pipelinestage" />
+/// <reference types="mongoose/types/populate" />
+/// <reference types="mongoose/types/query" />
+/// <reference types="mongoose/types/schemaoptions" />
+/// <reference types="mongoose/types/schematypes" />
+/// <reference types="mongoose/types/session" />
+/// <reference types="mongoose/types/types" />
+/// <reference types="mongoose/types/utility" />
+/// <reference types="mongoose/types/validation" />
+/// <reference types="mongoose/types/virtuals" />
+/// <reference types="mongoose/types/inferschematype" />
+/// <reference types="mongoose/types/inferrawdoctype" />
+import type { Types } from 'mongoose';
+import type { IMessage } from './message';
+export interface ISharedLink {
+    _id?: Types.ObjectId;
+    conversationId: string;
+    title?: string;
+    user?: string;
+    messages?: Types.ObjectId[];
+    shareId?: string;
+    isPublic: boolean;
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+export interface ShareServiceError extends Error {
+    code: string;
+}
+export interface SharedLinksResult {
+    links: Array<{
+        shareId: string;
+        title: string;
+        isPublic: boolean;
+        createdAt: Date;
+        conversationId: string;
+    }>;
+    nextCursor?: Date;
+    hasNextPage: boolean;
+}
+export interface SharedMessagesResult {
+    conversationId: string;
+    messages: Array<IMessage>;
+    shareId: string;
+    title?: string;
+    isPublic: boolean;
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+export interface CreateShareResult {
+    shareId: string;
+    conversationId: string;
+}
+export interface UpdateShareResult {
+    shareId: string;
+    conversationId: string;
+}
+export interface DeleteShareResult {
+    success: boolean;
+    shareId: string;
+    message: string;
+}
+export interface GetShareLinkResult {
+    shareId: string | null;
+    success: boolean;
+}
+export interface DeleteAllSharesResult {
+    message: string;
+    deletedCount: number;
+}

package/dist/types/types/user.d.ts

@@ -54,6 +54,9 @@ export interface IUser extends Document {
     }>;
     expiresAt?: Date;
     termsAccepted?: boolean;
+    personalization?: {
+        memories?: boolean;
+    };
     createdAt?: Date;
     updatedAt?: Date;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@librechat/data-schemas",
-  "version": "0.0.8",
+  "version": "0.0.11",
   "description": "Mongoose schemas and models for LibreChat",
   "type": "module",
   "main": "dist/index.cjs",
@@ -51,6 +51,7 @@
     "@types/traverse": "^0.6.37",
     "jest": "^29.5.0",
     "jest-junit": "^16.0.0",
+    "mongodb-memory-server": "^10.1.4",
     "rimraf": "^5.0.1",
     "rollup": "^4.22.4",
     "rollup-plugin-generate-package-json": "^3.2.0",
@@ -60,13 +61,14 @@
     "typescript": "^5.0.4"
   },
   "peerDependencies": {
-    "keyv": "^5.3.2",
-    "mongoose": "^8.12.1",
-    "librechat-data-provider": "*",
     "jsonwebtoken": "^9.0.2",
+    "keyv": "^5.3.2",
     "klona": "^2.0.6",
+    "librechat-data-provider": "*",
     "lodash": "^4.17.21",
     "meilisearch": "^0.38.0",
+    "mongoose": "^8.12.1",
+    "nanoid": "^3.3.7",
     "traverse": "^0.6.11",
     "winston": "^3.17.0",
     "winston-daily-rotate-file": "^5.0.0"

package/README.md

@@ -1,114 +0,0 @@
-# `@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).