gradido/config/src/commonSchema.ts

import Joi from 'joi'

export const browserUrls = Joi.array()
  .items(Joi.string().uri()) 
  .sparse(true)
  .custom((value: string[], helpers: Joi.CustomHelpers<string[]>) => {
    let protocol: string | undefined
    for (const url of value) {
      if (url === undefined) { 
        continue 
      }
      const urlObject = new URL(url)
      if(!protocol) {
        protocol = urlObject.protocol
      } else if(urlObject.protocol !== protocol) {
        return helpers.error('any.invalid')
      }
    }
    return value;
  })
  .required()
  .description('All URLs need to have same protocol to prevent mixed block errors')

export const DECAY_START_TIME = Joi.date()
  .iso() // ISO 8601 format for date validation
  .description('The start time for decay, expected in ISO 8601 format (e.g. 2021-05-13T17:46:31Z)')
  .default(new Date('2021-05-13T17:46:31Z')) // default to the specified date if not provided
  .required()

export const DB_VERSION = Joi.string()
  .pattern(/^\d{4}-[a-z0-9-_]+$/)
  .message('DB_VERSION must be in the format: YYYY-description, e.g. "0087-add_index_on_user_roles".')
  .description('db version string, last migration file name without ending or last folder in entity')
  .required()

export const COMMUNITY_URL = Joi.string()
  .uri({ scheme: ['http', 'https'] })
  .custom((value: string, helpers: Joi.CustomHelpers<string>) => {
    if (value.endsWith('/')) {
      return helpers.error('any.invalid', { message: 'URL should not end with a slash (/)' })
    }
    return value;
  })
  .description('The base URL of the community, should have the same protocol as frontend, admin and backend api to prevent mixed contend issues.')
  .default('http://0.0.0.0')
  .required()

export const GRAPHQL_URI = Joi.string()
  .uri({ scheme: ['http', 'https'] })
  .description(
    `
    The external URL of the backend service,
    accessible from outside the server (e.g., via Nginx or the server's public URL),
    should have the same protocol as frontend and admin to prevent mixed contend issues.
  `,
  )
  .default('http://0.0.0.0/graphql')
  .required()

export const COMMUNITY_NAME = Joi.string()
  .min(3)
  .max(40)
  .description('The name of the community')
  .default('Gradido Entwicklung')
  .required()  

export const COMMUNITY_DESCRIPTION = Joi.string()
  .min(10)
  .max(255)
  .description('A short description of the community')
  .default('Die lokale Entwicklungsumgebung von Gradido.')
  .required()

export const COMMUNITY_SUPPORT_MAIL = Joi.string()
  .email()
  .description('The support email address for the community will be used in frontend and E-Mails')
  .default('support@supportmail.com')
  .required()

export const COMMUNITY_LOCATION = Joi.string()
  .pattern(/^[-+]?[0-9]{1,2}(\.[0-9]+)?,\s?[-+]?[0-9]{1,3}(\.[0-9]+)?$/)
  .when('GMS_ACTIVE', {
    is: true,
    then: Joi.string().required(),
    otherwise: Joi.string().optional()
  })
  .description('Geographical location of the community in "latitude, longitude" format')
  .default('49.280377, 9.690151')    
  
export const GRAPHIQL = Joi.boolean()
    .description('Flag for enabling GraphQL playground for debugging.')
    .default(false)
    .when('NODE_ENV', {
      is: 'development',
      then: Joi.boolean().valid(true, false).required(), // only allow true in development mode
      otherwise: Joi.boolean().valid(false).required() // false in any other mode
    })

export const GMS_ACTIVE = Joi.boolean()
  .description('Flag to indicate if the GMS (Geographic Member Search) service is used.')
  .default(false)
  .required()

export const GDT_ACTIVE = Joi.boolean()
  .description('Flag to indicate if the GMS (Geographic Member Search) service is used.')
  .default(false)
  .required()

export const GDT_API_URL = Joi.string()
  .uri({ scheme: ['http', 'https'] })
  .default('https://gdt.gradido.net')
  .when('GDT_ACTIVE', { is: true, then: Joi.required() })
  .description('The URL for GDT API endpoint')

export const HUMHUB_ACTIVE = Joi.boolean()
  .description('Flag to indicate if the HumHub based Community Server is used.')
  .default(false)
  .required()

export const HUMHUB_API_URL = Joi.string()
  .uri({ scheme: ['http', 'https'] })
  .when('HUMHUB_ACTIVE', { is: true, then: Joi.required(), otherwise: Joi.optional() })
  .description('The API URL for HumHub integration')

export const LOG_LEVEL = Joi.string()
  .valid('all', 'mark', 'trace', 'debug', 'info', 'warn', 'error', 'fatal', 'off') 
  .description('set log level')
  .default('info')
  .required()

export const LOG4JS_CONFIG = Joi.string()
  .pattern(/^[a-zA-Z0-9-_]+\.json$/) 
  .message('LOG4JS_CONFIG must be a valid filename ending with .json')
  .description('config file name for log4js config file')
  .default('log4js-config.json')
  .required()

export const LOGIN_APP_SECRET = Joi.string()
  .pattern(/^[a-fA-F0-9]+$/) 
  .message('need to be valid hex')
  .default('21ffbbc616fe')
  .description('App secret for salt component for libsodium crypto_pwhash')
  .required()

export const LOGIN_SERVER_KEY = Joi.string()
  .pattern(/^[a-fA-F0-9]+$/)
  .length(32)
  .message('need to be valid hex and 32 character')
  .default('a51ef8ac7ef1abf162fb7a65261acd7a')
  .description('Server key for password hashing as additional salt for libsodium crypto_shorthash_keygen')
  .required()

export const OPENAI_ACTIVE = Joi.boolean()
  .default(false)
  .description('Flag to enable or disable OpenAI API')
  .required()

export const TYPEORM_LOGGING_RELATIVE_PATH = Joi.string()
  .pattern(new RegExp('^[a-zA-Z0-9-_\./]+\.log$')) 
  .message('TYPEORM_LOGGING_RELATIVE_PATH must be a valid filename ending with .log')
  .description('log file name for logging typeorm activities')
  .default('typeorm.log')
  .required()

export const DB_HOST = Joi.string()
  .hostname()
  .message('must be a valid host with alphanumeric characters, numbers, points and -')
  .description("database host like 'localhost' or 'mariadb' in docker setup")
  .default('localhost')
  .required()
  
export const DB_PORT = Joi.number()
  .integer()
  .min(1024)
  .max(49151)
  .description('database port, default: 3306')
  .default(3306)
  .required()

export const DB_USER = Joi.string()
  .pattern(/^[A-Za-z0-9]([A-Za-z0-9-_\.]*[A-Za-z0-9])?$/) // Validates MariaDB username rules
  .min(1)  // Minimum length 1
  .max(16) // Maximum length 16
  .message(
    'Valid database username (letters, numbers, hyphens, underscores, dots allowed; no spaces, must not start or end with hyphen, dot, or underscore)'
  )
  .description('database username for mariadb')
  .default('root')
  .required()

export const DB_PASSWORD = Joi.string()
  .when(Joi.ref('NODE_ENV'), {
    is: 'development',
    then: Joi.string().allow(''), 
    otherwise: Joi.string()
      .min(8) 
      .max(32)
      .pattern(/^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)(?=.*[!@#$%^&*(),.?":{}|<>]).+$/)
      .message(
        'Password must be between 8 and 32 characters long, and contain at least one uppercase letter, one lowercase letter, one number, and one special character (e.g., !@#$%^&*).'
      )
  })
  .description(
    'Password for the database user. In development mode, an empty password is allowed. In other environments, a complex password is required.'
  )
  .default('') 
  .required()

export const DB_DATABASE = Joi.string()
  .pattern(/^[a-zA-Z][a-zA-Z0-9_-]{1,63}$/)
  .description('Database name like gradido_community (must start with a letter, and can only contain letters, numbers, underscores, or dashes)')
  .default('gradido_community')
  .required()

export const APP_VERSION = Joi.string()
  .pattern(/^\d+\.\d+\.\d+$/)
  .message('Version must be in the format "major.minor.patch" (e.g., "2.4.1")')
  .description('App Version from package.json, alle modules share one version')
  .required()

export const BUILD_COMMIT = Joi.string()
  .pattern(/^[0-9a-f]{40}$/)
  .message('The commit hash must be a 40-character hexadecimal string.')
  .description('The full git commit hash.')    
  .optional()

export const BUILD_COMMIT_SHORT = Joi.string()
  .pattern(/^[0-9a-f]{7}$/)
  .message('The first 7 hexadecimal character from git commit hash.')
  .description('A short version from the git commit hash.')    
  .required()

export const NODE_ENV = Joi.string()
  .valid('production', 'development', 'test')
  .default('development')
  .description('Specifies the environment in which the application is running.')

export const DEBUG = Joi.boolean()
  .description('Indicates whether the application is in debugging mode. Set to true when NODE_ENV is not "production".')
  .default(false)
  .required()
  
export const PRODUCTION = Joi.boolean()
  .default(false)
  .description('Indicates whether the application is running in production mode. Set to true when NODE_ENV is "production".')
  .required()