The minimalistic document archiving platform.
refactor(ai): centralize adapter names in constants (#1287)
Corentin Thomassetdae7d9931ac3
diff --git a/apps/papra-server/src/modules/ai/adapters/ai-adapters.constants.ts b/apps/papra-server/src/modules/ai/adapters/ai-adapters.constants.tsnew file mode 100644index 00000000..3e7f4a2c--- /dev/null+++ b/apps/papra-server/src/modules/ai/adapters/ai-adapters.constants.ts@@ -0,0 +1,8 @@+export const AI_ADAPTERS = {+ ollama: 'ollama',+ openai: 'openai',+ mistral: 'mistral',+} as const;++export const AI_ADAPTERS_NAMES = Object.values(AI_ADAPTERS);+export type AiAdapterName = (typeof AI_ADAPTERS_NAMES)[number];diff --git a/apps/papra-server/src/modules/ai/adapters/ai-adapters.registry.ts b/apps/papra-server/src/modules/ai/adapters/ai-adapters.registry.tsindex 6a82f150..a3d25e60 100644--- a/apps/papra-server/src/modules/ai/adapters/ai-adapters.registry.ts+++ b/apps/papra-server/src/modules/ai/adapters/ai-adapters.registry.ts@@ -1,14 +1,16 @@import { objectKeys } from '@papra/std';import type { AiAdapterFactory } from './ai-adapters.types';-import { buildOllamaAdapter, OLLAMA_ADAPTER_NAME } from './ollama/ollama.ai-adapters';-import { buildOpenAiAdapter, OPENAI_ADAPTER_NAME } from './openai/openai.ai-adapters';-import { buildMistralAdapter, MISTRAL_ADAPTER_NAME } from './mistral/mistral.ai-adapters';+import { buildOllamaAdapter } from './ollama/ollama.ai-adapters';+import { buildOpenAiAdapter } from './openai/openai.ai-adapters';+import { buildMistralAdapter } from './mistral/mistral.ai-adapters';+import type { AiAdapterName } from './ai-adapters.constants';+import { AI_ADAPTERS } from './ai-adapters.constants';export const modelAdapterFactories = {- [OLLAMA_ADAPTER_NAME]: buildOllamaAdapter,- [OPENAI_ADAPTER_NAME]: buildOpenAiAdapter,- [MISTRAL_ADAPTER_NAME]: buildMistralAdapter,-} satisfies Record<string, AiAdapterFactory>;+ [AI_ADAPTERS.ollama]: buildOllamaAdapter,+ [AI_ADAPTERS.openai]: buildOpenAiAdapter,+ [AI_ADAPTERS.mistral]: buildMistralAdapter,+} satisfies Record<AiAdapterName, AiAdapterFactory>;export const modelAdapterNames = objectKeys(modelAdapterFactories);diff --git a/apps/papra-server/src/modules/ai/adapters/ai-adapters.types.ts b/apps/papra-server/src/modules/ai/adapters/ai-adapters.types.tsindex 8e883670..bd62700a 100644--- a/apps/papra-server/src/modules/ai/adapters/ai-adapters.types.ts+++ b/apps/papra-server/src/modules/ai/adapters/ai-adapters.types.ts@@ -4,7 +4,6 @@ import type { Config } from '../../config/config.types';export type AiTextAdapter = AnyTextAdapter;export type AiAdapter = {- name: string;getTextAdapter: (args: { modelName: string }) => AiTextAdapter;};diff --git a/apps/papra-server/src/modules/ai/adapters/mistral/mistral.ai-adapters.ts b/apps/papra-server/src/modules/ai/adapters/mistral/mistral.ai-adapters.tsindex 5c7678c7..925e85d5 100644--- a/apps/papra-server/src/modules/ai/adapters/mistral/mistral.ai-adapters.ts+++ b/apps/papra-server/src/modules/ai/adapters/mistral/mistral.ai-adapters.ts@@ -2,14 +2,10 @@ import type { Config } from '../../../config/config.types';import type { AiAdapter } from '../ai-adapters.types';import { buildOpenAiCompatibleTextAdapter } from '../openai/openai-compatible.ai-adapters';-export const MISTRAL_ADAPTER_NAME = 'mistral';-export function buildMistralAdapter({ config }: { config: Config }): AiAdapter {const adapterConfig = config.ai.adapters.mistral;return {- name: MISTRAL_ADAPTER_NAME,-getTextAdapter: buildOpenAiCompatibleTextAdapter(adapterConfig),};}diff --git a/apps/papra-server/src/modules/ai/adapters/ollama/ollama.ai-adapters.ts b/apps/papra-server/src/modules/ai/adapters/ollama/ollama.ai-adapters.tsindex ee376e5d..48a430d3 100644--- a/apps/papra-server/src/modules/ai/adapters/ollama/ollama.ai-adapters.ts+++ b/apps/papra-server/src/modules/ai/adapters/ollama/ollama.ai-adapters.ts@@ -2,14 +2,10 @@ import type { Config } from '../../../config/config.types';import type { AiAdapter } from '../ai-adapters.types';import { buildOpenAiCompatibleTextAdapter } from '../openai/openai-compatible.ai-adapters';-export const OLLAMA_ADAPTER_NAME = 'ollama';-export function buildOllamaAdapter({ config }: { config: Config }): AiAdapter {const adapterConfig = config.ai.adapters.ollama;return {- name: OLLAMA_ADAPTER_NAME,-getTextAdapter: buildOpenAiCompatibleTextAdapter(adapterConfig),};}diff --git a/apps/papra-server/src/modules/ai/adapters/openai/openai.ai-adapters.ts b/apps/papra-server/src/modules/ai/adapters/openai/openai.ai-adapters.tsindex 0b5598cf..4e4639db 100644--- a/apps/papra-server/src/modules/ai/adapters/openai/openai.ai-adapters.ts+++ b/apps/papra-server/src/modules/ai/adapters/openai/openai.ai-adapters.ts@@ -2,14 +2,10 @@ import type { Config } from '../../../config/config.types';import type { AiAdapter } from '../ai-adapters.types';import { buildOpenAiCompatibleTextAdapter } from './openai-compatible.ai-adapters';-export const OPENAI_ADAPTER_NAME = 'openai';-export function buildOpenAiAdapter({ config }: { config: Config }): AiAdapter {const adapterConfig = config.ai.adapters.openai;return {- name: OPENAI_ADAPTER_NAME,-getTextAdapter: buildOpenAiCompatibleTextAdapter(adapterConfig),};}diff --git a/apps/papra-server/src/modules/ai/ai.config.ts b/apps/papra-server/src/modules/ai/ai.config.tsindex 64ec09d0..2693b9ca 100644--- a/apps/papra-server/src/modules/ai/ai.config.ts+++ b/apps/papra-server/src/modules/ai/ai.config.ts@@ -1,11 +1,12 @@import { aiModelIdSchema } from './ai.schemas';import { booleanishSchema } from '../config/config.schemas';import type { AppConfigDefinition } from '../config/config.types';+import * as v from 'valibot';import { AI_DEFAULT_MODEL_ENV_KEY } from './ai.constants';import { ollamaAdapterConfig } from './adapters/ollama/ollama.ai-adapters.config';import { openAiAdapterConfig } from './adapters/openai/openai.ai-adapters.config';-import { OPENAI_ADAPTER_NAME } from './adapters/openai/openai.ai-adapters';import { mistralAdapterConfig } from './adapters/mistral/mistral.ai-adapters.config';+import { AI_ADAPTERS, AI_ADAPTERS_NAMES } from './adapters/ai-adapters.constants';export const aiConfig = {isEnabled: {@@ -21,14 +22,14 @@ export const aiConfig = {mistral: mistralAdapterConfig,},defaultAdapterName: {- doc: `Default AI adapter to use when no specific adapter is specified in the model id.`,- schema: aiModelIdSchema,+ doc: `Default AI adapter to use when no specific adapter is specified in the model id. Available adapters: ${AI_ADAPTERS_NAMES.join(', ')}`,+ schema: v.picklist(AI_ADAPTERS_NAMES),env: 'AI_DEFAULT_ADAPTER',- default: OPENAI_ADAPTER_NAME,+ default: AI_ADAPTERS.openai,showInDocumentation: false,},defaultModelId: {- doc: 'Default AI model to use when no specific model is specified, the format is <adapterId>://<modelName>, e.g. "ollama://llama3.1:8b". The adapterId can be omitted, like "llama3.1:8b", in which case the default adapter will be used. The modelName is adapter-specific.',+ doc: 'Default AI model to use when no specific model is specified, the format is <adapterId>://<modelName>, e.g. "ollama://llama3.1:8b". The adapterId can be omitted, like "llama3.1:8b", in which case the default adapter will be used.',schema: aiModelIdSchema,env: AI_DEFAULT_MODEL_ENV_KEY,default: 'unknown',