@librechat/data-schemas 0.0.1

package/dist/index.es.js

@@ -0,0 +1,1119 @@
+import mongoose, { Schema } from 'mongoose';
+import { FileSources, Constants, PermissionTypes, Permissions, SystemRoles } from 'librechat-data-provider';
+
+// Define the Auth sub-schema with type-safety.
+const AuthSchema = new Schema({
+    authorization_type: { type: String },
+    custom_auth_header: { type: String },
+    type: { type: String, enum: ['service_http', 'oauth', 'none'] },
+    authorization_content_type: { type: String },
+    authorization_url: { type: String },
+    client_url: { type: String },
+    scope: { type: String },
+    token_exchange_method: { type: String, enum: ['default_post', 'basic_auth_header', null] },
+}, { _id: false });
+const Action = new Schema({
+    user: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'User',
+        index: true,
+        required: true,
+    },
+    action_id: {
+        type: String,
+        index: true,
+        required: true,
+    },
+    type: {
+        type: String,
+        default: 'action_prototype',
+    },
+    settings: Schema.Types.Mixed,
+    agent_id: String,
+    assistant_id: String,
+    metadata: {
+        api_key: String,
+        auth: AuthSchema,
+        domain: {
+            type: String,
+            required: true,
+        },
+        privacy_policy_url: String,
+        raw_spec: String,
+        oauth_client_id: String,
+        oauth_client_secret: String,
+    },
+});
+
+const agentSchema = new Schema({
+    id: {
+        type: String,
+        index: true,
+        unique: true,
+        required: true,
+    },
+    name: {
+        type: String,
+    },
+    description: {
+        type: String,
+    },
+    instructions: {
+        type: String,
+    },
+    avatar: {
+        type: {
+            filepath: String,
+            source: String,
+        },
+        default: undefined,
+    },
+    provider: {
+        type: String,
+        required: true,
+    },
+    model: {
+        type: String,
+        required: true,
+    },
+    model_parameters: {
+        type: Object,
+    },
+    artifacts: {
+        type: String,
+    },
+    access_level: {
+        type: Number,
+    },
+    tools: {
+        type: [String],
+        default: undefined,
+    },
+    tool_kwargs: {
+        type: [{ type: Schema.Types.Mixed }],
+    },
+    actions: {
+        type: [String],
+        default: undefined,
+    },
+    author: {
+        type: Schema.Types.ObjectId,
+        ref: 'User',
+        required: true,
+    },
+    authorName: {
+        type: String,
+        default: undefined,
+    },
+    hide_sequential_outputs: {
+        type: Boolean,
+    },
+    end_after_tools: {
+        type: Boolean,
+    },
+    agent_ids: {
+        type: [String],
+    },
+    isCollaborative: {
+        type: Boolean,
+        default: undefined,
+    },
+    conversation_starters: {
+        type: [String],
+        default: [],
+    },
+    tool_resources: {
+        type: Schema.Types.Mixed,
+        default: {},
+    },
+    projectIds: {
+        type: [Schema.Types.ObjectId],
+        ref: 'Project',
+        index: true,
+    },
+}, {
+    timestamps: true,
+});
+
+const assistantSchema = new Schema({
+    user: {
+        type: Schema.Types.ObjectId,
+        ref: 'User',
+        required: true,
+    },
+    assistant_id: {
+        type: String,
+        index: true,
+        required: true,
+    },
+    avatar: {
+        type: {
+            filepath: String,
+            source: String,
+        },
+        default: undefined,
+    },
+    conversation_starters: {
+        type: [String],
+        default: [],
+    },
+    access_level: {
+        type: Number,
+    },
+    file_ids: { type: [String], default: undefined },
+    actions: { type: [String], default: undefined },
+    append_current_datetime: {
+        type: Boolean,
+        default: false,
+    },
+}, {
+    timestamps: true,
+});
+
+const balanceSchema = new Schema({
+    user: {
+        type: Schema.Types.ObjectId,
+        ref: 'User',
+        index: true,
+        required: true,
+    },
+    // 1000 tokenCredits = 1 mill ($0.001 USD)
+    tokenCredits: {
+        type: Number,
+        default: 0,
+    },
+});
+
+const bannerSchema = new Schema({
+    bannerId: {
+        type: String,
+        required: true,
+    },
+    message: {
+        type: String,
+        required: true,
+    },
+    displayFrom: {
+        type: Date,
+        required: true,
+        default: Date.now,
+    },
+    displayTo: {
+        type: Date,
+    },
+    type: {
+        type: String,
+        enum: ['banner', 'popup'],
+        default: 'banner',
+    },
+    isPublic: {
+        type: Boolean,
+        default: false,
+    },
+}, { timestamps: true });
+
+const categoriesSchema = new Schema({
+    label: {
+        type: String,
+        required: true,
+        unique: true,
+    },
+    value: {
+        type: String,
+        required: true,
+        unique: true,
+    },
+});
+
+const conversationTag = new Schema({
+    tag: {
+        type: String,
+        index: true,
+    },
+    user: {
+        type: String,
+        index: true,
+    },
+    description: {
+        type: String,
+        index: true,
+    },
+    count: {
+        type: Number,
+        default: 0,
+    },
+    position: {
+        type: Number,
+        default: 0,
+        index: true,
+    },
+}, { timestamps: true });
+// Create a compound index on tag and user with unique constraint.
+conversationTag.index({ tag: 1, user: 1 }, { unique: true });
+
+// @ts-ignore
+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,
+    },
+};
+
+const convoSchema = new Schema(Object.assign(Object.assign({ 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 });
+
+const file = 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 });
+
+const keySchema = 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 });
+
+const messageSchema = 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 });
+
+const pluginAuthSchema = new Schema({
+    authField: {
+        type: String,
+        required: true,
+    },
+    value: {
+        type: String,
+        required: true,
+    },
+    userId: {
+        type: String,
+        required: true,
+    },
+    pluginKey: {
+        type: String,
+    },
+}, { timestamps: true });
+
+const presetSchema = new Schema(Object.assign(Object.assign({ 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 });
+
+const projectSchema = new Schema({
+    name: {
+        type: String,
+        required: true,
+        index: true,
+    },
+    promptGroupIds: {
+        type: [Schema.Types.ObjectId],
+        ref: 'PromptGroup',
+        default: [],
+    },
+    agentIds: {
+        type: [String],
+        ref: 'Agent',
+        default: [],
+    },
+}, {
+    timestamps: true,
+});
+
+const promptSchema = new Schema({
+    groupId: {
+        type: Schema.Types.ObjectId,
+        ref: 'PromptGroup',
+        required: true,
+        index: true,
+    },
+    author: {
+        type: Schema.Types.ObjectId,
+        ref: 'User',
+        required: true,
+    },
+    prompt: {
+        type: String,
+        required: true,
+    },
+    type: {
+        type: String,
+        enum: ['text', 'chat'],
+        required: true,
+    },
+}, {
+    timestamps: true,
+});
+promptSchema.index({ createdAt: 1, updatedAt: 1 });
+
+const promptGroupSchema = new Schema({
+    name: {
+        type: String,
+        required: true,
+        index: true,
+    },
+    numberOfGenerations: {
+        type: Number,
+        default: 0,
+    },
+    oneliner: {
+        type: String,
+        default: '',
+    },
+    category: {
+        type: String,
+        default: '',
+        index: true,
+    },
+    projectIds: {
+        type: [Schema.Types.ObjectId],
+        ref: 'Project',
+        index: true,
+        default: [],
+    },
+    productionId: {
+        type: Schema.Types.ObjectId,
+        ref: 'Prompt',
+        required: true,
+        index: true,
+    },
+    author: {
+        type: Schema.Types.ObjectId,
+        ref: 'User',
+        required: true,
+        index: true,
+    },
+    authorName: {
+        type: String,
+        required: true,
+    },
+    command: {
+        type: String,
+        index: true,
+        validate: {
+            validator: function (v) {
+                return v === undefined || v === null || v === '' || /^[a-z0-9-]+$/.test(v);
+            },
+            message: (props) => `${props.value} is not a valid command. Only lowercase alphanumeric characters and hyphens are allowed.`,
+        },
+        maxlength: [
+            Constants.COMMANDS_MAX_LENGTH,
+            `Command cannot be longer than ${Constants.COMMANDS_MAX_LENGTH} characters`,
+        ],
+    }, // Casting here bypasses the type error for the command field.
+}, {
+    timestamps: true,
+});
+promptGroupSchema.index({ createdAt: 1, updatedAt: 1 });
+
+const roleSchema = new Schema({
+    name: {
+        type: String,
+        required: true,
+        unique: true,
+        index: true,
+    },
+    [PermissionTypes.BOOKMARKS]: {
+        [Permissions.USE]: {
+            type: Boolean,
+            default: true,
+        },
+    },
+    [PermissionTypes.PROMPTS]: {
+        [Permissions.SHARED_GLOBAL]: {
+            type: Boolean,
+            default: false,
+        },
+        [Permissions.USE]: {
+            type: Boolean,
+            default: true,
+        },
+        [Permissions.CREATE]: {
+            type: Boolean,
+            default: true,
+        },
+    },
+    [PermissionTypes.AGENTS]: {
+        [Permissions.SHARED_GLOBAL]: {
+            type: Boolean,
+            default: false,
+        },
+        [Permissions.USE]: {
+            type: Boolean,
+            default: true,
+        },
+        [Permissions.CREATE]: {
+            type: Boolean,
+            default: true,
+        },
+    },
+    [PermissionTypes.MULTI_CONVO]: {
+        [Permissions.USE]: {
+            type: Boolean,
+            default: true,
+        },
+    },
+    [PermissionTypes.TEMPORARY_CHAT]: {
+        [Permissions.USE]: {
+            type: Boolean,
+            default: true,
+        },
+    },
+    [PermissionTypes.RUN_CODE]: {
+        [Permissions.USE]: {
+            type: Boolean,
+            default: true,
+        },
+    },
+});
+
+const sessionSchema = new Schema({
+    refreshTokenHash: {
+        type: String,
+        required: true,
+    },
+    expiration: {
+        type: Date,
+        required: true,
+        expires: 0,
+    },
+    user: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'User',
+        required: true,
+    },
+});
+
+const shareSchema = new Schema({
+    conversationId: {
+        type: String,
+        required: true,
+    },
+    title: {
+        type: String,
+        index: true,
+    },
+    user: {
+        type: String,
+        index: true,
+    },
+    messages: [{ type: mongoose.Schema.Types.ObjectId, ref: 'Message' }],
+    shareId: {
+        type: String,
+        index: true,
+    },
+    isPublic: {
+        type: Boolean,
+        default: true,
+    },
+}, { timestamps: true });
+
+const tokenSchema = new Schema({
+    userId: {
+        type: Schema.Types.ObjectId,
+        required: true,
+        ref: 'user',
+    },
+    email: {
+        type: String,
+    },
+    type: {
+        type: String,
+    },
+    identifier: {
+        type: String,
+    },
+    token: {
+        type: String,
+        required: true,
+    },
+    createdAt: {
+        type: Date,
+        required: true,
+        default: Date.now,
+    },
+    expiresAt: {
+        type: Date,
+        required: true,
+    },
+    metadata: {
+        type: Map,
+        of: Schema.Types.Mixed,
+    },
+});
+tokenSchema.index({ expiresAt: 1 }, { expireAfterSeconds: 0 });
+
+const toolCallSchema = new Schema({
+    conversationId: {
+        type: String,
+        required: true,
+    },
+    messageId: {
+        type: String,
+        required: true,
+    },
+    toolId: {
+        type: String,
+        required: true,
+    },
+    user: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'User',
+        required: true,
+    },
+    result: {
+        type: mongoose.Schema.Types.Mixed,
+    },
+    attachments: {
+        type: mongoose.Schema.Types.Mixed,
+    },
+    blockIndex: {
+        type: Number,
+    },
+    partIndex: {
+        type: Number,
+    },
+}, { timestamps: true });
+toolCallSchema.index({ messageId: 1, user: 1 });
+toolCallSchema.index({ conversationId: 1, user: 1 });
+
+const transactionSchema = new Schema({
+    user: {
+        type: mongoose.Schema.Types.ObjectId,
+        ref: 'User',
+        index: true,
+        required: true,
+    },
+    conversationId: {
+        type: String,
+        ref: 'Conversation',
+        index: true,
+    },
+    tokenType: {
+        type: String,
+        enum: ['prompt', 'completion', 'credits'],
+        required: true,
+    },
+    model: {
+        type: String,
+    },
+    context: {
+        type: String,
+    },
+    valueKey: {
+        type: String,
+    },
+    rate: Number,
+    rawAmount: Number,
+    tokenValue: Number,
+    inputTokens: { type: Number },
+    writeTokens: { type: Number },
+    readTokens: { type: Number },
+}, {
+    timestamps: true,
+});
+
+// Session sub-schema
+const SessionSchema = new Schema({
+    refreshToken: {
+        type: String,
+        default: '',
+    },
+}, { _id: false });
+// Backup code sub-schema
+const BackupCodeSchema = new Schema({
+    codeHash: { type: String, required: true },
+    used: { type: Boolean, default: false },
+    usedAt: { type: Date, default: null },
+}, { _id: false });
+const User = new Schema({
+    name: {
+        type: String,
+    },
+    username: {
+        type: String,
+        lowercase: true,
+        default: '',
+    },
+    email: {
+        type: String,
+        required: [true, 'can\'t be blank'],
+        lowercase: true,
+        unique: true,
+        match: [/\S+@\S+\.\S+/, 'is invalid'],
+        index: true,
+    },
+    emailVerified: {
+        type: Boolean,
+        required: true,
+        default: false,
+    },
+    password: {
+        type: String,
+        trim: true,
+        minlength: 8,
+        maxlength: 128,
+    },
+    avatar: {
+        type: String,
+        required: false,
+    },
+    provider: {
+        type: String,
+        required: true,
+        default: 'local',
+    },
+    role: {
+        type: String,
+        default: SystemRoles.USER,
+    },
+    googleId: {
+        type: String,
+        unique: true,
+        sparse: true,
+    },
+    facebookId: {
+        type: String,
+        unique: true,
+        sparse: true,
+    },
+    openidId: {
+        type: String,
+        unique: true,
+        sparse: true,
+    },
+    ldapId: {
+        type: String,
+        unique: true,
+        sparse: true,
+    },
+    githubId: {
+        type: String,
+        unique: true,
+        sparse: true,
+    },
+    discordId: {
+        type: String,
+        unique: true,
+        sparse: true,
+    },
+    appleId: {
+        type: String,
+        unique: true,
+        sparse: true,
+    },
+    plugins: {
+        type: Array,
+    },
+    totpSecret: {
+        type: String,
+    },
+    backupCodes: {
+        type: [BackupCodeSchema],
+    },
+    refreshToken: {
+        type: [SessionSchema],
+    },
+    expiresAt: {
+        type: Date,
+        expires: 604800, // 7 days in seconds
+    },
+    termsAccepted: {
+        type: Boolean,
+        default: false,
+    },
+}, { timestamps: true });
+
+export { Action as actionSchema, agentSchema, assistantSchema, balanceSchema, bannerSchema, categoriesSchema, conversationTag as conversationTagSchema, convoSchema, file as fileSchema, keySchema, messageSchema, pluginAuthSchema, presetSchema, projectSchema, promptGroupSchema, promptSchema, roleSchema, sessionSchema, shareSchema, tokenSchema, toolCallSchema, transactionSchema, User as userSchema };
+//# sourceMappingURL=index.es.js.map