@librechat/data-schemas 0.0.17 → 0.0.19

package/dist/types/common/index.d.ts

@@ -1 +1,2 @@
 export * from './enum';
+export * from './pagination';

package/dist/types/common/pagination.d.ts

@@ -0,0 +1,16 @@
+export interface CursorPaginationParams {
+    limit?: number;
+    cursor?: string;
+    sortBy?: string;
+    sortOrder?: 'asc' | 'desc';
+}
+export interface CursorPaginationResponse<T> {
+    data: T[];
+    pagination: {
+        hasNextPage: boolean;
+        hasPreviousPage: boolean;
+        nextCursor?: string;
+        previousCursor?: string;
+        totalCount?: number;
+    };
+}

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

@@ -24,12 +24,12 @@
 /// <reference types="mongoose/types/inferschematype" />
 /// <reference types="mongoose/types/inferrawdoctype" />
 import { FilterQuery } from 'mongoose';
-import type { IUser, BalanceConfig, UserCreateData, UserUpdateResult } from '~/types';
+import type { IUser, BalanceConfig, CreateUserRequest, UserDeleteResult } from '~/types';
 /** Factory function that takes mongoose instance and returns the methods */
 export declare function createUserMethods(mongoose: typeof import('mongoose')): {
     findUser: (searchCriteria: FilterQuery<IUser>, fieldsToSelect?: string | string[] | null) => Promise<IUser | null>;
     countUsers: (filter?: FilterQuery<IUser>) => Promise<number>;
-    createUser: (data: UserCreateData, balanceConfig?: BalanceConfig, disableTTL?: boolean, returnUser?: boolean) => Promise<mongoose.Types.ObjectId | Partial<IUser>>;
+    createUser: (data: CreateUserRequest, balanceConfig?: BalanceConfig, disableTTL?: boolean, returnUser?: boolean) => Promise<mongoose.Types.ObjectId | Partial<IUser>>;
     updateUser: (userId: string, updateData: Partial<IUser>) => Promise<IUser | null>;
     searchUsers: ({ searchPattern, limit, fieldsToSelect, }: {
         searchPattern: string;
@@ -41,7 +41,7 @@ export declare function createUserMethods(mongoose: typeof import('mongoose')):
     }[]>;
     getUserById: (userId: string, fieldsToSelect?: string | string[] | null) => Promise<IUser | null>;
     generateToken: (user: IUser) => Promise<string>;
-    deleteUserById: (userId: string) => Promise<UserUpdateResult>;
+    deleteUserById: (userId: string) => Promise<UserDeleteResult>;
     toggleUserMemories: (userId: string, memoriesEnabled: boolean) => Promise<IUser | null>;
 };
 export type UserMethods = ReturnType<typeof createUserMethods>;

package/dist/types/types/group.d.ts

@@ -24,23 +24,41 @@
 /// <reference types="mongoose/types/inferschematype" />
 /// <reference types="mongoose/types/inferrawdoctype" />
 import type { Document, Types } from 'mongoose';
+import { CursorPaginationParams } from '~/common';
 export interface IGroup extends Document {
     _id: Types.ObjectId;
-    /** The name of the group */
     name: string;
-    /** Optional description of the group */
     description?: string;
-    /** Optional email address for the group */
     email?: string;
-    /** Optional avatar URL for the group */
     avatar?: string;
     /** Array of member IDs (stores idOnTheSource values, not ObjectIds) */
-    memberIds: string[];
-    /** The source of the group ('local' or 'entra') */
+    memberIds?: string[];
     source: 'local' | 'entra';
     /** External ID (e.g., Entra ID) - required for non-local sources */
     idOnTheSource?: string;
-    /** Timestamps */
     createdAt?: Date;
     updatedAt?: Date;
 }
+export interface CreateGroupRequest {
+    name: string;
+    description?: string;
+    email?: string;
+    avatar?: string;
+    memberIds?: string[];
+    source: 'local' | 'entra';
+    idOnTheSource?: string;
+}
+export interface UpdateGroupRequest {
+    name?: string;
+    description?: string;
+    email?: string;
+    avatar?: string;
+    memberIds?: string[];
+    source?: 'local' | 'entra' | 'ldap';
+    idOnTheSource?: string;
+}
+export interface GroupFilterOptions extends CursorPaginationParams {
+    search?: string;
+    source?: 'local' | 'entra' | 'ldap';
+    hasMember?: string;
+}

package/dist/types/types/role.d.ts

@@ -23,8 +23,27 @@
 /// <reference types="mongoose/types/virtuals" />
 /// <reference types="mongoose/types/inferschematype" />
 /// <reference types="mongoose/types/inferrawdoctype" />
-import { Document } from 'mongoose';
+import type { Document } from 'mongoose';
+import { CursorPaginationParams } from '~/common';
 export interface IRole extends Document {
     name: string;
     permissions: {};
 }
+export type RolePermissions = IRole['permissions'];
+type DeepPartial<T> = {
+    [K in keyof T]?: T[K] extends object ? DeepPartial<T[K]> : T[K];
+};
+export type RolePermissionsInput = DeepPartial<RolePermissions>;
+export interface CreateRoleRequest {
+    name: string;
+    permissions: RolePermissionsInput;
+}
+export interface UpdateRoleRequest {
+    name?: string;
+    permissions?: RolePermissionsInput;
+}
+export interface RoleFilterOptions extends CursorPaginationParams {
+    search?: string;
+    hasPermission?: string;
+}
+export {};

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

@@ -23,7 +23,8 @@
 /// <reference types="mongoose/types/virtuals" />
 /// <reference types="mongoose/types/inferschematype" />
 /// <reference types="mongoose/types/inferrawdoctype" />
-import { Document, Types } from 'mongoose';
+import type { Document, Types } from 'mongoose';
+import { CursorPaginationParams } from '~/common';
 export interface IUser extends Document {
     name?: string;
     username?: string;
@@ -70,16 +71,34 @@ export interface BalanceConfig {
     refillIntervalUnit?: string;
     refillAmount?: number;
 }
-export interface UserCreateData extends Partial<IUser> {
+export interface CreateUserRequest extends Partial<IUser> {
     email: string;
 }
-export interface UserUpdateResult {
+export interface UpdateUserRequest {
+    name?: string;
+    username?: string;
+    email?: string;
+    role?: string;
+    emailVerified?: boolean;
+    avatar?: string;
+    plugins?: string[];
+    twoFactorEnabled?: boolean;
+    termsAccepted?: boolean;
+    personalization?: {
+        memories?: boolean;
+    };
+}
+export interface UserDeleteResult {
     deletedCount: number;
     message: string;
 }
-export interface UserSearchCriteria {
-    email?: string;
-    username?: string;
+export interface UserFilterOptions extends CursorPaginationParams {
+    _id?: Types.ObjectId | string;
+    search?: string;
+    role?: string;
+    emailVerified?: boolean;
+    provider?: string;
+    twoFactorEnabled?: boolean;
     googleId?: string;
     facebookId?: string;
     openidId?: string;
@@ -88,7 +107,8 @@ export interface UserSearchCriteria {
     githubId?: string;
     discordId?: string;
     appleId?: string;
-    _id?: Types.ObjectId | string;
+    createdAfter?: string;
+    createdBefore?: string;
 }
 export interface UserQueryOptions {
     fieldsToSelect?: string | string[] | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@librechat/data-schemas",
-  "version": "0.0.17",
+  "version": "0.0.19",
   "description": "Mongoose schemas and models for LibreChat",
   "type": "module",
   "main": "dist/index.cjs",