@librechat/data-schemas 0.0.1

package/src/schema/prompt.ts

@@ -0,0 +1,42 @@
+import { Schema, Document, Types } from 'mongoose';
+
+export interface IPrompt extends Document {
+  groupId: Types.ObjectId;
+  author: Types.ObjectId;
+  prompt: string;
+  type: 'text' | 'chat';
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+const promptSchema: Schema<IPrompt> = 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 });
+
+export default promptSchema;

package/src/schema/promptGroup.ts

@@ -0,0 +1,85 @@
+import { Schema, Document, Types } from 'mongoose';
+import { Constants } from 'librechat-data-provider';
+
+export interface IPromptGroup {
+  name: string;
+  numberOfGenerations: number;
+  oneliner: string;
+  category: string;
+  projectIds: Types.ObjectId[];
+  productionId: Types.ObjectId;
+  author: Types.ObjectId;
+  authorName: string;
+  command?: string;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+export interface IPromptGroupDocument extends IPromptGroup, Document {}
+
+const promptGroupSchema = new Schema<IPromptGroupDocument>(
+  {
+    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: unknown): boolean {
+          return v === undefined || v === null || v === '' || /^[a-z0-9-]+$/.test(v);
+        },
+        message: (props: unknown) =>
+          `${props.value} is not a valid command. Only lowercase alphanumeric characters and hyphens are allowed.`,
+      },
+      maxlength: [
+        Constants.COMMANDS_MAX_LENGTH as number,
+        `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 });
+
+export default promptGroupSchema;

package/src/schema/role.ts

@@ -0,0 +1,91 @@
+import { Schema, Document } from 'mongoose';
+import { PermissionTypes, Permissions } from 'librechat-data-provider';
+
+export interface IRole extends Document {
+  name: string;
+  [PermissionTypes.BOOKMARKS]?: {
+    [Permissions.USE]?: boolean;
+  };
+  [PermissionTypes.PROMPTS]?: {
+    [Permissions.SHARED_GLOBAL]?: boolean;
+    [Permissions.USE]?: boolean;
+    [Permissions.CREATE]?: boolean;
+  };
+  [PermissionTypes.AGENTS]?: {
+    [Permissions.SHARED_GLOBAL]?: boolean;
+    [Permissions.USE]?: boolean;
+    [Permissions.CREATE]?: boolean;
+  };
+  [PermissionTypes.MULTI_CONVO]?: {
+    [Permissions.USE]?: boolean;
+  };
+  [PermissionTypes.TEMPORARY_CHAT]?: {
+    [Permissions.USE]?: boolean;
+  };
+  [PermissionTypes.RUN_CODE]?: {
+    [Permissions.USE]?: boolean;
+  };
+}
+
+const roleSchema: Schema<IRole> = 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,
+    },
+  },
+});
+
+export default roleSchema;

package/src/schema/session.ts

@@ -0,0 +1,26 @@
+import mongoose, { Schema, Document, Types } from 'mongoose';
+
+export interface ISession extends Document {
+  refreshTokenHash: string;
+  expiration: Date;
+  user: Types.ObjectId;
+}
+
+const sessionSchema: Schema<ISession> = new Schema({
+  refreshTokenHash: {
+    type: String,
+    required: true,
+  },
+  expiration: {
+    type: Date,
+    required: true,
+    expires: 0,
+  },
+  user: {
+    type: mongoose.Schema.Types.ObjectId,
+    ref: 'User',
+    required: true,
+  },
+});
+
+export default sessionSchema;

package/src/schema/share.ts

@@ -0,0 +1,41 @@
+import mongoose, { Schema, Document, Types } from 'mongoose';
+
+export interface ISharedLink extends Document {
+  conversationId: string;
+  title?: string;
+  user?: string;
+  messages?: Types.ObjectId[];
+  shareId?: string;
+  isPublic: boolean;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+const shareSchema: Schema<ISharedLink> = 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 },
+);
+
+export default shareSchema;

package/src/schema/token.ts

@@ -0,0 +1,50 @@
+import { Schema, Document, Types } from 'mongoose';
+
+export interface IToken extends Document {
+  userId: Types.ObjectId;
+  email?: string;
+  type?: string;
+  identifier?: string;
+  token: string;
+  createdAt: Date;
+  expiresAt: Date;
+  metadata?: Map<string, unknown>;
+}
+
+const tokenSchema: Schema<IToken> = 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 });
+
+export default tokenSchema;

package/src/schema/toolCall.ts

@@ -0,0 +1,55 @@
+import mongoose, { Schema, Document, Types } from 'mongoose';
+import type { TAttachment } from 'librechat-data-provider';
+
+export interface IToolCallData extends Document {
+  conversationId: string;
+  messageId: string;
+  toolId: string;
+  user: Types.ObjectId;
+  result?: unknown;
+  attachments?: TAttachment[];
+  blockIndex?: number;
+  partIndex?: number;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+const toolCallSchema: Schema<IToolCallData> = 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 });
+
+export default toolCallSchema;

package/src/schema/transaction.ts

@@ -0,0 +1,60 @@
+import mongoose, { Schema, Document, Types } from 'mongoose';
+
+// @ts-ignore
+export interface ITransaction extends Document {
+  user: Types.ObjectId;
+  conversationId?: string;
+  tokenType: 'prompt' | 'completion' | 'credits';
+  model?: string;
+  context?: string;
+  valueKey?: string;
+  rate?: number;
+  rawAmount?: number;
+  tokenValue?: number;
+  inputTokens?: number;
+  writeTokens?: number;
+  readTokens?: number;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+const transactionSchema: Schema<ITransaction> = 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,
+  },
+);
+
+export default transactionSchema;

package/src/schema/user.ts

@@ -0,0 +1,158 @@
+import { Schema, Document } from 'mongoose';
+import { SystemRoles } from 'librechat-data-provider';
+
+export interface IUser extends Document {
+  name?: string;
+  username?: string;
+  email: string;
+  emailVerified: boolean;
+  password?: string;
+  avatar?: string;
+  provider: string;
+  role?: string;
+  googleId?: string;
+  facebookId?: string;
+  openidId?: string;
+  ldapId?: string;
+  githubId?: string;
+  discordId?: string;
+  appleId?: string;
+  plugins?: unknown[];
+  totpSecret?: string;
+  backupCodes?: Array<{
+    codeHash: string;
+    used: boolean;
+    usedAt?: Date | null;
+  }>;
+  refreshToken?: Array<{
+    refreshToken: string;
+  }>;
+  expiresAt?: Date;
+  termsAccepted?: boolean;
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+
+// 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<IUser>(
+  {
+    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 default User;

package/tsconfig.json

@@ -0,0 +1,28 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "declarationDir": "./dist/types",
+    "module": "esnext",
+    "noImplicitAny": true,
+    "outDir": "./dist",
+    "target": "es2015",
+    "moduleResolution": "node",
+    "lib": ["es2017", "dom", "ES2021.String"],
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "noEmit": false,
+    "sourceMap": true,
+    "baseUrl": "."
+  },
+  "ts-node": {
+    "experimentalSpecifierResolution": "node",
+    "transpileOnly": true,
+    "esm": true
+  },
+  "exclude": ["node_modules", "dist", "types"],
+  "include": ["src/**/*", "types/index.d.ts", "types/react-query/index.d.ts"]
+}

package/tsconfig.spec.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "noEmit": true,
+    "outDir": "./dist/tests",
+    "baseUrl": "."
+  },
+  "include": ["specs/**/*", "src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}