@librechat/data-schemas 0.0.7 → 0.0.10

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/message.d.ts

@@ -0,0 +1,67 @@
+/// <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';
+import type { TFeedbackRating, TFeedbackTag } from 'librechat-data-provider';
+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;
+    feedback?: {
+        rating: TFeedbackRating;
+        tag: TFeedbackTag | undefined;
+        text?: 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;
+}

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/role.d.ts

@@ -0,0 +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 { Document } from 'mongoose';
+export interface IRole extends Document {
+    name: string;
+    permissions: {};
+}

package/dist/types/types/session.d.ts

@@ -0,0 +1,61 @@
+/// <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, Types } from 'mongoose';
+export interface ISession extends Document {
+    refreshTokenHash: string;
+    expiration: Date;
+    user: Types.ObjectId;
+}
+export interface CreateSessionOptions {
+    expiration?: Date;
+}
+export interface SessionSearchParams {
+    refreshToken?: string;
+    userId?: string;
+    sessionId?: string | {
+        sessionId: string;
+    };
+}
+export interface SessionQueryOptions {
+    lean?: boolean;
+}
+export interface DeleteSessionParams {
+    refreshToken?: string;
+    sessionId?: string;
+}
+export interface DeleteAllSessionsOptions {
+    excludeCurrentSession?: boolean;
+    currentSessionId?: string;
+}
+export interface SessionResult {
+    session: Partial<ISession>;
+    refreshToken: string;
+}
+export interface SignPayloadParams {
+    payload: Record<string, unknown>;
+    secret?: string;
+    expirationTime: number;
+}

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/token.d.ts

@@ -0,0 +1,62 @@
+/// <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 { 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>;
+}
+export interface TokenCreateData {
+    userId: Types.ObjectId | string;
+    email?: string;
+    type?: string;
+    identifier?: string;
+    token: string;
+    expiresIn: number;
+    metadata?: Map<string, unknown>;
+}
+export interface TokenQuery {
+    userId?: Types.ObjectId | string;
+    token?: string;
+    email?: string;
+    identifier?: string;
+}
+export interface TokenUpdateData {
+    email?: string;
+    type?: string;
+    identifier?: string;
+    token?: string;
+    expiresAt?: Date;
+    metadata?: Map<string, unknown>;
+}
+export interface TokenDeleteResult {
+    deletedCount?: number;
+}

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

@@ -0,0 +1,94 @@
+/// <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 { Document, Types } from 'mongoose';
+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;
+    samlId?: string;
+    ldapId?: string;
+    githubId?: string;
+    discordId?: string;
+    appleId?: string;
+    plugins?: unknown[];
+    twoFactorEnabled?: boolean;
+    totpSecret?: string;
+    backupCodes?: Array<{
+        codeHash: string;
+        used: boolean;
+        usedAt?: Date | null;
+    }>;
+    refreshToken?: Array<{
+        refreshToken: string;
+    }>;
+    expiresAt?: Date;
+    termsAccepted?: boolean;
+    personalization?: {
+        memories?: boolean;
+    };
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+export interface BalanceConfig {
+    enabled?: boolean;
+    startBalance?: number;
+    autoRefillEnabled?: boolean;
+    refillIntervalValue?: number;
+    refillIntervalUnit?: string;
+    refillAmount?: number;
+}
+export interface UserCreateData extends Partial<IUser> {
+    email: string;
+}
+export interface UserUpdateResult {
+    deletedCount: number;
+    message: string;
+}
+export interface UserSearchCriteria {
+    email?: string;
+    username?: string;
+    googleId?: string;
+    facebookId?: string;
+    openidId?: string;
+    samlId?: string;
+    ldapId?: string;
+    githubId?: string;
+    discordId?: string;
+    appleId?: string;
+    _id?: Types.ObjectId | string;
+}
+export interface UserQueryOptions {
+    fieldsToSelect?: string | string[] | null;
+    lean?: boolean;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@librechat/data-schemas",
-  "version": "0.0.7",
+  "version": "0.0.10",
   "description": "Mongoose schemas and models for LibreChat",
   "type": "module",
   "main": "dist/index.cjs",
@@ -48,8 +48,10 @@
     "@types/express": "^5.0.0",
     "@types/jest": "^29.5.2",
     "@types/node": "^20.3.0",
+    "@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",
@@ -58,11 +60,18 @@
     "ts-node": "^10.9.2",
     "typescript": "^5.0.4"
   },
-  "dependencies": {
-    "mongoose": "^8.12.1"
-  },
   "peerDependencies": {
-    "keyv": "^5.3.2"
+    "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"
   },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",