@librechat/data-schemas 0.0.3 → 0.0.5

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@librechat/data-schemas",
-  "version": "0.0.3",
-  "type": "module",
+  "version": "0.0.5",
   "description": "Mongoose schemas and models for LibreChat",
+  "type": "module",
   "main": "dist/index.cjs",
   "module": "dist/index.es.js",
   "types": "./dist/types/index.d.ts",
@@ -13,6 +13,9 @@
       "types": "./dist/types/index.d.ts"
     }
   },
+  "files": [
+    "dist"
+  ],
   "scripts": {
     "clean": "rimraf dist",
     "build": "npm run clean && rollup -c --silent --bundleConfigAsCjs",
@@ -55,14 +58,20 @@
     "ts-node": "^10.9.2",
     "typescript": "^5.0.4"
   },
-  "publishConfig": {
-    "registry": "https://registry.npmjs.org/",
-    "access": "public"
-  },
   "dependencies": {
     "mongoose": "^8.12.1"
   },
   "peerDependencies": {
     "keyv": "^4.5.4"
-  }
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "keywords": [
+    "mongoose",
+    "schema",
+    "typescript",
+    "librechat"
+  ]
 }

package/babel.config.cjs

@@ -1,4 +0,0 @@
-module.exports = {
-  presets: [['@babel/preset-env', { targets: { node: 'current' } }], '@babel/preset-typescript'],
-  plugins: ['babel-plugin-replace-ts-export-assignment'],
-};

package/jest.config.mjs

@@ -1,19 +0,0 @@
-export default {
-  collectCoverageFrom: ['src/**/*.{js,jsx,ts,tsx}', '!<rootDir>/node_modules/'],
-  coveragePathIgnorePatterns: ['/node_modules/', '/dist/'],
-  coverageReporters: ['text', 'cobertura'],
-  testResultsProcessor: 'jest-junit',
-  moduleNameMapper: {
-    '^@src/(.*)$': '<rootDir>/src/$1',
-  },
-  // coverageThreshold: {
-  //   global: {
-  //     statements: 58,
-  //     branches: 49,
-  //     functions: 50,
-  //     lines: 57,
-  //   },
-  // },
-  restoreMocks: true,
-  testTimeout: 15000,
-};

package/rollup.config.js

@@ -1,25 +0,0 @@
-import json from '@rollup/plugin-json';
-import typescript from '@rollup/plugin-typescript';
-import commonjs from '@rollup/plugin-commonjs';
-
-export default {
-  input: 'src/index.ts',
-  output: [
-    {
-      file: 'dist/index.cjs', // Changed from index.js to index.cjs
-      format: 'cjs',
-      sourcemap: true,
-      exports: 'named',
-    },
-    {
-      file: 'dist/index.es.js',
-      format: 'esm',
-      sourcemap: true,
-      exports: 'named',
-    },
-  ],
-  plugins: [json(), commonjs(), typescript({ tsconfig: './tsconfig.json' })],
-  external: [
-    // list your external dependencies
-  ],
-};

package/src/index.ts

@@ -1,49 +0,0 @@
-import actionSchema from './schema/action';
-import agentSchema from './schema/agent';
-import assistantSchema from './schema/assistant';
-import balanceSchema from './schema/balance';
-import bannerSchema from './schema/banner';
-import categoriesSchema from './schema/categories';
-import conversationTagSchema from './schema/conversationTag';
-import convoSchema from './schema/convo';
-import fileSchema from './schema/file';
-import keySchema from './schema/key';
-import messageSchema from './schema/message';
-import pluginAuthSchema from './schema/pluginAuth';
-import presetSchema from './schema/preset';
-import projectSchema from './schema/project';
-import promptSchema from './schema/prompt';
-import promptGroupSchema from './schema/promptGroup';
-import roleSchema from './schema/role';
-import sessionSchema from './schema/session';
-import shareSchema from './schema/share';
-import tokenSchema from './schema/token';
-import toolCallSchema from './schema/toolCall';
-import transactionSchema from './schema/transaction';
-import userSchema from './schema/user';
-
-export {
-  actionSchema,
-  agentSchema,
-  assistantSchema,
-  balanceSchema,
-  bannerSchema,
-  categoriesSchema,
-  conversationTagSchema,
-  convoSchema,
-  fileSchema,
-  keySchema,
-  messageSchema,
-  pluginAuthSchema,
-  presetSchema,
-  projectSchema,
-  promptSchema,
-  promptGroupSchema,
-  roleSchema,
-  sessionSchema,
-  shareSchema,
-  tokenSchema,
-  toolCallSchema,
-  transactionSchema,
-  userSchema,
-};

package/src/schema/action.ts

@@ -1,78 +0,0 @@
-import mongoose, { Schema, Document } from 'mongoose';
-
-export interface IAction extends Document {
-  user: mongoose.Types.ObjectId;
-  action_id: string;
-  type: string;
-  settings?: unknown;
-  agent_id?: string;
-  assistant_id?: string;
-  metadata: {
-    api_key?: string;
-    auth: {
-      authorization_type?: string;
-      custom_auth_header?: string;
-      type: 'service_http' | 'oauth' | 'none';
-      authorization_content_type?: string;
-      authorization_url?: string;
-      client_url?: string;
-      scope?: string;
-      token_exchange_method: 'default_post' | 'basic_auth_header' | null;
-    };
-    domain: string;
-    privacy_policy_url?: string;
-    raw_spec?: string;
-    oauth_client_id?: string;
-    oauth_client_secret?: string;
-  };
-}
-
-// 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<IAction>({
-  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,
-  },
-});
-
-export default Action;

package/src/schema/agent.ts

@@ -1,124 +0,0 @@
-import { Schema, Document, Types } from 'mongoose';
-export interface IAgent extends Omit<Document, 'model'> {
-  id: string;
-  name?: string;
-  description?: string;
-  instructions?: string;
-  avatar?: {
-    filepath: string;
-    source: string;
-  };
-  provider: string;
-  model: string;
-  model_parameters?: Record<string, unknown>;
-  artifacts?: string;
-  access_level?: number;
-  recursion_limit?: number;
-  tools?: string[];
-  tool_kwargs?: Array<unknown>;
-  actions?: string[];
-  author: Types.ObjectId;
-  authorName?: string;
-  hide_sequential_outputs?: boolean;
-  end_after_tools?: boolean;
-  agent_ids?: string[];
-  isCollaborative?: boolean;
-  conversation_starters?: string[];
-  tool_resources?: unknown;
-  projectIds?: Types.ObjectId[];
-}
-
-const agentSchema = new Schema<IAgent>(
-  {
-    id: {
-      type: String,
-      index: true,
-      unique: true,
-      required: true,
-    },
-    name: {
-      type: String,
-    },
-    description: {
-      type: String,
-    },
-    instructions: {
-      type: String,
-    },
-    avatar: {
-      type: Schema.Types.Mixed,
-      default: undefined,
-    },
-    provider: {
-      type: String,
-      required: true,
-    },
-    model: {
-      type: String,
-      required: true,
-    },
-    model_parameters: {
-      type: Object,
-    },
-    artifacts: {
-      type: String,
-    },
-    access_level: {
-      type: Number,
-    },
-    recursion_limit: {
-      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,
-  },
-);
-
-export default agentSchema;

package/src/schema/assistant.ts

@@ -1,52 +0,0 @@
-import { Schema, Document, Types } from 'mongoose';
-
-export interface IAssistant extends Document {
-  user: Types.ObjectId;
-  assistant_id: string;
-  avatar?: {
-    filepath: string;
-    source: string;
-  };
-  conversation_starters?: string[];
-  access_level?: number;
-  file_ids?: string[];
-  actions?: string[];
-  append_current_datetime?: boolean;
-}
-
-const assistantSchema = new Schema<IAssistant>(
-  {
-    user: {
-      type: Schema.Types.ObjectId,
-      ref: 'User',
-      required: true,
-    },
-    assistant_id: {
-      type: String,
-      index: true,
-      required: true,
-    },
-    avatar: {
-      type: Schema.Types.Mixed,
-      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,
-  },
-);
-
-export default assistantSchema;

package/src/schema/balance.ts

@@ -1,22 +0,0 @@
-import { Schema, Document, Types } from 'mongoose';
-
-export interface IBalance extends Document {
-  user: Types.ObjectId;
-  tokenCredits: number;
-}
-
-const balanceSchema = new Schema<IBalance>({
-  user: {
-    type: Schema.Types.ObjectId,
-    ref: 'User',
-    index: true,
-    required: true,
-  },
-  // 1000 tokenCredits = 1 mill ($0.001 USD)
-  tokenCredits: {
-    type: Number,
-    default: 0,
-  },
-});
-
-export default balanceSchema;

package/src/schema/banner.ts

@@ -1,43 +0,0 @@
-import { Schema, Document } from 'mongoose';
-
-export interface IBanner extends Document {
-  bannerId: string;
-  message: string;
-  displayFrom: Date;
-  displayTo?: Date;
-  type: 'banner' | 'popup';
-  isPublic: boolean;
-}
-
-const bannerSchema = new Schema<IBanner>(
-  {
-    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 },
-);
-
-export default bannerSchema;

package/src/schema/categories.ts

@@ -1,21 +0,0 @@
-import { Schema, Document } from 'mongoose';
-
-export interface ICategory extends Document {
-  label: string;
-  value: string;
-}
-
-const categoriesSchema = new Schema<ICategory>({
-  label: {
-    type: String,
-    required: true,
-    unique: true,
-  },
-  value: {
-    type: String,
-    required: true,
-    unique: true,
-  },
-});
-
-export default categoriesSchema;

package/src/schema/conversationTag.ts

@@ -1,41 +0,0 @@
-import { Schema, Document } from 'mongoose';
-
-export interface IConversationTag extends Document {
-  tag?: string;
-  user?: string;
-  description?: string;
-  count?: number;
-  position?: number;
-}
-
-const conversationTag = new Schema<IConversationTag>(
-  {
-    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 });
-
-export default conversationTag;

package/src/schema/convo.ts

@@ -1,101 +0,0 @@
-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;