paperless-ngx/src-ui/src/app/data/paperless-config.ts

import { ObjectWithId } from './object-with-id'

// see /src/paperless/models.py

export enum OutputTypeConfig {
  PDF = 'pdf',
  PDF_A = 'pdfa',
  PDF_A1 = 'pdfa-1',
  PDF_A2 = 'pdfa-2',
  PDF_A3 = 'pdfa-3',
}

export enum ModeConfig {
  AUTO = 'auto',
  FORCE = 'force',
  REDO = 'redo',
  OFF = 'off',
}

export enum ArchiveFileConfig {
  AUTO = 'auto',
  ALWAYS = 'always',
  NEVER = 'never',
}

export enum CleanConfig {
  CLEAN = 'clean',
  FINAL = 'clean-final',
  NONE = 'none',
}

export enum ColorConvertConfig {
  UNCHANGED = 'LeaveColorUnchanged',
  RGB = 'RGB',
  INDEPENDENT = 'UseDeviceIndependentColor',
  GRAY = 'Gray',
  CMYK = 'CMYK',
}

export enum ConfigOptionType {
  String = 'string',
  Number = 'number',
  Select = 'select',
  Boolean = 'boolean',
  JSON = 'json',
  File = 'file',
  Password = 'password',
}

export const ConfigCategory = {
  General: $localize`General Settings`,
  OCR: $localize`OCR Settings`,
  Barcode: $localize`Barcode Settings`,
  AI: $localize`AI Settings`,
}

export const ConfigSection = {
  RemoteOCR: $localize`Remote OCR`,
}

export const LLMEmbeddingBackendConfig = {
  OPENAI_LIKE: 'openai-like',
  HUGGINGFACE: 'huggingface',
  OLLAMA: 'ollama',
}

export const LLMBackendConfig = {
  OPENAI_LIKE: 'openai-like',
  OLLAMA: 'ollama',
}

export const RemoteOCREngineConfig = {
  AZURE_AI: 'azureai',
}

export const RemoteOCRModeConfig = {
  ALWAYS: 'always',
  WORKFLOW_ONLY: 'workflow_only',
}

export interface ConfigOption {
  key: string
  title: string
  type: ConfigOptionType
  choices?: Array<{ id: string; name: string }>
  config_key?: string
  category: string
  section?: string
  note?: string
}

function mapToItems(enumObj: Object): Array<{ id: string; name: string }> {
  return Object.keys(enumObj).map((key) => {
    return {
      id: enumObj[key],
      name: enumObj[key],
    }
  })
}

export const PaperlessConfigOptions: ConfigOption[] = [
  {
    key: 'output_type',
    title: $localize`Output Type`,
    type: ConfigOptionType.Select,
    choices: mapToItems(OutputTypeConfig),
    config_key: 'PAPERLESS_OCR_OUTPUT_TYPE',
    category: ConfigCategory.OCR,
  },
  {
    key: 'language',
    title: $localize`Language`,
    type: ConfigOptionType.String,
    config_key: 'PAPERLESS_OCR_LANGUAGE',
    category: ConfigCategory.OCR,
  },
  {
    key: 'pages',
    title: $localize`Pages`,
    type: ConfigOptionType.Number,
    config_key: 'PAPERLESS_OCR_PAGES',
    category: ConfigCategory.OCR,
  },
  {
    key: 'mode',
    title: $localize`Mode`,
    type: ConfigOptionType.Select,
    choices: mapToItems(ModeConfig),
    config_key: 'PAPERLESS_OCR_MODE',
    category: ConfigCategory.OCR,
  },
  {
    key: 'archive_file_generation',
    title: $localize`Archive File Generation`,
    type: ConfigOptionType.Select,
    choices: mapToItems(ArchiveFileConfig),
    config_key: 'PAPERLESS_ARCHIVE_FILE_GENERATION',
    category: ConfigCategory.OCR,
  },
  {
    key: 'image_dpi',
    title: $localize`Image DPI`,
    type: ConfigOptionType.Number,
    config_key: 'PAPERLESS_OCR_IMAGE_DPI',
    category: ConfigCategory.OCR,
  },
  {
    key: 'unpaper_clean',
    title: $localize`Clean`,
    type: ConfigOptionType.Select,
    choices: mapToItems(CleanConfig),
    config_key: 'PAPERLESS_OCR_CLEAN',
    category: ConfigCategory.OCR,
  },
  {
    key: 'deskew',
    title: $localize`Deskew`,
    type: ConfigOptionType.Boolean,
    config_key: 'PAPERLESS_OCR_DESKEW',
    category: ConfigCategory.OCR,
  },
  {
    key: 'rotate_pages',
    title: $localize`Rotate Pages`,
    type: ConfigOptionType.Boolean,
    config_key: 'PAPERLESS_OCR_ROTATE_PAGES',
    category: ConfigCategory.OCR,
  },
  {
    key: 'rotate_pages_threshold',
    title: $localize`Rotate Pages Threshold`,
    type: ConfigOptionType.Number,
    config_key: 'PAPERLESS_OCR_ROTATE_PAGES_THRESHOLD',
    category: ConfigCategory.OCR,
  },
  {
    key: 'max_image_pixels',
    title: $localize`Max Image Pixels`,
    type: ConfigOptionType.Number,
    config_key: 'PAPERLESS_OCR_MAX_IMAGE_PIXELS',
    category: ConfigCategory.OCR,
  },
  {
    key: 'color_conversion_strategy',
    title: $localize`Color Conversion Strategy`,
    type: ConfigOptionType.Select,
    choices: mapToItems(ColorConvertConfig),
    config_key: 'PAPERLESS_OCR_COLOR_CONVERSION_STRATEGY',
    category: ConfigCategory.OCR,
  },
  {
    key: 'user_args',
    title: $localize`OCR Arguments`,
    type: ConfigOptionType.JSON,
    config_key: 'PAPERLESS_OCR_USER_ARGS',
    category: ConfigCategory.OCR,
  },
  {
    key: 'remote_ocr_engine',
    title: $localize`Remote OCR Engine`,
    type: ConfigOptionType.Select,
    choices: mapToItems(RemoteOCREngineConfig),
    config_key: 'PAPERLESS_REMOTE_OCR_ENGINE',
    category: ConfigCategory.OCR,
    section: ConfigSection.RemoteOCR,
    note: $localize`Enabling remote OCR sends documents to a third-party service for processing. Consider the privacy implications as well as potential costs before enabling.`,
  },
  {
    key: 'remote_ocr_api_key',
    title: $localize`Remote OCR API Key`,
    type: ConfigOptionType.Password,
    config_key: 'PAPERLESS_REMOTE_OCR_API_KEY',
    category: ConfigCategory.OCR,
    section: ConfigSection.RemoteOCR,
  },
  {
    key: 'remote_ocr_endpoint',
    title: $localize`Remote OCR Endpoint`,
    type: ConfigOptionType.String,
    config_key: 'PAPERLESS_REMOTE_OCR_ENDPOINT',
    category: ConfigCategory.OCR,
    section: ConfigSection.RemoteOCR,
    note: $localize`Required when using the Azure AI engine.`,
  },
  {
    key: 'remote_ocr_mode',
    title: $localize`Remote OCR Mode`,
    type: ConfigOptionType.Select,
    choices: mapToItems(RemoteOCRModeConfig),
    config_key: 'PAPERLESS_REMOTE_OCR_MODE',
    category: ConfigCategory.OCR,
    section: ConfigSection.RemoteOCR,
    note: $localize`Which documents are sent to the remote engine. Use 'workflow_only' to keep remote OCR off unless a workflow enables it for a document.`,
  },
  {
    key: 'app_logo',
    title: $localize`Application Logo`,
    type: ConfigOptionType.File,
    config_key: 'PAPERLESS_APP_LOGO',
    category: ConfigCategory.General,
  },
  {
    key: 'app_title',
    title: $localize`Application Title`,
    type: ConfigOptionType.String,
    config_key: 'PAPERLESS_APP_TITLE',
    category: ConfigCategory.General,
  },
  {
    key: 'barcodes_enabled',
    title: $localize`Enable Barcodes`,
    type: ConfigOptionType.Boolean,
    config_key: 'PAPERLESS_CONSUMER_ENABLE_BARCODES',
    category: ConfigCategory.Barcode,
  },
  {
    key: 'barcode_enable_tiff_support',
    title: $localize`Enable TIFF Support`,
    type: ConfigOptionType.Boolean,
    config_key: 'PAPERLESS_CONSUMER_BARCODE_TIFF_SUPPORT',
    category: ConfigCategory.Barcode,
  },
  {
    key: 'barcode_string',
    title: $localize`Barcode String`,
    type: ConfigOptionType.String,
    config_key: 'PAPERLESS_CONSUMER_BARCODE_STRING',
    category: ConfigCategory.Barcode,
  },
  {
    key: 'barcode_retain_split_pages',
    title: $localize`Retain Split Pages`,
    type: ConfigOptionType.Boolean,
    config_key: 'PAPERLESS_CONSUMER_BARCODE_RETAIN_SPLIT_PAGES',
    category: ConfigCategory.Barcode,
  },
  {
    key: 'barcode_enable_asn',
    title: $localize`Enable ASN`,
    type: ConfigOptionType.Boolean,
    config_key: 'PAPERLESS_CONSUMER_ENABLE_ASN_BARCODE',
    category: ConfigCategory.Barcode,
  },
  {
    key: 'barcode_asn_prefix',
    title: $localize`ASN Prefix`,
    type: ConfigOptionType.String,
    config_key: 'PAPERLESS_CONSUMER_ASN_BARCODE_PREFIX',
    category: ConfigCategory.Barcode,
  },
  {
    key: 'barcode_upscale',
    title: $localize`Upscale`,
    type: ConfigOptionType.Number,
    config_key: 'PAPERLESS_CONSUMER_BARCODE_UPSCALE',
    category: ConfigCategory.Barcode,
  },
  {
    key: 'barcode_dpi',
    title: $localize`DPI`,
    type: ConfigOptionType.Number,
    config_key: 'PAPERLESS_CONSUMER_BARCODE_DPI',
    category: ConfigCategory.Barcode,
  },
  {
    key: 'barcode_max_pages',
    title: $localize`Max Pages`,
    type: ConfigOptionType.Number,
    config_key: 'PAPERLESS_CONSUMER_BARCODE_MAX_PAGES',
    category: ConfigCategory.Barcode,
  },
  {
    key: 'barcode_enable_tag',
    title: $localize`Enable Tag Detection`,
    type: ConfigOptionType.Boolean,
    config_key: 'PAPERLESS_CONSUMER_ENABLE_TAG_BARCODE',
    category: ConfigCategory.Barcode,
  },
  {
    key: 'barcode_tag_mapping',
    title: $localize`Tag Mapping`,
    type: ConfigOptionType.JSON,
    config_key: 'PAPERLESS_CONSUMER_TAG_BARCODE_MAPPING',
    category: ConfigCategory.Barcode,
  },
  {
    key: 'barcode_tag_split',
    title: $localize`Split on Tag Barcodes`,
    type: ConfigOptionType.Boolean,
    config_key: 'PAPERLESS_CONSUMER_TAG_BARCODE_SPLIT',
    category: ConfigCategory.Barcode,
  },
  {
    key: 'barcode_store_values',
    title: $localize`Store Barcode Contents`,
    type: ConfigOptionType.Boolean,
    config_key: 'PAPERLESS_CONSUMER_STORE_BARCODE_VALUES',
    category: ConfigCategory.Barcode,
  },
  {
    key: 'ai_enabled',
    title: $localize`AI Enabled`,
    type: ConfigOptionType.Boolean,
    config_key: 'PAPERLESS_AI_ENABLED',
    category: ConfigCategory.AI,
    note: $localize`Consider privacy implications when enabling AI features, especially if using a remote model.`,
  },
  {
    key: 'llm_embedding_backend',
    title: $localize`LLM Embedding Backend`,
    type: ConfigOptionType.Select,
    choices: mapToItems(LLMEmbeddingBackendConfig),
    config_key: 'PAPERLESS_AI_LLM_EMBEDDING_BACKEND',
    category: ConfigCategory.AI,
  },
  {
    key: 'llm_embedding_model',
    title: $localize`LLM Embedding Model`,
    type: ConfigOptionType.String,
    config_key: 'PAPERLESS_AI_LLM_EMBEDDING_MODEL',
    category: ConfigCategory.AI,
  },
  {
    key: 'llm_embedding_api_key',
    title: $localize`LLM Embedding API Key`,
    type: ConfigOptionType.Password,
    note: $localize`Used for embeddings when set, otherwise LLM API key is used.`,
    config_key: 'PAPERLESS_AI_LLM_EMBEDDING_API_KEY',
    category: ConfigCategory.AI,
  },
  {
    key: 'llm_embedding_endpoint',
    title: $localize`LLM Embedding Endpoint`,
    type: ConfigOptionType.String,
    config_key: 'PAPERLESS_AI_LLM_EMBEDDING_ENDPOINT',
    category: ConfigCategory.AI,
  },
  {
    key: 'llm_embedding_chunk_size',
    title: $localize`LLM Embedding Chunk Size`,
    type: ConfigOptionType.Number,
    config_key: 'PAPERLESS_AI_LLM_EMBEDDING_CHUNK_SIZE',
    category: ConfigCategory.AI,
  },
  {
    key: 'llm_context_size',
    title: $localize`LLM Context Size`,
    type: ConfigOptionType.Number,
    config_key: 'PAPERLESS_AI_LLM_CONTEXT_SIZE',
    category: ConfigCategory.AI,
  },
  {
    key: 'llm_backend',
    title: $localize`LLM Backend`,
    type: ConfigOptionType.Select,
    choices: mapToItems(LLMBackendConfig),
    config_key: 'PAPERLESS_AI_LLM_BACKEND',
    category: ConfigCategory.AI,
  },
  {
    key: 'llm_model',
    title: $localize`LLM Model`,
    type: ConfigOptionType.String,
    config_key: 'PAPERLESS_AI_LLM_MODEL',
    category: ConfigCategory.AI,
  },
  {
    key: 'llm_api_key',
    title: $localize`LLM API Key`,
    type: ConfigOptionType.Password,
    config_key: 'PAPERLESS_AI_LLM_API_KEY',
    category: ConfigCategory.AI,
  },
  {
    key: 'llm_endpoint',
    title: $localize`LLM Endpoint`,
    type: ConfigOptionType.String,
    config_key: 'PAPERLESS_AI_LLM_ENDPOINT',
    category: ConfigCategory.AI,
  },
  {
    key: 'llm_output_language',
    title: $localize`LLM Output Language`,
    type: ConfigOptionType.String,
    config_key: 'PAPERLESS_AI_LLM_OUTPUT_LANGUAGE',
    category: ConfigCategory.AI,
    note: $localize`Language to use for generated AI suggestions. When unset, AI suggestions use the user's display language if explicitly set.`,
  },
  {
    key: 'llm_request_timeout',
    title: $localize`LLM Request Timeout`,
    type: ConfigOptionType.Number,
    config_key: 'PAPERLESS_AI_LLM_REQUEST_TIMEOUT',
    category: ConfigCategory.AI,
    note: $localize`Timeout in seconds for LLM requests.`,
  },
]

export interface PaperlessConfig extends ObjectWithId {
  externally_configured_variables: string[]
  output_type: OutputTypeConfig
  pages: number
  language: string
  mode: ModeConfig
  archive_file_generation: ArchiveFileConfig
  image_dpi: number
  unpaper_clean: CleanConfig
  deskew: boolean
  rotate_pages: boolean
  rotate_pages_threshold: number
  max_image_pixels: number
  color_conversion_strategy: ColorConvertConfig
  user_args: object
  app_logo: string
  app_title: string
  barcodes_enabled: boolean
  barcode_enable_tiff_support: boolean
  barcode_string: string
  barcode_retain_split_pages: boolean
  barcode_enable_asn: boolean
  barcode_asn_prefix: string
  barcode_upscale: number
  barcode_dpi: number
  barcode_max_pages: number
  barcode_enable_tag: boolean
  barcode_tag_mapping: object
  barcode_tag_split: boolean
  barcode_store_values: boolean
  remote_ocr_engine: string
  remote_ocr_api_key: string
  remote_ocr_endpoint: string
  remote_ocr_mode: string
  ai_enabled: boolean
  llm_embedding_backend: string
  llm_embedding_model: string
  llm_embedding_api_key: string
  llm_embedding_endpoint: string
  llm_embedding_chunk_size: number
  llm_context_size: number
  llm_backend: string
  llm_model: string
  llm_api_key: string
  llm_endpoint: string
  llm_output_language: string
  llm_request_timeout: number
}