@librechat/data-schemas 0.0.23 → 0.0.30

package/dist/types/app/agents.d.ts

@@ -0,0 +1,10 @@
+import type { TCustomConfig, TAgentsEndpoint } from 'librechat-data-provider';
+/**
+ * Sets up the Agents configuration from the config (`librechat.yaml`) file.
+ * If no agents config is defined, uses the provided defaults or parses empty object.
+ *
+ * @param config - The loaded custom configuration.
+ * @param [defaultConfig] - Default configuration from getConfigDefaults.
+ * @returns The Agents endpoint configuration.
+ */
+export declare function agentsConfigSetup(config: Partial<TCustomConfig>, defaultConfig?: Partial<TAgentsEndpoint>): Partial<TAgentsEndpoint>;

package/dist/types/app/assistants.d.ts

@@ -0,0 +1,19 @@
+import { EModelEndpoint } from 'librechat-data-provider';
+import type { TCustomConfig, TAssistantEndpoint } from 'librechat-data-provider';
+/**
+ * Sets up the minimum, default Assistants configuration if Azure OpenAI Assistants option is enabled.
+ * @returns The Assistants endpoint configuration.
+ */
+export declare function azureAssistantsDefaults(): {
+    capabilities: TAssistantEndpoint['capabilities'];
+    version: TAssistantEndpoint['version'];
+};
+/**
+ * Sets up the Assistants configuration from the config (`librechat.yaml`) file.
+ * @param config - The loaded custom configuration.
+ * @param assistantsEndpoint - The Assistants endpoint name.
+ * - The previously loaded assistants configuration from Azure OpenAI Assistants option.
+ * @param [prevConfig]
+ * @returns The Assistants endpoint configuration.
+ */
+export declare function assistantsConfigSetup(config: Partial<TCustomConfig>, assistantsEndpoint: EModelEndpoint.assistants | EModelEndpoint.azureAssistants, prevConfig?: Partial<TAssistantEndpoint>): Partial<TAssistantEndpoint>;

package/dist/types/app/azure.d.ts

@@ -0,0 +1,7 @@
+import type { TCustomConfig, TAzureConfig } from 'librechat-data-provider';
+/**
+ * Sets up the Azure OpenAI configuration from the config (`librechat.yaml`) file.
+ * @param config - The loaded custom configuration.
+ * @returns The Azure OpenAI configuration.
+ */
+export declare function azureConfigSetup(config: Partial<TCustomConfig>): TAzureConfig;

package/dist/types/app/endpoints.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Loads custom config endpoints
+ * @param [config]
+ * @param [agentsDefaults]
+ */
+export declare const loadEndpoints: (config: TCustomConfig, agentsDefaults?: any) => {
+    openAI?: any;
+    google?: any;
+    bedrock?: any;
+    anthropic?: any;
+    gptPlugins?: any;
+    azureOpenAI?: any;
+    assistants?: any;
+    azureAssistants?: any;
+    all?: any;
+};

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

@@ -0,0 +1,6 @@
+export * from './agents';
+export * from './interface';
+export * from './service';
+export * from './specs';
+export * from './turnstile';
+export * from './web';

package/dist/types/app/interface.d.ts

@@ -0,0 +1,13 @@
+import type { TCustomConfig, TConfigDefaults } from 'librechat-data-provider';
+import type { AppConfig } from '~/types/app';
+/**
+ * Loads the default interface object.
+ * @param params - The loaded custom configuration.
+ * @param params.config - The loaded custom configuration.
+ * @param params.configDefaults - The custom configuration default values.
+ * @returns default interface object.
+ */
+export declare function loadDefaultInterface({ config, configDefaults, }: {
+    config?: Partial<TCustomConfig>;
+    configDefaults: TConfigDefaults;
+}): Promise<AppConfig['interfaceConfig']>;

package/dist/types/app/memory.d.ts

@@ -0,0 +1,3 @@
+import type { TCustomConfig, TMemoryConfig } from 'librechat-data-provider';
+export declare function loadMemoryConfig(config: TCustomConfig['memory']): TMemoryConfig | undefined;
+export declare function isMemoryEnabled(config: TMemoryConfig | undefined): boolean;

package/dist/types/app/ocr.d.ts

@@ -0,0 +1,2 @@
+import type { TCustomConfig } from 'librechat-data-provider';
+export declare function loadOCRConfig(config?: TCustomConfig['ocr']): TCustomConfig['ocr'] | undefined;

package/dist/types/app/service.d.ts

@@ -0,0 +1,23 @@
+import type { TCustomConfig, DeepPartial } from 'librechat-data-provider';
+import type { AppConfig, FunctionTool } from '~/types/app';
+export type Paths = {
+    root: string;
+    uploads: string;
+    clientPath: string;
+    dist: string;
+    publicPath: string;
+    fonts: string;
+    assets: string;
+    imageOutput: string;
+    structuredTools: string;
+    pluginManifest: string;
+};
+/**
+ * Loads custom config and initializes app-wide variables.
+ * @function AppService
+ */
+export declare const AppService: (params?: {
+    config: DeepPartial<TCustomConfig>;
+    paths?: Paths;
+    systemTools?: Record<string, FunctionTool>;
+}) => Promise<AppConfig>;

package/dist/types/app/specs.d.ts

@@ -0,0 +1,9 @@
+import type { TCustomConfig } from 'librechat-data-provider';
+/**
+ * Sets up Model Specs from the config (`librechat.yaml`) file.
+ * @param [endpoints] - The loaded custom configuration for endpoints.
+ * @param [modelSpecs] - The loaded custom configuration for model specs.
+ * @param [interfaceConfig] - The loaded interface configuration.
+ * @returns The processed model specs, if any.
+ */
+export declare function processModelSpecs(endpoints?: TCustomConfig['endpoints'], _modelSpecs?: TCustomConfig['modelSpecs'], interfaceConfig?: TCustomConfig['interface']): TCustomConfig['modelSpecs'] | undefined;

package/dist/types/app/turnstile.d.ts

@@ -0,0 +1,17 @@
+import type { TCustomConfig, TConfigDefaults } from 'librechat-data-provider';
+/**
+ * Loads and maps the Cloudflare Turnstile configuration.
+ *
+ * Expected config structure:
+ *
+ * turnstile:
+ *   siteKey: "your-site-key-here"
+ *   options:
+ *     language: "auto"    // "auto" or an ISO 639-1 language code (e.g. en)
+ *     size: "normal"      // Options: "normal", "compact", "flexible", or "invisible"
+ *
+ * @param config - The loaded custom configuration.
+ * @param configDefaults - The custom configuration default values.
+ * @returns The mapped Turnstile configuration.
+ */
+export declare function loadTurnstileConfig(config: Partial<TCustomConfig> | undefined, configDefaults: TConfigDefaults): Partial<TCustomConfig['turnstile']>;

package/dist/types/app/web.d.ts

@@ -0,0 +1,41 @@
+import type { TCustomConfig } from 'librechat-data-provider';
+import type { TWebSearchKeys } from '~/types/web';
+export declare const webSearchAuth: {
+    providers: {
+        serper: {
+            serperApiKey: 1;
+        };
+        searxng: {
+            searxngInstanceUrl: 1;
+            /** Optional (0) */
+            searxngApiKey: 0;
+        };
+    };
+    scrapers: {
+        firecrawl: {
+            firecrawlApiKey: 1;
+            /** Optional (0) */
+            firecrawlApiUrl: 0;
+            firecrawlVersion: 0;
+        };
+        serper: {
+            serperApiKey: 1;
+        };
+    };
+    rerankers: {
+        jina: {
+            jinaApiKey: 1;
+            /** Optional (0) */
+            jinaApiUrl: 0;
+        };
+        cohere: {
+            cohereApiKey: 1;
+        };
+    };
+};
+/**
+ * Extracts all unique API keys from the webSearchAuth configuration object
+ */
+export declare function getWebSearchKeys(): TWebSearchKeys[];
+export declare const webSearchKeys: TWebSearchKeys[];
+export declare function loadWebSearchConfig(config: TCustomConfig['webSearch']): TCustomConfig['webSearch'];

package/dist/types/app/web.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
+export * from './app';
 export * from './common';
 export * from './crypto';
 export * from './schema';

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

@@ -29,10 +29,11 @@ import type * as t from '~/types';
 export declare function createShareMethods(mongoose: typeof import('mongoose')): {
     getSharedLink: (user: string, conversationId: string) => Promise<t.GetShareLinkResult>;
     getSharedLinks: (user: string, pageParam?: Date, pageSize?: number, isPublic?: boolean, sortBy?: string, sortDirection?: string, search?: string) => Promise<t.SharedLinksResult>;
-    createSharedLink: (user: string, conversationId: string) => Promise<t.CreateShareResult>;
+    createSharedLink: (user: string, conversationId: string, targetMessageId?: string) => Promise<t.CreateShareResult>;
     updateSharedLink: (user: string, shareId: string) => Promise<t.UpdateShareResult>;
     deleteSharedLink: (user: string, shareId: string) => Promise<t.DeleteShareResult | null>;
     getSharedMessages: (shareId: string) => Promise<t.SharedMessagesResult | null>;
     deleteAllSharedLinks: (user: string) => Promise<t.DeleteAllSharesResult>;
+    deleteConvoSharedLink: (user: string, conversationId: string) => Promise<t.DeleteAllSharesResult>;
 };
 export type ShareMethods = ReturnType<typeof createShareMethods>;

package/dist/types/schema/share.d.ts

@@ -30,6 +30,7 @@ export interface ISharedLink extends Document {
     user?: string;
     messages?: Types.ObjectId[];
     shareId?: string;
+    targetMessageId?: string;
     isPublic: boolean;
     createdAt?: Date;
     updatedAt?: Date;

package/dist/types/types/agent.d.ts

@@ -24,6 +24,7 @@
 /// <reference types="mongoose/types/inferschematype" />
 /// <reference types="mongoose/types/inferrawdoctype" />
 import { Document, Types } from 'mongoose';
+import type { GraphEdge } from 'librechat-data-provider';
 export interface ISupportContact {
     name?: string;
     email?: string;
@@ -50,7 +51,9 @@ export interface IAgent extends Omit<Document, 'model'> {
     authorName?: string;
     hide_sequential_outputs?: boolean;
     end_after_tools?: boolean;
+    /** @deprecated Use edges instead */
     agent_ids?: string[];
+    edges?: GraphEdge[];
     /** @deprecated Use ACL permissions instead */
     isCollaborative?: boolean;
     conversation_starters?: string[];

package/dist/types/types/app.d.ts

@@ -0,0 +1,98 @@
+import type { TEndpoint, FileSources, TFileConfig, TAzureConfig, TCustomConfig, TMemoryConfig, TAssistantEndpoint } from 'librechat-data-provider';
+export type JsonSchemaType = {
+    type: 'string' | 'number' | 'integer' | 'float' | 'boolean' | 'array' | 'object';
+    enum?: string[];
+    items?: JsonSchemaType;
+    properties?: Record<string, JsonSchemaType>;
+    required?: string[];
+    description?: string;
+    additionalProperties?: boolean | JsonSchemaType;
+};
+export type ConvertJsonSchemaToZodOptions = {
+    allowEmptyObject?: boolean;
+    dropFields?: string[];
+    transformOneOfAnyOf?: boolean;
+};
+export interface FunctionTool {
+    type: 'function';
+    function: {
+        description: string;
+        name: string;
+        parameters: JsonSchemaType;
+    };
+}
+/**
+ * Application configuration object
+ * Based on the configuration defined in api/server/services/Config/getAppConfig.js
+ */
+export interface AppConfig {
+    /** The main custom configuration */
+    config: Partial<TCustomConfig>;
+    /** OCR configuration */
+    ocr?: TCustomConfig['ocr'];
+    /** File paths configuration */
+    paths?: {
+        uploads: string;
+        imageOutput: string;
+        publicPath: string;
+        [key: string]: string;
+    };
+    /** Memory configuration */
+    memory?: TMemoryConfig;
+    /** Web search configuration */
+    webSearch?: TCustomConfig['webSearch'];
+    /** File storage strategy ('local', 's3', 'firebase', 'azure_blob') */
+    fileStrategy: FileSources.local | FileSources.s3 | FileSources.firebase | FileSources.azure_blob;
+    /** File strategies configuration */
+    fileStrategies?: TCustomConfig['fileStrategies'];
+    /** Registration configurations */
+    registration?: TCustomConfig['registration'];
+    /** Actions configurations */
+    actions?: TCustomConfig['actions'];
+    /** Admin-filtered tools */
+    filteredTools?: string[];
+    /** Admin-included tools */
+    includedTools?: string[];
+    /** Image output type configuration */
+    imageOutputType: string;
+    /** Interface configuration */
+    interfaceConfig?: TCustomConfig['interface'];
+    /** Turnstile configuration */
+    turnstileConfig?: Partial<TCustomConfig['turnstile']>;
+    /** Balance configuration */
+    balance?: Partial<TCustomConfig['balance']>;
+    /** Transactions configuration */
+    transactions?: TCustomConfig['transactions'];
+    /** Speech configuration */
+    speech?: TCustomConfig['speech'];
+    /** MCP server configuration */
+    mcpConfig?: TCustomConfig['mcpServers'] | null;
+    /** File configuration */
+    fileConfig?: TFileConfig;
+    /** Secure image links configuration */
+    secureImageLinks?: TCustomConfig['secureImageLinks'];
+    /** Processed model specifications */
+    modelSpecs?: TCustomConfig['modelSpecs'];
+    /** Available tools */
+    availableTools?: Record<string, FunctionTool>;
+    endpoints?: {
+        /** OpenAI endpoint configuration */
+        openAI?: Partial<TEndpoint>;
+        /** Google endpoint configuration */
+        google?: Partial<TEndpoint>;
+        /** Bedrock endpoint configuration */
+        bedrock?: Partial<TEndpoint>;
+        /** Anthropic endpoint configuration */
+        anthropic?: Partial<TEndpoint>;
+        /** GPT plugins endpoint configuration */
+        gptPlugins?: Partial<TEndpoint>;
+        /** Azure OpenAI endpoint configuration */
+        azureOpenAI?: TAzureConfig;
+        /** Assistants endpoint configuration */
+        assistants?: Partial<TAssistantEndpoint>;
+        /** Azure assistants endpoint configuration */
+        azureAssistants?: Partial<TAssistantEndpoint>;
+        /** Global endpoint configuration */
+        all?: Partial<TEndpoint>;
+    };
+}

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

@@ -25,6 +25,7 @@
 /// <reference types="mongoose/types/inferrawdoctype" />
 import type { Types } from 'mongoose';
 export type ObjectId = Types.ObjectId;
+export * from './app';
 export * from './user';
 export * from './token';
 export * from './convo';
@@ -45,3 +46,4 @@ export * from './prompts';
 export * from './accessRole';
 export * from './aclEntry';
 export * from './group';
+export * from './web';

package/dist/types/types/message.d.ts

@@ -60,6 +60,7 @@ export interface IMessage extends Document {
     content?: unknown[];
     thread_id?: string;
     iconURL?: string;
+    metadata?: Record<string, unknown>;
     attachments?: unknown[];
     expiredAt?: Date;
     createdAt?: Date;

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

@@ -23,6 +23,7 @@
 /// <reference types="mongoose/types/virtuals" />
 /// <reference types="mongoose/types/inferschematype" />
 /// <reference types="mongoose/types/inferrawdoctype" />
+import type { DeepPartial } from 'librechat-data-provider';
 import type { Document } from 'mongoose';
 import { CursorPaginationParams } from '~/common';
 export interface IRole extends Document {
@@ -30,9 +31,6 @@ export interface IRole extends Document {
     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;
@@ -46,4 +44,3 @@ export interface RoleFilterOptions extends CursorPaginationParams {
     search?: string;
     hasPermission?: string;
 }
-export {};

package/dist/types/types/share.d.ts

@@ -32,6 +32,7 @@ export interface ISharedLink {
     user?: string;
     messages?: Types.ObjectId[];
     shareId?: string;
+    targetMessageId?: string;
     isPublic: boolean;
     createdAt?: Date;
     updatedAt?: Date;

package/dist/types/types/web.d.ts

@@ -0,0 +1,3 @@
+import type { SearchCategories } from 'librechat-data-provider';
+export type TWebSearchKeys = 'serperApiKey' | 'searxngInstanceUrl' | 'searxngApiKey' | 'firecrawlApiKey' | 'firecrawlApiUrl' | 'firecrawlVersion' | 'jinaApiKey' | 'jinaApiUrl' | 'cohereApiKey';
+export type TWebSearchCategories = SearchCategories.PROVIDERS | SearchCategories.SCRAPERS | SearchCategories.RERANKERS;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@librechat/data-schemas",
-  "version": "0.0.23",
+  "version": "0.0.30",
   "description": "Mongoose schemas and models for LibreChat",
   "type": "module",
   "main": "dist/index.cjs",
@@ -38,7 +38,7 @@
   "homepage": "https://librechat.ai",
   "devDependencies": {
     "@rollup/plugin-alias": "^5.1.0",
-    "@rollup/plugin-commonjs": "^25.0.2",
+    "@rollup/plugin-commonjs": "^29.0.0",
     "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^15.1.0",
     "@rollup/plugin-replace": "^5.0.5",
@@ -48,10 +48,10 @@
     "@types/express": "^5.0.0",
     "@types/jest": "^29.5.2",
     "@types/node": "^20.3.0",
-    "jest": "^29.5.0",
+    "jest": "^30.2.0",
     "jest-junit": "^16.0.0",
     "mongodb-memory-server": "^10.1.4",
-    "rimraf": "^5.0.1",
+    "rimraf": "^6.1.2",
     "rollup": "^4.22.4",
     "rollup-plugin-peer-deps-external": "^2.2.4",
     "rollup-plugin-typescript2": "^0.35.0",