@librechat/data-schemas 0.0.1

package/src/schema/convo.ts

@@ -0,0 +1,101 @@
+import mongoose, { Schema, Document, Types } from 'mongoose';
+import { conversationPreset } from './defaults';
+
+// @ts-ignore
+export interface IConversation extends Document {
+  conversationId: string;
+  title?: string;
+  user?: string;
+  messages?: Types.ObjectId[];
+  agentOptions?: unknown;
+  // Fields provided by conversationPreset (adjust types as needed)
+  endpoint?: string;
+  endpointType?: string;
+  model?: string;
+  region?: string;
+  chatGptLabel?: string;
+  examples?: unknown[];
+  modelLabel?: string;
+  promptPrefix?: string;
+  temperature?: number;
+  top_p?: number;
+  topP?: number;
+  topK?: number;
+  maxOutputTokens?: number;
+  maxTokens?: number;
+  presence_penalty?: number;
+  frequency_penalty?: number;
+  file_ids?: string[];
+  resendImages?: boolean;
+  promptCache?: boolean;
+  thinking?: boolean;
+  thinkingBudget?: number;
+  system?: string;
+  resendFiles?: boolean;
+  imageDetail?: string;
+  agent_id?: string;
+  assistant_id?: string;
+  instructions?: string;
+  stop?: string[];
+  isArchived?: boolean;
+  iconURL?: string;
+  greeting?: string;
+  spec?: string;
+  tags?: string[];
+  tools?: string[];
+  maxContextTokens?: number;
+  max_tokens?: number;
+  reasoning_effort?: string;
+  // Additional fields
+  files?: string[];
+  expiredAt?: Date;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+const convoSchema: Schema<IConversation> = new Schema(
+  {
+    conversationId: {
+      type: String,
+      unique: true,
+      required: true,
+      index: true,
+      meiliIndex: true,
+    },
+    title: {
+      type: String,
+      default: 'New Chat',
+      meiliIndex: true,
+    },
+    user: {
+      type: String,
+      index: true,
+    },
+    messages: [{ type: mongoose.Schema.Types.ObjectId, ref: 'Message' }],
+    agentOptions: {
+      type: mongoose.Schema.Types.Mixed,
+    },
+    ...conversationPreset,
+    agent_id: {
+      type: String,
+    },
+    tags: {
+      type: [String],
+      default: [],
+      meiliIndex: true,
+    },
+    files: {
+      type: [String],
+    },
+    expiredAt: {
+      type: Date,
+    },
+  },
+  { timestamps: true },
+);
+
+convoSchema.index({ expiredAt: 1 }, { expireAfterSeconds: 0 });
+convoSchema.index({ createdAt: 1, updatedAt: 1 });
+convoSchema.index({ conversationId: 1, user: 1 }, { unique: true });
+
+export default convoSchema;

package/src/schema/defaults.ts

@@ -0,0 +1,138 @@
+import { Schema } from 'mongoose';
+
+// @ts-ignore
+export const conversationPreset = {
+  // endpoint: [azureOpenAI, openAI, anthropic, chatGPTBrowser]
+  endpoint: {
+    type: String,
+    default: null,
+    required: true,
+  },
+  endpointType: {
+    type: String,
+  },
+  // for azureOpenAI, openAI, chatGPTBrowser only
+  model: {
+    type: String,
+    required: false,
+  },
+  // for bedrock only
+  region: {
+    type: String,
+    required: false,
+  },
+  // for azureOpenAI, openAI only
+  chatGptLabel: {
+    type: String,
+    required: false,
+  },
+  // for google only
+  examples: { type: [{ type: Schema.Types.Mixed }], default: undefined },
+  modelLabel: {
+    type: String,
+    required: false,
+  },
+  promptPrefix: {
+    type: String,
+    required: false,
+  },
+  temperature: {
+    type: Number,
+    required: false,
+  },
+  top_p: {
+    type: Number,
+    required: false,
+  },
+  // for google only
+  topP: {
+    type: Number,
+    required: false,
+  },
+  topK: {
+    type: Number,
+    required: false,
+  },
+  maxOutputTokens: {
+    type: Number,
+    required: false,
+  },
+  maxTokens: {
+    type: Number,
+    required: false,
+  },
+  presence_penalty: {
+    type: Number,
+    required: false,
+  },
+  frequency_penalty: {
+    type: Number,
+    required: false,
+  },
+  file_ids: { type: [{ type: String }], default: undefined },
+  // deprecated
+  resendImages: {
+    type: Boolean,
+  },
+  /* Anthropic only */
+  promptCache: {
+    type: Boolean,
+  },
+  thinking: {
+    type: Boolean,
+  },
+  thinkingBudget: {
+    type: Number,
+  },
+  system: {
+    type: String,
+  },
+  // files
+  resendFiles: {
+    type: Boolean,
+  },
+  imageDetail: {
+    type: String,
+  },
+  /* agents */
+  agent_id: {
+    type: String,
+  },
+  /* assistants */
+  assistant_id: {
+    type: String,
+  },
+  instructions: {
+    type: String,
+  },
+  stop: { type: [{ type: String }], default: undefined },
+  isArchived: {
+    type: Boolean,
+    default: false,
+  },
+  /* UI Components */
+  iconURL: {
+    type: String,
+  },
+  greeting: {
+    type: String,
+  },
+  spec: {
+    type: String,
+  },
+  tags: {
+    type: [String],
+    default: [],
+  },
+  tools: { type: [{ type: String }], default: undefined },
+  maxContextTokens: {
+    type: Number,
+  },
+  max_tokens: {
+    type: Number,
+  },
+  /** omni models only */
+  reasoning_effort: {
+    type: String,
+  },
+};

package/src/schema/file.ts

@@ -0,0 +1,107 @@
+import mongoose, { Schema, Document, Types } from 'mongoose';
+import { FileSources } from 'librechat-data-provider';
+
+// @ts-ignore
+export interface IMongoFile extends Document {
+  user: Types.ObjectId;
+  conversationId?: string;
+  file_id: string;
+  temp_file_id?: string;
+  bytes: number;
+  filename: string;
+  filepath: string;
+  object: 'file';
+  embedded?: boolean;
+  type: string;
+  context?: string;
+  usage: number;
+  source: string;
+  model?: string;
+  width?: number;
+  height?: number;
+  metadata?: {
+    fileIdentifier?: string;
+  };
+  expiresAt?: Date;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+const file: Schema<IMongoFile> = new Schema(
+  {
+    user: {
+      type: mongoose.Schema.Types.ObjectId,
+      ref: 'User',
+      index: true,
+      required: true,
+    },
+    conversationId: {
+      type: String,
+      ref: 'Conversation',
+      index: true,
+    },
+    file_id: {
+      type: String,
+      index: true,
+      required: true,
+    },
+    temp_file_id: {
+      type: String,
+    },
+    bytes: {
+      type: Number,
+      required: true,
+    },
+    filename: {
+      type: String,
+      required: true,
+    },
+    filepath: {
+      type: String,
+      required: true,
+    },
+    object: {
+      type: String,
+      required: true,
+      default: 'file',
+    },
+    embedded: {
+      type: Boolean,
+    },
+    type: {
+      type: String,
+      required: true,
+    },
+    context: {
+      type: String,
+    },
+    usage: {
+      type: Number,
+      required: true,
+      default: 0,
+    },
+    source: {
+      type: String,
+      default: FileSources.local,
+    },
+    model: {
+      type: String,
+    },
+    width: Number,
+    height: Number,
+    metadata: {
+      fileIdentifier: String,
+    },
+    expiresAt: {
+      type: Date,
+      expires: 3600, // 1 hour in seconds
+    },
+  },
+  {
+    timestamps: true,
+  },
+);
+
+file.index({ createdAt: 1, updatedAt: 1 });
+
+export default file;

package/src/schema/key.ts

@@ -0,0 +1,31 @@
+import mongoose, { Schema, Document, Types } from 'mongoose';
+
+export interface IKey extends Document {
+  userId: Types.ObjectId;
+  name: string;
+  value: string;
+  expiresAt?: Date;
+}
+
+const keySchema: Schema<IKey> = new Schema({
+  userId: {
+    type: mongoose.Schema.Types.ObjectId,
+    ref: 'User',
+    required: true,
+  },
+  name: {
+    type: String,
+    required: true,
+  },
+  value: {
+    type: String,
+    required: true,
+  },
+  expiresAt: {
+    type: Date,
+  },
+});
+
+keySchema.index({ expiresAt: 1 }, { expireAfterSeconds: 0 });
+
+export default keySchema;

package/src/schema/message.ts

@@ -0,0 +1,185 @@
+import mongoose, { Schema, Document } from 'mongoose';
+
+// @ts-ignore
+export interface IMessage extends Document {
+  messageId: string;
+  conversationId: string;
+  user: string;
+  model?: string;
+  endpoint?: string;
+  conversationSignature?: string;
+  clientId?: string;
+  invocationId?: number;
+  parentMessageId?: string;
+  tokenCount?: number;
+  summaryTokenCount?: number;
+  sender?: string;
+  text?: string;
+  summary?: string;
+  isCreatedByUser: boolean;
+  unfinished?: boolean;
+  error?: boolean;
+  finish_reason?: string;
+  _meiliIndex?: boolean;
+  files?: unknown[];
+  plugin?: {
+    latest?: string;
+    inputs?: unknown[];
+    outputs?: string;
+  };
+  plugins?: unknown[];
+  content?: unknown[];
+  thread_id?: string;
+  iconURL?: string;
+  attachments?: unknown[];
+  expiredAt?: Date;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+const messageSchema: Schema<IMessage> = new Schema(
+  {
+    messageId: {
+      type: String,
+      unique: true,
+      required: true,
+      index: true,
+      meiliIndex: true,
+    },
+    conversationId: {
+      type: String,
+      index: true,
+      required: true,
+      meiliIndex: true,
+    },
+    user: {
+      type: String,
+      index: true,
+      required: true,
+      default: null,
+    },
+    model: {
+      type: String,
+      default: null,
+    },
+    endpoint: {
+      type: String,
+    },
+    conversationSignature: {
+      type: String,
+    },
+    clientId: {
+      type: String,
+    },
+    invocationId: {
+      type: Number,
+    },
+    parentMessageId: {
+      type: String,
+    },
+    tokenCount: {
+      type: Number,
+    },
+    summaryTokenCount: {
+      type: Number,
+    },
+    sender: {
+      type: String,
+      meiliIndex: true,
+    },
+    text: {
+      type: String,
+      meiliIndex: true,
+    },
+    summary: {
+      type: String,
+    },
+    isCreatedByUser: {
+      type: Boolean,
+      required: true,
+      default: false,
+    },
+    unfinished: {
+      type: Boolean,
+      default: false,
+    },
+    error: {
+      type: Boolean,
+      default: false,
+    },
+    finish_reason: {
+      type: String,
+    },
+    _meiliIndex: {
+      type: Boolean,
+      required: false,
+      select: false,
+      default: false,
+    },
+    files: { type: [{ type: mongoose.Schema.Types.Mixed }], default: undefined },
+    plugin: {
+      type: {
+        latest: {
+          type: String,
+          required: false,
+        },
+        inputs: {
+          type: [mongoose.Schema.Types.Mixed],
+          required: false,
+          default: undefined,
+        },
+        outputs: {
+          type: String,
+          required: false,
+        },
+      },
+      default: undefined,
+    },
+    plugins: { type: [{ type: mongoose.Schema.Types.Mixed }], default: undefined },
+    content: {
+      type: [{ type: mongoose.Schema.Types.Mixed }],
+      default: undefined,
+      meiliIndex: true,
+    },
+    thread_id: {
+      type: String,
+    },
+    /* frontend components */
+    iconURL: {
+      type: String,
+    },
+    attachments: { type: [{ type: mongoose.Schema.Types.Mixed }], default: undefined },
+    /*
+    attachments: {
+      type: [
+        {
+          file_id: String,
+          filename: String,
+          filepath: String,
+          expiresAt: Date,
+          width: Number,
+          height: Number,
+          type: String,
+          conversationId: String,
+          messageId: {
+            type: String,
+            required: true,
+          },
+          toolCallId: String,
+        },
+      ],
+      default: undefined,
+    },
+    */
+    expiredAt: {
+      type: Date,
+    },
+  },
+  { timestamps: true },
+);
+
+messageSchema.index({ expiredAt: 1 }, { expireAfterSeconds: 0 });
+messageSchema.index({ createdAt: 1 });
+messageSchema.index({ messageId: 1, user: 1 }, { unique: true });
+
+export default messageSchema;

package/src/schema/pluginAuth.ts

@@ -0,0 +1,33 @@
+import { Schema, Document } from 'mongoose';
+
+export interface IPluginAuth extends Document {
+  authField: string;
+  value: string;
+  userId: string;
+  pluginKey?: string;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+const pluginAuthSchema: Schema<IPluginAuth> = new Schema(
+  {
+    authField: {
+      type: String,
+      required: true,
+    },
+    value: {
+      type: String,
+      required: true,
+    },
+    userId: {
+      type: String,
+      required: true,
+    },
+    pluginKey: {
+      type: String,
+    },
+  },
+  { timestamps: true },
+);
+
+export default pluginAuthSchema;

package/src/schema/preset.ts

@@ -0,0 +1,85 @@
+import mongoose, { Schema, Document } from 'mongoose';
+import { conversationPreset } from './defaults';
+
+// @ts-ignore
+export interface IPreset extends Document {
+  presetId: string;
+  title: string;
+  user: string | null;
+  defaultPreset?: boolean;
+  order?: number;
+  // Additional fields from conversationPreset and others will be available via an index signature.
+  endpoint?: string;
+  endpointType?: string;
+  model?: string;
+  region?: string;
+  chatGptLabel?: string;
+  examples?: unknown[];
+  modelLabel?: string;
+  promptPrefix?: string;
+  temperature?: number;
+  top_p?: number;
+  topP?: number;
+  topK?: number;
+  maxOutputTokens?: number;
+  maxTokens?: number;
+  presence_penalty?: number;
+  frequency_penalty?: number;
+  file_ids?: string[];
+  resendImages?: boolean;
+  promptCache?: boolean;
+  thinking?: boolean;
+  thinkingBudget?: number;
+  system?: string;
+  resendFiles?: boolean;
+  imageDetail?: string;
+  agent_id?: string;
+  assistant_id?: string;
+  instructions?: string;
+  stop?: string[];
+  isArchived?: boolean;
+  iconURL?: string;
+  greeting?: string;
+  spec?: string;
+  tags?: string[];
+  tools?: string[];
+  maxContextTokens?: number;
+  max_tokens?: number;
+  reasoning_effort?: string;
+  // end of additional fields
+  agentOptions?: unknown;
+}
+
+const presetSchema: Schema<IPreset> = new Schema(
+  {
+    presetId: {
+      type: String,
+      unique: true,
+      required: true,
+      index: true,
+    },
+    title: {
+      type: String,
+      default: 'New Chat',
+      meiliIndex: true,
+    },
+    user: {
+      type: String,
+      default: null,
+    },
+    defaultPreset: {
+      type: Boolean,
+    },
+    order: {
+      type: Number,
+    },
+    ...conversationPreset,
+    agentOptions: {
+      type: mongoose.Schema.Types.Mixed,
+      default: null,
+    },
+  },
+  { timestamps: true },
+);
+
+export default presetSchema;

package/src/schema/project.ts

@@ -0,0 +1,34 @@
+import { Schema, Document, Types } from 'mongoose';
+
+export interface IMongoProject extends Document {
+  name: string;
+  promptGroupIds: Types.ObjectId[];
+  agentIds: string[];
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+const projectSchema = new Schema<IMongoProject>(
+  {
+    name: {
+      type: String,
+      required: true,
+      index: true,
+    },
+    promptGroupIds: {
+      type: [Schema.Types.ObjectId],
+      ref: 'PromptGroup',
+      default: [],
+    },
+    agentIds: {
+      type: [String],
+      ref: 'Agent',
+      default: [],
+    },
+  },
+  {
+    timestamps: true,
+  },
+);
+
+export default projectSchema;