process.env.NODE_ENV === "development" ? require("dotenv").config({ path: `.env.${process.env.NODE_ENV}` }) : require("dotenv").config(); const { default: slugify } = require("slugify"); const { isValidUrl, safeJsonParse } = require("../utils/http"); const prisma = require("../utils/prisma"); const { MetaGenerator } = require("../utils/boot/MetaGenerator"); const { PGVector } = require("../utils/vectorDbProviders/pgvector"); const { NativeEmbedder } = require("../utils/EmbeddingEngines/native"); const { getBaseLLMProviderModel } = require("../utils/helpers"); const { ConnectionStringParser, } = require("../utils/agents/aibitat/plugins/sql-agent/SQLConnectors/utils"); function isNullOrNaN(value) { if (value === null) return true; return isNaN(value); } const SystemSettings = { /** A default system prompt that is used when no other system prompt is set or available to the function caller. */ saneDefaultSystemPrompt: "Given the following conversation, relevant context, and a follow up question, reply with an answer to the current question the user is asking. Return only your response to the question given the above information following the users instructions as needed.", protectedFields: ["multi_user_mode", "hub_api_key", "onboarding_complete"], publicFields: [ "footer_data", "support_email", "text_splitter_chunk_size", "text_splitter_chunk_overlap", "max_embed_chunk_size", "agent_search_provider", "agent_sql_connections", "default_agent_skills", "disabled_agent_skills", "disabled_filesystem_skills", "imported_agent_skills", "custom_app_name", "feature_flags", "meta_page_title", "meta_page_favicon", ], supportedFields: [ "logo_filename", "telemetry_id", "footer_data", "support_email", "text_splitter_chunk_size", "text_splitter_chunk_overlap", "agent_search_provider", "default_agent_skills", "disabled_agent_skills", "disabled_filesystem_skills", "agent_sql_connections", "custom_app_name", "default_system_prompt", // Meta page customization "meta_page_title", "meta_page_favicon", // beta feature flags "experimental_live_file_sync", // Hub settings "hub_api_key", ], validations: { footer_data: (updates) => { try { const array = JSON.parse(updates) .filter((setting) => isValidUrl(setting.url)) .slice(0, 3); // max of 3 items in footer. return JSON.stringify(array); } catch { console.error(`Failed to run validation function on footer_data`); return JSON.stringify([]); } }, text_splitter_chunk_size: (update) => { try { if (isNullOrNaN(update)) throw new Error("Value is not a number."); if (Number(update) <= 0) throw new Error("Value must be non-zero."); const { purgeEntireVectorCache } = require("../utils/files"); purgeEntireVectorCache(); return Number(update); } catch (e) { console.error( `Failed to run validation function on text_splitter_chunk_size`, e.message ); return 1000; } }, text_splitter_chunk_overlap: (update) => { try { if (isNullOrNaN(update)) throw new Error("Value is not a number"); if (Number(update) < 0) throw new Error("Value cannot be less than 0."); const { purgeEntireVectorCache } = require("../utils/files"); purgeEntireVectorCache(); return Number(update); } catch (e) { console.error( `Failed to run validation function on text_splitter_chunk_overlap`, e.message ); return 20; } }, agent_search_provider: (update) => { try { if (update === "none") return null; if ( ![ "google-search-engine", "serpapi", "searchapi", "serper-dot-dev", "bing-search", "serply-engine", "searxng-engine", "tavily-search", "duckduckgo-engine", "exa-search", "perplexity-search", ].includes(update) ) throw new Error("Invalid SERP provider."); return String(update); } catch (e) { console.error( `Failed to run validation function on agent_search_provider`, e.message ); return null; } }, default_agent_skills: (updates) => { try { const skills = updates.split(",").filter((skill) => !!skill); return JSON.stringify(skills); } catch { console.error(`Could not validate agent skills.`); return JSON.stringify([]); } }, disabled_agent_skills: (updates) => { try { const skills = updates.split(",").filter((skill) => !!skill); return JSON.stringify(skills); } catch { console.error(`Could not validate disabled agent skills.`); return JSON.stringify([]); } }, disabled_filesystem_skills: (updates) => { try { const skills = updates.split(",").filter((skill) => !!skill); return JSON.stringify(skills); } catch { console.error(`Could not validate disabled filesystem skills.`); return JSON.stringify([]); } }, agent_sql_connections: async (updates) => { const existingConnections = safeJsonParse( (await SystemSettings.get({ label: "agent_sql_connections" }))?.value, [] ); try { const updatedConnections = mergeConnections( existingConnections, safeJsonParse(updates, []) ); return JSON.stringify(updatedConnections); } catch { console.error(`Failed to merge connections`); return JSON.stringify(existingConnections ?? []); } }, experimental_live_file_sync: (update) => { if (typeof update === "boolean") return update === true ? "enabled" : "disabled"; if (!["enabled", "disabled"].includes(update)) return "disabled"; return String(update); }, meta_page_title: (newTitle) => { try { if (typeof newTitle !== "string" || !newTitle) return null; return String(newTitle); } catch { return null; } finally { new MetaGenerator().clearConfig(); } }, meta_page_favicon: (faviconUrl) => { if (!faviconUrl) return null; try { const url = new URL(faviconUrl); return url.toString(); } catch { return null; } finally { new MetaGenerator().clearConfig(); } }, hub_api_key: (apiKey) => { if (!apiKey) return null; return String(apiKey); }, default_system_prompt: (prompt) => { if (typeof prompt !== "string" || !prompt) return null; if (prompt.trim() === SystemSettings.saneDefaultSystemPrompt) return SystemSettings.saneDefaultSystemPrompt; return String(prompt.trim()); }, }, currentSettings: async function () { const { hasVectorCachedFiles } = require("../utils/files"); const { ToolReranker, } = require("../utils/agents/aibitat/utils/toolReranker"); const AIbitat = require("../utils/agents/aibitat"); const llmProvider = process.env.LLM_PROVIDER; const vectorDB = process.env.VECTOR_DB; const embeddingEngine = process.env.EMBEDDING_ENGINE ?? "native"; return { // -------------------------------------------------------- // General Settings // -------------------------------------------------------- RequiresAuth: !!process.env.AUTH_TOKEN, AuthToken: !!process.env.AUTH_TOKEN, JWTSecret: !!process.env.JWT_SECRET, StorageDir: process.env.STORAGE_DIR, MultiUserMode: await this.isMultiUserMode(), DisableTelemetry: process.env.DISABLE_TELEMETRY || "false", // -------------------------------------------------------- // Embedder Provider Selection Settings & Configs // -------------------------------------------------------- EmbeddingEngine: embeddingEngine, HasExistingEmbeddings: await this.hasEmbeddings(), // check if they have any currently embedded documents active in workspaces. HasCachedEmbeddings: hasVectorCachedFiles(), // check if they any currently cached embedded docs. EmbeddingBasePath: process.env.EMBEDDING_BASE_PATH, EmbeddingModelPref: embeddingEngine === "native" ? NativeEmbedder._getEmbeddingModel() : process.env.EMBEDDING_MODEL_PREF, EmbeddingOutputDimensions: process.env.EMBEDDING_OUTPUT_DIMENSIONS || null, EmbeddingModelMaxChunkLength: process.env.EMBEDDING_MODEL_MAX_CHUNK_LENGTH, OllamaEmbeddingBatchSize: process.env.OLLAMA_EMBEDDING_BATCH_SIZE || 1, VoyageAiApiKey: !!process.env.VOYAGEAI_API_KEY, GenericOpenAiEmbeddingApiKey: !!process.env.GENERIC_OPEN_AI_EMBEDDING_API_KEY, GenericOpenAiEmbeddingMaxConcurrentChunks: process.env.GENERIC_OPEN_AI_EMBEDDING_MAX_CONCURRENT_CHUNKS || 500, GeminiEmbeddingApiKey: !!process.env.GEMINI_EMBEDDING_API_KEY, // -------------------------------------------------------- // VectorDB Provider Selection Settings & Configs // -------------------------------------------------------- VectorDB: vectorDB, ...this.vectorDBPreferenceKeys(), // -------------------------------------------------------- // LLM Provider Selection Settings & Configs // -------------------------------------------------------- LLMProvider: llmProvider, LLMModel: getBaseLLMProviderModel({ provider: llmProvider }) || null, ...this.llmPreferenceKeys(), // -------------------------------------------------------- // Whisper (Audio transcription) Selection Settings & Configs // - Currently the only 3rd party is OpenAI, so is OPEN_AI_KEY is set // - then it can be shared. // -------------------------------------------------------- WhisperProvider: process.env.WHISPER_PROVIDER || "local", WhisperModelPref: process.env.WHISPER_MODEL_PREF || "Xenova/whisper-small", // -------------------------------------------------------- // TTS/STT Selection Settings & Configs // - Currently the only 3rd party is OpenAI or the native browser-built in // -------------------------------------------------------- TextToSpeechProvider: process.env.TTS_PROVIDER || "native", TTSOpenAIKey: !!process.env.TTS_OPEN_AI_KEY, TTSOpenAIVoiceModel: process.env.TTS_OPEN_AI_VOICE_MODEL, // Eleven Labs TTS TTSElevenLabsKey: !!process.env.TTS_ELEVEN_LABS_KEY, TTSElevenLabsVoiceModel: process.env.TTS_ELEVEN_LABS_VOICE_MODEL, // Piper TTS TTSPiperTTSVoiceModel: process.env.TTS_PIPER_VOICE_MODEL ?? "en_US-hfc_female-medium", // OpenAI Generic TTS TTSOpenAICompatibleKey: !!process.env.TTS_OPEN_AI_COMPATIBLE_KEY, TTSOpenAICompatibleModel: process.env.TTS_OPEN_AI_COMPATIBLE_MODEL, TTSOpenAICompatibleVoiceModel: process.env.TTS_OPEN_AI_COMPATIBLE_VOICE_MODEL, TTSOpenAICompatibleEndpoint: process.env.TTS_OPEN_AI_COMPATIBLE_ENDPOINT, // -------------------------------------------------------- // Agent Settings & Configs // -------------------------------------------------------- AgentSerpApiKey: !!process.env.AGENT_SERPAPI_API_KEY || null, AgentSerpApiEngine: process.env.AGENT_SERPAPI_ENGINE || "google", AgentSearchApiKey: !!process.env.AGENT_SEARCHAPI_API_KEY || null, AgentSearchApiEngine: process.env.AGENT_SEARCHAPI_ENGINE || "google", AgentSerperApiKey: !!process.env.AGENT_SERPER_DEV_KEY || null, AgentBingSearchApiKey: !!process.env.AGENT_BING_SEARCH_API_KEY || null, AgentSerplyApiKey: !!process.env.AGENT_SERPLY_API_KEY || null, AgentSearXNGApiUrl: process.env.AGENT_SEARXNG_API_URL || null, AgentTavilyApiKey: !!process.env.AGENT_TAVILY_API_KEY || null, AgentExaApiKey: !!process.env.AGENT_EXA_API_KEY || null, AgentPerplexityApiKey: !!process.env.AGENT_PERPLEXITY_API_KEY || null, // -------------------------------------------------------- // Compliance Settings // -------------------------------------------------------- // Disable View Chat History for the whole instance. DisableViewChatHistory: "DISABLE_VIEW_CHAT_HISTORY" in process.env || false, // -------------------------------------------------------- // Simple SSO Settings // -------------------------------------------------------- SimpleSSOEnabled: "SIMPLE_SSO_ENABLED" in process.env || false, SimpleSSONoLogin: "SIMPLE_SSO_NO_LOGIN" in process.env || false, SimpleSSONoLoginRedirect: this.simpleSSO.noLoginRedirect(), // -------------------------------------------------------- // Agent Skill Settings // -------------------------------------------------------- AgentSkillMaxToolCalls: AIbitat.defaultMaxToolCalls(), AgentSkillRerankerEnabled: ToolReranker.isEnabled(), AgentSkillRerankerTopN: ToolReranker.getTopN(), }; }, get: async function (clause = {}) { try { const setting = await prisma.system_settings.findFirst({ where: clause }); return setting || null; } catch (error) { console.error(error.message); return null; } }, getValueOrFallback: async function (clause = {}, fallback = null) { try { return (await this.get(clause))?.value ?? fallback; } catch (error) { console.error(error.message); return fallback; } }, where: async function (clause = {}, limit) { try { const settings = await prisma.system_settings.findMany({ where: clause, take: limit || undefined, }); return settings; } catch (error) { console.error(error.message); return []; } }, // Can take generic keys and will pre-filter invalid keys // from the set before sending to the explicit update function // that will then enforce validations as well. updateSettings: async function (updates = {}) { const validFields = Object.keys(updates).filter((key) => this.supportedFields.includes(key) ); Object.entries(updates).forEach(([key]) => { if (validFields.includes(key)) return; delete updates[key]; }); return this._updateSettings(updates); }, // Explicit update of settings + key validations. // Only use this method when directly setting a key value // that takes no user input for the keys being modified. _updateSettings: async function (updates = {}) { try { const updatePromises = []; for (const key of Object.keys(updates)) { let validatedValue = updates[key]; if (this.validations.hasOwnProperty(key)) { if (this.validations[key].constructor.name === "AsyncFunction") { validatedValue = await this.validations[key](updates[key]); } else { validatedValue = this.validations[key](updates[key]); } } updatePromises.push( prisma.system_settings.upsert({ where: { label: key }, update: { value: validatedValue === null ? null : String(validatedValue), }, create: { label: key, value: validatedValue === null ? null : String(validatedValue), }, }) ); } await Promise.all(updatePromises); return { success: true, error: null }; } catch (error) { console.error("FAILED TO UPDATE SYSTEM SETTINGS", error.message); return { success: false, error: error.message }; } }, isMultiUserMode: async function () { try { const setting = await this.get({ label: "multi_user_mode" }); return setting?.value === "true"; } catch (error) { console.error(error.message); return false; } }, isOnboardingComplete: async function () { try { const setting = await this.get({ label: "onboarding_complete" }); return setting?.value === "true"; } catch (error) { console.error(error.message); return false; } }, markOnboardingComplete: async function () { try { await this._updateSettings({ onboarding_complete: true }); const { Telemetry } = require("./telemetry"); await Telemetry.sendTelemetry("onboarding_complete"); return true; } catch (error) { console.error(error.message); return false; } }, currentLogoFilename: async function () { try { const setting = await this.get({ label: "logo_filename" }); return setting?.value || null; } catch (error) { console.error(error.message); return null; } }, hasEmbeddings: async function () { try { const { Document } = require("./documents"); const count = await Document.count({}, 1); return count > 0; } catch (error) { console.error(error.message); return false; } }, vectorDBPreferenceKeys: function () { return { // Pinecone DB Keys PineConeKey: !!process.env.PINECONE_API_KEY, PineConeIndex: process.env.PINECONE_INDEX, // Chroma DB Keys ChromaEndpoint: process.env.CHROMA_ENDPOINT, ChromaApiHeader: process.env.CHROMA_API_HEADER, ChromaApiKey: !!process.env.CHROMA_API_KEY, // ChromaCloud DB Keys ChromaCloudApiKey: !!process.env.CHROMACLOUD_API_KEY, ChromaCloudTenant: process.env.CHROMACLOUD_TENANT, ChromaCloudDatabase: process.env.CHROMACLOUD_DATABASE, // Weaviate DB Keys WeaviateEndpoint: process.env.WEAVIATE_ENDPOINT, WeaviateApiKey: !!process.env.WEAVIATE_API_KEY, // QDrant DB Keys QdrantEndpoint: process.env.QDRANT_ENDPOINT, QdrantApiKey: !!process.env.QDRANT_API_KEY, // Milvus DB Keys MilvusAddress: process.env.MILVUS_ADDRESS, MilvusUsername: process.env.MILVUS_USERNAME, MilvusPassword: !!process.env.MILVUS_PASSWORD, // Zilliz DB Keys ZillizEndpoint: process.env.ZILLIZ_ENDPOINT, ZillizApiToken: !!process.env.ZILLIZ_API_TOKEN, // AstraDB Keys AstraDBApplicationToken: !!process?.env?.ASTRA_DB_APPLICATION_TOKEN, AstraDBEndpoint: process?.env?.ASTRA_DB_ENDPOINT, // PGVector Keys PGVectorConnectionString: !!PGVector.connectionString() || false, PGVectorTableName: PGVector.tableName(), }; }, llmPreferenceKeys: function () { return { // OpenAI Keys OpenAiKey: !!process.env.OPEN_AI_KEY, OpenAiModelPref: process.env.OPEN_MODEL_PREF || "gpt-4o", // Azure + OpenAI Keys AzureOpenAiEndpoint: process.env.AZURE_OPENAI_ENDPOINT, AzureOpenAiKey: !!process.env.AZURE_OPENAI_KEY, AzureOpenAiModelPref: process.env.AZURE_OPENAI_MODEL_PREF || process.env.OPEN_MODEL_PREF, AzureOpenAiEmbeddingModelPref: process.env.EMBEDDING_MODEL_PREF, AzureOpenAiTokenLimit: process.env.AZURE_OPENAI_TOKEN_LIMIT || 4096, AzureOpenAiModelType: process.env.AZURE_OPENAI_MODEL_TYPE || "default", // Anthropic Keys AnthropicApiKey: !!process.env.ANTHROPIC_API_KEY, AnthropicModelPref: process.env.ANTHROPIC_MODEL_PREF || "claude-2", AnthropicCacheControl: process.env.ANTHROPIC_CACHE_CONTROL || "none", // Gemini Keys GeminiLLMApiKey: !!process.env.GEMINI_API_KEY, GeminiLLMModelPref: process.env.GEMINI_LLM_MODEL_PREF || "gemini-2.0-flash-lite", GeminiSafetySetting: process.env.GEMINI_SAFETY_SETTING || "BLOCK_MEDIUM_AND_ABOVE", // LMStudio Keys LMStudioBasePath: process.env.LMSTUDIO_BASE_PATH, LMStudioTokenLimit: process.env.LMSTUDIO_MODEL_TOKEN_LIMIT || null, LMStudioModelPref: process.env.LMSTUDIO_MODEL_PREF, LMStudioAuthToken: !!process.env.LMSTUDIO_AUTH_TOKEN, // LocalAI Keys LocalAiApiKey: !!process.env.LOCAL_AI_API_KEY, LocalAiBasePath: process.env.LOCAL_AI_BASE_PATH, LocalAiModelPref: process.env.LOCAL_AI_MODEL_PREF, LocalAiTokenLimit: process.env.LOCAL_AI_MODEL_TOKEN_LIMIT, // Ollama LLM Keys OllamaLLMAuthToken: !!process.env.OLLAMA_AUTH_TOKEN, OllamaLLMBasePath: process.env.OLLAMA_BASE_PATH, OllamaLLMModelPref: process.env.OLLAMA_MODEL_PREF, OllamaLLMTokenLimit: process.env.OLLAMA_MODEL_TOKEN_LIMIT || null, OllamaLLMKeepAliveSeconds: process.env.OLLAMA_KEEP_ALIVE_TIMEOUT ?? 300, // Novita LLM Keys NovitaLLMApiKey: !!process.env.NOVITA_LLM_API_KEY, NovitaLLMModelPref: process.env.NOVITA_LLM_MODEL_PREF, NovitaLLMTimeout: process.env.NOVITA_LLM_TIMEOUT_MS, // TogetherAI Keys TogetherAiApiKey: !!process.env.TOGETHER_AI_API_KEY, TogetherAiModelPref: process.env.TOGETHER_AI_MODEL_PREF, // Fireworks AI API Keys FireworksAiLLMApiKey: !!process.env.FIREWORKS_AI_LLM_API_KEY, FireworksAiLLMModelPref: process.env.FIREWORKS_AI_LLM_MODEL_PREF, // Perplexity AI Keys PerplexityApiKey: !!process.env.PERPLEXITY_API_KEY, PerplexityModelPref: process.env.PERPLEXITY_MODEL_PREF, // OpenRouter Keys OpenRouterApiKey: !!process.env.OPENROUTER_API_KEY, OpenRouterModelPref: process.env.OPENROUTER_MODEL_PREF, OpenRouterTimeout: process.env.OPENROUTER_TIMEOUT_MS, // Mistral AI (API) Keys MistralApiKey: !!process.env.MISTRAL_API_KEY, MistralModelPref: process.env.MISTRAL_MODEL_PREF, // Groq AI API Keys GroqApiKey: !!process.env.GROQ_API_KEY, GroqModelPref: process.env.GROQ_MODEL_PREF, // HuggingFace Dedicated Inference HuggingFaceLLMEndpoint: process.env.HUGGING_FACE_LLM_ENDPOINT, HuggingFaceLLMAccessToken: !!process.env.HUGGING_FACE_LLM_API_KEY, HuggingFaceLLMTokenLimit: process.env.HUGGING_FACE_LLM_TOKEN_LIMIT, // KoboldCPP Keys KoboldCPPModelPref: process.env.KOBOLD_CPP_MODEL_PREF, KoboldCPPBasePath: process.env.KOBOLD_CPP_BASE_PATH, KoboldCPPTokenLimit: process.env.KOBOLD_CPP_MODEL_TOKEN_LIMIT, KoboldCPPMaxTokens: process.env.KOBOLD_CPP_MAX_TOKENS, // Text Generation Web UI Keys TextGenWebUIBasePath: process.env.TEXT_GEN_WEB_UI_BASE_PATH, TextGenWebUITokenLimit: process.env.TEXT_GEN_WEB_UI_MODEL_TOKEN_LIMIT, TextGenWebUIAPIKey: !!process.env.TEXT_GEN_WEB_UI_API_KEY, // LiteLLM Keys LiteLLMModelPref: process.env.LITE_LLM_MODEL_PREF, LiteLLMTokenLimit: process.env.LITE_LLM_MODEL_TOKEN_LIMIT, LiteLLMBasePath: process.env.LITE_LLM_BASE_PATH, LiteLLMApiKey: !!process.env.LITE_LLM_API_KEY, // Moonshot AI Keys MoonshotAiApiKey: !!process.env.MOONSHOT_AI_API_KEY, MoonshotAiModelPref: process.env.MOONSHOT_AI_MODEL_PREF || "moonshot-v1-32k", // Generic OpenAI Keys GenericOpenAiBasePath: process.env.GENERIC_OPEN_AI_BASE_PATH, GenericOpenAiModelPref: process.env.GENERIC_OPEN_AI_MODEL_PREF, GenericOpenAiTokenLimit: process.env.GENERIC_OPEN_AI_MODEL_TOKEN_LIMIT, GenericOpenAiKey: !!process.env.GENERIC_OPEN_AI_API_KEY, GenericOpenAiMaxTokens: process.env.GENERIC_OPEN_AI_MAX_TOKENS, // Foundry Keys FoundryBasePath: process.env.FOUNDRY_BASE_PATH, FoundryModelPref: process.env.FOUNDRY_MODEL_PREF, FoundryModelTokenLimit: process.env.FOUNDRY_MODEL_TOKEN_LIMIT, AwsBedrockLLMConnectionMethod: process.env.AWS_BEDROCK_LLM_CONNECTION_METHOD || "iam", AwsBedrockLLMAccessKeyId: !!process.env.AWS_BEDROCK_LLM_ACCESS_KEY_ID, AwsBedrockLLMAccessKey: !!process.env.AWS_BEDROCK_LLM_ACCESS_KEY, AwsBedrockLLMSessionToken: !!process.env.AWS_BEDROCK_LLM_SESSION_TOKEN, AwsBedrockLLMAPIKey: !!process.env.AWS_BEDROCK_LLM_API_KEY, AwsBedrockLLMRegion: process.env.AWS_BEDROCK_LLM_REGION, AwsBedrockLLMModel: process.env.AWS_BEDROCK_LLM_MODEL_PREFERENCE, AwsBedrockLLMTokenLimit: process.env.AWS_BEDROCK_LLM_MODEL_TOKEN_LIMIT || 8192, AwsBedrockLLMMaxOutputTokens: process.env.AWS_BEDROCK_LLM_MAX_OUTPUT_TOKENS || 4096, // Cohere API Keys CohereApiKey: !!process.env.COHERE_API_KEY, CohereModelPref: process.env.COHERE_MODEL_PREF, // DeepSeek API Keys DeepSeekApiKey: !!process.env.DEEPSEEK_API_KEY, DeepSeekModelPref: process.env.DEEPSEEK_MODEL_PREF, // APIPie LLM API Keys ApipieLLMApiKey: !!process.env.APIPIE_LLM_API_KEY, ApipieLLMModelPref: process.env.APIPIE_LLM_MODEL_PREF, // xAI LLM API Keys XAIApiKey: !!process.env.XAI_LLM_API_KEY, XAIModelPref: process.env.XAI_LLM_MODEL_PREF, // NVIDIA NIM Keys NvidiaNimLLMBasePath: process.env.NVIDIA_NIM_LLM_BASE_PATH, NvidiaNimLLMModelPref: process.env.NVIDIA_NIM_LLM_MODEL_PREF, NvidiaNimLLMTokenLimit: process.env.NVIDIA_NIM_LLM_MODEL_TOKEN_LIMIT, // PPIO API keys PPIOApiKey: !!process.env.PPIO_API_KEY, PPIOModelPref: process.env.PPIO_MODEL_PREF, // Dell Pro AI Studio Keys DellProAiStudioBasePath: process.env.DPAIS_LLM_BASE_PATH, DellProAiStudioModelPref: process.env.DPAIS_LLM_MODEL_PREF, DellProAiStudioTokenLimit: process.env.DPAIS_LLM_MODEL_TOKEN_LIMIT ?? 4096, // CometAPI LLM Keys CometApiLLMApiKey: !!process.env.COMETAPI_LLM_API_KEY, CometApiLLMModelPref: process.env.COMETAPI_LLM_MODEL_PREF, CometApiLLMTimeout: process.env.COMETAPI_LLM_TIMEOUT_MS, // Z.AI Keys ZAiApiKey: !!process.env.ZAI_API_KEY, ZAiModelPref: process.env.ZAI_MODEL_PREF, // GiteeAI API Keys GiteeAIApiKey: !!process.env.GITEE_AI_API_KEY, GiteeAIModelPref: process.env.GITEE_AI_MODEL_PREF, GiteeAITokenLimit: process.env.GITEE_AI_MODEL_TOKEN_LIMIT || 8192, // Docker Model Runner Keys DockerModelRunnerBasePath: process.env.DOCKER_MODEL_RUNNER_BASE_PATH, DockerModelRunnerModelPref: process.env.DOCKER_MODEL_RUNNER_LLM_MODEL_PREF, DockerModelRunnerModelTokenLimit: process.env.DOCKER_MODEL_RUNNER_LLM_MODEL_TOKEN_LIMIT || 8192, // Privatemode Keys PrivateModeBasePath: process.env.PRIVATEMODE_LLM_BASE_PATH, PrivateModeModelPref: process.env.PRIVATEMODE_LLM_MODEL_PREF, // SambaNova Keys SambaNovaLLMApiKey: !!process.env.SAMBANOVA_LLM_API_KEY, SambaNovaLLMModelPref: process.env.SAMBANOVA_LLM_MODEL_PREF, // Lemonade Keys LemonadeLLMBasePath: process.env.LEMONADE_LLM_BASE_PATH, LemonadeLLMModelPref: process.env.LEMONADE_LLM_MODEL_PREF, LemonadeLLMModelTokenLimit: process.env.LEMONADE_LLM_MODEL_TOKEN_LIMIT || 8192, }; }, agent_sql_connections: async function () { const setting = await SystemSettings.get({ label: "agent_sql_connections", }); if (!setting) return []; const connections = safeJsonParse(setting.value, []).map((conn) => { let scheme = conn.engine; if (scheme === "sql-server") scheme = "mssql"; if (scheme === "postgresql") scheme = "postgres"; const parser = new ConnectionStringParser({ scheme }); const parsed = parser.parse(conn.connectionString); return { ...conn, username: parsed.username, password: parsed.password, host: parsed.hosts?.[0]?.host, port: parsed.hosts?.[0]?.port, database: parsed.endpoint, scheme: parsed.scheme, }; }); return connections; }, getFeatureFlags: async function () { return { experimental_live_file_sync: (await SystemSettings.get({ label: "experimental_live_file_sync" })) ?.value === "enabled", }; }, /** * Get user configured Community Hub Settings * Connection key is used to authenticate with the Community Hub API * for your account. * @returns {Promise<{connectionKey: string}>} */ hubSettings: async function () { try { const hubKey = await this.get({ label: "hub_api_key" }); return { connectionKey: hubKey?.value || null }; } catch (error) { console.error(error.message); return { connectionKey: null }; } }, simpleSSO: { /** * Gets the no login redirect URL. If the conditions below are not met, this will return null. * - If simple SSO is not enabled. * - If simple SSO login page is not disabled. * - If the no login redirect is not a valid URL or is not set. * @returns {string | null} */ noLoginRedirect: () => { if (!("SIMPLE_SSO_ENABLED" in process.env)) return null; // if simple SSO is not enabled, return null if (!("SIMPLE_SSO_NO_LOGIN" in process.env)) return null; // if the no login config is not set, return null if (!("SIMPLE_SSO_NO_LOGIN_REDIRECT" in process.env)) return null; // if the no login redirect is not set, return null try { let url = new URL(process.env.SIMPLE_SSO_NO_LOGIN_REDIRECT); return url.toString(); } catch {} // if the no login redirect is not a valid URL or is not set, return null return null; }, }, }; /** * Merges SQL connection updates from the frontend with existing backend connections. * Processes three types of actions: "remove", "update", and "add". * * @param {Array} existingConnections - Current connections stored in the database * @param {Array} updates - Connection updates from frontend, each with an action property * @returns {Array} - The merged connections array */ function mergeConnections(existingConnections = [], updates = []) { const connectionsMap = new Map( existingConnections.map((conn) => [conn.database_id, conn]) ); for (const update of updates) { const { action, database_id, originalDatabaseId, connectionString, engine, schema, } = update; switch (action) { case "remove": { connectionsMap.delete(database_id); break; } case "update": { if (!connectionString) continue; const newId = slugify(database_id); // Verify original connection exists if (!connectionsMap.has(originalDatabaseId)) { console.warn( `[mergeConnections] Update skipped: Original connection "${originalDatabaseId}" not found` ); break; } // Check for name conflict (excluding the one being updated) if (newId !== originalDatabaseId && connectionsMap.has(newId)) { console.warn( `[mergeConnections] Update skipped: New name "${newId}" conflicts with existing connection` ); break; } // Remove old and add updated connection connectionsMap.delete(originalDatabaseId); connectionsMap.set(newId, { engine, database_id: newId, connectionString, ...(schema && { schema }), }); break; } case "add": { if (!connectionString) continue; const slugifiedId = slugify(database_id); // Skip if already exists if (connectionsMap.has(slugifiedId)) { console.warn( `[mergeConnections] Add skipped: Connection "${slugifiedId}" already exists` ); break; } connectionsMap.set(slugifiedId, { engine, database_id: slugifiedId, connectionString, ...(schema && { schema }), }); break; } default: { throw new Error("SQL connection update contains an invalid action."); } } } return Array.from(connectionsMap.values()); } module.exports.SystemSettings = SystemSettings;