stackme.sh

#!/usr/bin/env bash

# Disable canonical mode, set immediate input
stty -icanon min 1 time 0

# Ensure terminal settings are restored on script exit
trap 'stty sane; exit' SIGINT SIGTERM EXIT

export TERM=xterm-256color

############################### BEGIN OF DISPLAY-RELATED CONSTANTS ############################

# Define colors with consistent names
declare -A COLORS=(
  [yellow]="\e[33m"
  [light_yellow]="\e[93m"
  [green]="\e[32m"
  [light_green]="\e[92m"
  [white]="\e[97m"
  [beige]="\e[93m"
  [red]="\e[91m"
  [light_red]="\e[31m"
  [blue]="\e[34m"
  [light_blue]="\e[94m"
  [cyan]="\e[36m"
  [light_cyan]="\e[96m"
  [magenta]="\e[35m"
  [light_magenta]="\e[95m"
  [black]="\e[30m"
  [gray]="\e[90m"
  [dark_gray]="\e[37m"
  [light_gray]="\x1b[38;5;245m"
  [orange]="\x1b[38;5;214m"
  [purple]="\x1b[38;5;99m"
  [pink]="\x1b[38;5;200m"
  [brown]="\x1b[38;5;94m"
  [teal]="\x1b[38;5;80m"
  [gold]="\x1b[38;5;220m"
  [lime]="\x1b[38;5;154m"
  [reset]="\e[0m"
)

# Define text styles
declare -A STYLES=(
  [bold]="\e[1m"
  [dim]="\e[2m"
  [italic]="\e[3m"
  [underline]="\e[4m"
  [hidden]="\e[8m"
  [reverse]="\e[7m"
  [strikethrough]="\e[9m"
  [double_underline]="\e[21m"
  [overline]="\x1b[53m"
  [bold_italic]="\e[1m\e[3m"
  [underline_bold]="\e[4m\e[1m"
  [dim_italic]="\e[2m\e[3m"
  [reset]="\e[0m"
)

# Dictionary of arrows
declare -A ARROWS=(
  ["simple"]="→"
  ["sharp"]="➜"
  ["double"]="⇒"
  ["curved"]="↪"
  ["dash"]="➳"
  ["star"]="⋆"
  ["angle"]="▸"
  ["triangle_filled"]="▲"
  ["triangle"]="△"
  ["small_square_filled"]="▪"
  ["medium_empty_square"]="□"
  ["big_empty_square"]="▢"
  ["filled_square"]="■"
  ["square_filled_empty"]="▣"
  ["horiz_crossed_square"]="▤"
  ["vert_crossed_square"]="▥"
  ["crossed_square"]="▦"
  ["diag_square"]="▧"
  ["diag_crossed_square"]="▨"
  ["diamond"]="◆"
  ["cross"]="✗"
  ["dot"]="•"
  ["circle_filled"]="●"
  ["circle_empty"]="○"
  ["circle_filled_empty"]="⊙"
  ["circle_empty_filled"]="⊚"
)

# Highlight and color variables for styling keyboard options
highlight_color="\033[1;32m" # Highlight color (Bright Green)
faded_color="\033[2m"        # Faded color (Dark gray)
select_color="\033[1;34m"    # Blue for select (↵)
warning_color="\033[1;33m"   # Warning color (Yellow)
back_color="\033[2m"         # Magenta for return (r)
quit_color="\033[1;31m"      # Red for quit (q)
exit_color="\033[1;31m"      # Exit color (x)
search_color="\033[1;36m"    # Search color (/)
goto_color="\033[1;36m"      # Go-to page color (g)
help_color="\033[1;35m"      # Help color (h)
error_color="\033[1;31m"     # Error color (Dark red)
title_color="\033[1;36m"     # Title color (Cyan)
reset_color="\033[0m"        # Reset color

# Color definitions for styling
bold="\033[1m"
red="\033[31m"
green="\033[32m"
yellow="\033[33m"
blue="\033[34m"
magenta="\033[35m"
cyan="\033[35m"
normal="\033[0m"

# Define arrow keys for navigation
up_key="[A"    # Up Arrow
down_key="[B"  # Down Arrow
left_key="[D"  # Left Arrow
right_key="[C" # Right Arrow

# Default menu options
TRUNCATED_DEFAULT_LENGTH=50
HAS_TIMESTAMP=true
HEADER_LENGTH=120

# Define a global associative array for storing menu items and stacks
declare -A MENUS
declare -A STACKS

# Define a global array for storing navigation history
menu_navigation_history=()

# PID of the currently running process
current_pid=0

# Default arrow
USER_DEFINED_ARROW=""
DEFAULT_ARROW_OPTION='angle'

# Default page size
DEFAULT_PAGE_SIZE=5

DEFAULT_DISK_THREHOLD=85

############################## END OF DISPLAY-RELATED CONSTANTS ################################

########################### BEGIN OF DEPLOYMENT-RELATED CONSTANTS ##############################

# Tools constants
TOOL_NAME="StackMe"

TOOL_LOGO_URL="https://raw.githubusercontent.com/whosbash/stackme/main/images/stackme_tiny.png"
TOOL_REPOSITORY_URL='https://github.com/whosbash/stackme'
TOOL_STACKS_TEMPLATE_URL="https://api.github.com/repos/whosbash/stackme/contents/stacks"
TOOL_STACKS_OBJECT_URL="https://raw.githubusercontent.com/whosbash/stackme/main/stacks/stacks.json"

TOOL_BASE_DIR="/opt/stackme"
TOOL_STACKS_DIR="$TOOL_BASE_DIR/stacks"
TOOL_TEMPLATES_DIR="$TOOL_BASE_DIR/templates"

############################ END OF DEPLOYMENT-RELATED CONSTANTS #############################

############################# BEGIN OF DISPLAY-RELATED FUNCTIONS #############################

# Function to display a message with improved formatting
display() {
  local type="$1"
  local text="$2"
  local timestamp="${3:-$HAS_TIMESTAMP}"

  echo -e "$(format "$type" "$text" $timestamp)"
}

# Function to apply color and style to a string, even if it contains existing color codes
colorize() {
  local text="$1"
  local color_name=$(echo "$2" | tr '[:upper:]' '[:lower:]')
  local style_name=$(echo "$3" | tr '[:upper:]' '[:lower:]')

  # Remove any existing ANSI escape sequences (colors or styles) from the text
  text=$(strip_color "$text")

  # Get color code, default to reset if not found
  local color_code="${COLORS[$color_name]:-${COLORS[reset]}}"

  # If no style name is provided, use "reset" style as default
  if [[ -z "$style_name" ]]; then
    local style_code="${STYLES[reset]}"
  else
    local style_code="${STYLES[$style_name]:-${STYLES[reset]}}"
  fi

  # Print the text with the chosen color and style
  echo -e "${style_code}${color_code}${text}${STYLES[reset]}${COLORS[reset]}"
}

get_status_icon() {
  local type="$1"

  case "$type" in
  "success") echo "🌟" ;;   # Bright star for success
  "error") echo "🔥" ;;     # Fire icon for error
  "warning") echo "⚠️" ;;  # Lightning for warning
  "info") echo "💡" ;;      # Light bulb for info
  "highlight") echo "🌈" ;; # Rainbow for highlight
  "debug") echo "🔍" ;;     # Magnifying glass for debug
  "critical") echo "💀" ;;  # Skull for critical
  "note") echo "📌" ;;      # Pushpin for note
  "important") echo "⚡" ;; # Rocket for important
  "hold_on") echo "⌛" ;;      # Hourglass for waiting
  "question") echo "🤔" ;;  # Thinking face for question
  "celebrate") echo "🎉" ;; # Party popper for celebration
  "progress") echo "📈" ;;  # Upwards chart for progress
  "failure") echo "💔" ;;   # Broken heart for failure
  "tip") echo "🍀" ;;       # Four-leaf clover for additional success
  *) echo "🌀" ;;           # Cyclone for undefined type
  esac
}

# Function to get the color code based on the message type
get_status_color() {
  local type="$1"

  case "$type" in
  "success") echo "green" ;;          # Green for success
  "error") echo "light_red" ;;        # Light Red for error
  "warning") echo "yellow" ;;         # Yellow for warning
  "info") echo "teal" ;;              # White for info
  "highlight") echo "cyan" ;;         # Cyan for highlight
  "debug") echo "blue" ;;             # Blue for debug
  "critical") echo "light_magenta" ;; # Light Magenta for critical
  "note") echo "pink" ;;              # Gray for note
  "important") echo "gold" ;;         # Orange for important
  "hold_on") echo "light_yellow" ;;      # Light Yellow for waiting
  "question") echo "purple" ;;        # Purple for question
  "celebrate") echo "green" ;;        # Green for celebration
  "progress") echo "lime" ;;          # Blue for progress
  "failure") echo "light_red" ;;      # Red for failure
  "tip") echo "light_cyan" ;;         # Light Green for tips
  *) echo "white" ;;                  # Default to white for unknown types
  esac
}

# Function to get the style code based on the message type
get_status_style() {
  local type="$1"

  case "$type" in
  "success") echo "bold" ;;                      # Bold for success
  "info") echo "italic" ;;                       # Italic for info
  "error") echo "bold,italic" ;;                 # Bold and italic for errors
  "critical") echo "bold,underline" ;;           # Bold and underline for critical
  "warning") echo "italic" ;;                    # Underline for warnings
  "highlight") echo "bold,underline" ;;          # Bold and underline for highlights
  "hold_on") echo "dim,italic" ;;                   # Dim and italic for pending
  "important") echo "bold,underline,overline" ;; # Bold, underline, overline for important
  "question") echo "italic,underline" ;;         # Italic and underline for questions
  "celebrate") echo "bold" ;;                    # Bold for celebration
  "progress") echo "italic" ;;                   # Italic for progress
  "failure") echo "bold,italic" ;;               # Bold and italic for failure
  "tip") echo "bold,italic" ;;                   # Bold and italic for tips
  *) echo "normal" ;;                            # Default to normal style for unknown types
  esac
}

# Function to colorize a message based on its type
colorize_by_type() {
  local type="$1"
  local text="$2"

  local color="$(get_status_color "$type")"
  local style="$(get_status_style "$type")"

  colorize "$text" "$color" "$style"
}

# Function to format a message
format() {
  local type="$1"                            # Message type (success, error, etc.)
  local text="$2"                            # Message text
  local has_timestamp="${3:-$HAS_TIMESTAMP}" # Option to display timestamp (default is false)

  # Get icon based on status
  local icon
  icon=$(get_status_icon "$type")

  local color
  color=$(get_status_color "$type")

  # Add timestamp if enabled
  local timestamp=""
  if [ "$has_timestamp" = true ]; then
    timestamp="[$(date '+%Y-%m-%d %H:%M:%S')] "
    # Only colorize the timestamp
    timestamp="$(colorize "$timestamp" "$color" "normal")"
  fi

  # Colorize the main message
  local colorized_message
  colorized_message="$(colorize_by_type "$type" "$text")"

  # Display the message with icon, timestamp, and colorized message
  echo -e "$icon $timestamp$colorized_message"
}

# Function to format an array of messages
format_array() {
  local type="$1"
  local -n arr="$2" # Use reference to the array

  for i in "${!arr[@]}"; do
    # Apply format to each message in the array
    arr[$i]=$(format "$type" "${arr[$i]}")
  done
}

# Function to display styled and optionally centered text with custom or terminal width
display_text() {
  local text="$1"             # The text to display
  local custom_width="$2"     # Custom width for the text
  local padding=0             # Optional padding around the text
  local center=false          # Set to true to center the text
  local style="${bold_color}" # Optional style (e.g., bold or colored)

  # Check if additional options are provided
  shift 2 # Skip the first two arguments (text and custom_width)
  while [[ $# -gt 0 ]]; do
    case "$1" in
    --center) center=true ;;
    --style)
      style="$2"
      shift
      ;;
    --padding)
      padding="$2"
      shift
      ;;
    *)
      echo "Unknown option: $1" >&2
      return 1
      ;;
    esac
    shift
  done

  # If custom width is not provided, use terminal width (tput cols)
  if [[ -z "$custom_width" ]]; then
    custom_width=$(tput cols)
  fi

  # Ensure padding is valid
  if ((padding < 0)); then
    error "Padding must be non-negative."
    return 1
  fi

  # Calculate text length with padding
  local padded_text=$(printf "%${padding}s%s%${padding}s" "" "$text" "")
  local text_length=${#padded_text}

  # Ensure the custom width is at least the length of the text
  if ((custom_width < text_length)); then
    error "Custom width ($custom_width) is smaller than text length ($text_length)."
    return 1
  fi

  # Center the text if needed
  if [[ "$center" == true ]]; then
    local left_padding=$(((custom_width - text_length) / 2))
    padded_text=$(printf "%${left_padding}s%s" "" "$padded_text")
  fi

  # Ensure the text fits within the custom width
  local final_text=$(printf "%-${custom_width}s" "$padded_text")

  # Apply styling and display
  echo -e "${style}${final_text}${reset_color}"
  echo # Newline

  return 0
}

# Function to display success formatted messages
success() {
  local message="$1"                     # Step message
  local timestamp="${2:-$HAS_TIMESTAMP}" # Optional timestamp flag
  display 'success' "$message" $timestamp >&2
}

# Function to display error formatted messages
error() {
  local message="$1"                       # Step message
  local timestamp=""${2:-$HAS_TIMESTAMP}"" # Optional timestamp flag
  display 'error' "$message" $timestamp >&2
}

# Function to display warning formatted messages
warning() {
  local message="$1"                       # Step message
  local timestamp=""${2:-$HAS_TIMESTAMP}"" # Optional timestamp flag
  display 'warning' "$message" $timestamp >&2
}

# Function to display info formatted messages
info() {
  local message="$1"                       # Step message
  local timestamp=""${2:-$HAS_TIMESTAMP}"" # Optional timestamp flag
  display 'info' "$message" $timestamp >&2
}

# Function to display highlight formatted messages
highlight() {
  local message="$1"                     # Step message
  local timestamp="${2:-$HAS_TIMESTAMP}" # Optional timestamp flag
  display 'highlight' "$message" $timestamp >&2
}

# Function to display debug formatted messages
debug() {
  local message="$1"                     # Step message
  local timestamp="${2:-$HAS_TIMESTAMP}" # Optional timestamp flag
  display 'debug' "$message" $timestamp >&2
  wait_for_input
}

# Function to display critical formatted messages
critical() {
  local message="$1"                     # Step message
  local timestamp="${2:-$HAS_TIMESTAMP}" # Optional timestamp flag
  display 'critical' "$message" $timestamp >&2
}

# Function to display note formatted messages
note() {
  local message="$1"                     # Step message
  local timestamp="${2:-$HAS_TIMESTAMP}" # Optional timestamp flag
  display 'note' "$message" $timestamp >&2
}

# Function to display important formatted messages
important() {
  local message="$1"                     # Step message
  local timestamp="${2:-$HAS_TIMESTAMP}" # Optional timestamp flag
  display 'important' "$message" $timestamp >&2
}

# Function to display wait formatted messages
hold_on() {
  local message="$1"                     # Step message
  local timestamp="${2:-$HAS_TIMESTAMP}" # Optional timestamp flag
  display 'hold_on' "$message" $timestamp >&2
}

# Function to display wait formatted messages
question() {
  local message="$1"                     # Step message
  local timestamp="${2:-$HAS_TIMESTAMP}" # Optional timestamp flag
  display 'question' "$message" $timestamp >&2
}

# Function to display celebrate formatted messages
celebrate() {
  local message="$1"                     # Step message
  local timestamp="${2:-$HAS_TIMESTAMP}" # Optional timestamp flag
  display 'celebrate' "$message" $timestamp >&2
}

# Function to display progress formatted messages
progress() {
  local message="$1"                     # Step message
  local timestamp="${2:-$HAS_TIMESTAMP}" # Optional timestamp flag
  display 'progress' "$message" $timestamp >&2
}

# Function to display failure formatted messages
failure() {
  local message="$1"                     # Step message
  local timestamp="${2:-$HAS_TIMESTAMP}" # Optional timestamp flag
  display 'failure' "$message" $timestamp >&2
  wait_for_input
}

# Function to display tip formatted messages
tip() {
  local message="$1"                     # Step message
  local timestamp="${2:-$HAS_TIMESTAMP}" # Optional timestamp flag
  display 'tip' "$message" $timestamp >&2
}

# Function to display a step with improved formatting
step() {
  local current_step="$1"                # Current step number
  local total_steps="$2"                 # Total number of steps
  local message="$3"                     # Step message
  local type="${4:-DEFAULT_TYPE}"        # Status type (default to 'info')
  local timestamp="${5:-$HAS_TIMESTAMP}" # Optional timestamp flag

  # If 'timestamp' is passed as an argument, prepend the timestamp to the message
  if [ -n "$timestamp" ]; then
    local formatted_message=$(format "$type" "$step_message" true)
  else
    local formatted_message=$(format "$type" "$step_message" false)
  fi

  # Format the step message with the specified color and style
  local message="[$current_step/$total_steps] $message"
  formatted_message=$(format "$type" "$message" $timestamp)

  # Print the formatted message with the icon and message
  echo -e "$formatted_message" >&2
}

# Function to display step info message
step_info() {
  local current=$1
  local total=$2
  local message="$3"
  local has_timestamp=${4:-$HAS_TIMESTAMP}

  step $current $total "$message" "info" $has_timestamp
}

# Function to display step success message
step_success() {
  local current=$1
  local total=$2
  local message="$3"
  local has_timestamp=${4:-$HAS_TIMESTAMP}

  step $current $total "$message" "success" $has_timestamp
}

# Function to display step failure message
step_failure() {
  local current=$1
  local total=$2
  local message="$3"
  local has_timestamp=${4:-$HAS_TIMESTAMP}

  step $current $total "$message" "failure" $has_timestamp
}

# Function to display step error message
step_error() {
  local current=$1
  local total=$2
  local message="$3"
  local has_timestamp=${4:-$HAS_TIMESTAMP}

  step $current $total "$message" "error" $has_timestamp
}

# Function to display step warning message
step_warning() {
  local current=$1
  local total=$2
  local message="$3"
  local has_timestamp=${4:-$HAS_TIMESTAMP}

  step $current $total "$message" "warning" $has_timestamp
}

# Function to display step success message
step_progress() {
  local current=$1
  local total=$2
  local message="$3"
  local has_timestamp=${4:-$HAS_TIMESTAMP}

  step $current $total "$message" "progress" $has_timestamp
}

stack_step() {
  stack_name="$1"
  type="$2"
  step="$3"
  message="$4"
  stack_message="[$stack_name] $message"
  step $step $total_steps "$stack_message" "$type"
}

stack_step_progress() {
  stack_step "$1" "progress" "$2" "$3"
}

stack_step_warning() {
  stack_step "$1" "warning" "$2" "$3"
}

stack_step_error() {
  stack_step "$1" "error" "$2" "$3"
}

# Function to display a boxed text
boxed_text() {
  local word=${1:-"Hello"}                     # Default word to render
  local text_style=${2:-"highlight"}           # Default text style
  local border_style=${3:-"simple"}            # Default border style
  local font=${4:-"slant"}                     # Default font
  local min_width=${5:-$(($(tput cols) - 28))} # Default minimum width
  local has_timestamp=${6:-$HAS_TIMESTAMP}

  # Ensure `figlet` exists
  if ! command -v figlet &>/dev/null; then
    error "'figlet' command not found. Please install it to use this function."
    return 1
  fi

  # Define the border styles
  declare -A border_styles=(
    ["simple"]="- - | | + + + +"
    ["asterisk"]="* * * * * * * *"
    ["equal"]="= = | | + + + +"
    ["hash"]="# # # # # # # #"
    ["dotted"]=". . . . . . . ."
    ["starred"]="* * * * * * * *"
    ["boxed-dashes"]="- - - - - - - -"
    ["wave"]="~ ~ ~ ~ ~ ~ ~ ~"
    ["angled"]="/ / \\ \\ / \\ \\ /"
    ["arrowed"]="< > ^ v < > ^ v"
    ["zigzag"]="z z Z Z z Z Z z"
    ["spiky"]="x x x x X X X X"
    ["none"]="         "
  )

  # Extract the border characters
  IFS=' ' read -r \
    top_fence bottom_fence left_fence right_fence \
    top_left_corner top_right_corner \
    bottom_left_corner bottom_right_corner <<< \
    "${border_styles[$border_style]:-${border_styles["simple"]}}"

  # Generate ASCII art
  local ascii_art=$(figlet -f "$font" "$word")
  local art_width=$(echo "$ascii_art" | head -n 1 | wc -c)
  art_width=$((art_width - 1)) # Subtract newline

  # Get terminal width and calculate box width
  local terminal_width=$(tput cols)
  local total_width=$((min_width > art_width ? min_width : art_width))
  total_width=$((total_width > (terminal_width - 2) ? (terminal_width - 2) : total_width))

  # Generate borders
  local top_border="${top_left_corner}$(
    printf "%-${total_width}s" | tr ' ' "$top_fence"
  )${top_right_corner}"
  fmt_top_border="$(colorize_by_type "$text_style" "$top_border")"

  local bottom_border="${bottom_left_corner}$(
    printf "%-${total_width}s" | tr ' ' "$bottom_fence"
  )${bottom_right_corner}"
  fmt_bottom_border="$(colorize_by_type "$text_style" "$bottom_border")"

  # Buffer all lines to an array
  local -a lines=()

  # Add the top border
  lines+=("$fmt_top_border")

  while IFS= read -r line; do
      local total_padding=$((total_width - ${#line}))
      local left_padding=$((total_padding / 2))
      local right_padding=$((total_padding - left_padding))  # Ensures total_padding is fully distributed

      line="$(
        printf "%s%*s%s%*s%s" \
          "$left_fence" "$left_padding" "" "$line" "$right_padding" "" "$right_fence"
      )"
      fmt_line="$(colorize_by_type "$text_style" "$line")"
      lines+=("$fmt_line")
  done <<<"$ascii_art"

  # Add the bottom border
  fmt_bottom_border=$(
    colorize_by_type "$text_style" "$bottom_border" 
  )
  lines+=("$fmt_bottom_border")

  # Display the lines in parallel
  display_parallel lines
}

header() {
  local word=${1:-"Hello"}                     # Default word to render
  local text_style=${2:-"highlight"}           # Default text style
  local border_style=${3:-"simple"}            # Default border style
  local font=${4:-"slant"}                     # Default font
  local min_width=${5:-$(($(tput cols) - 28))} # Default minimum width
  local has_timestamp=${6:-false}              # Default has_timestamp

  boxed_text "$word" "$text_style" "$border_style" "$font" "$min_width" "$has_timestamp"
}

rows_count(){
  local text="$1"
  echo "$text" | awk 'END {print NR}'
}

get_header_height() {
  local title="$1"
  local page_width="$2"

  header_string=$(\
    header "$title" "highlight" "simple" "slant" "$page_width" false
  )

  # Height of the header
  header_height=$(rows_count "$header_string")

  echo "$header_height"
}

render_header() {
  local title="$1"
  local page_width="$2"

  header_string=$(\
    header "$title" "highlight" "simple" "slant" "$page_width" false
  )

  echo -e "$header_string" >&2
}

display_header() {
  local title="$1"
  display_text "$title" 40 --center --style "${bold_color}${green}"
}

# Function to set the arrow based on user input
set_arrow() {
  if [[ -n "$USER_DEFINED_ARROW" ]]; then
    # If the user provides an arrow option, validate and set it
    if [[ -n "${ARROWS[$USER_DEFINED_ARROW]}" ]]; then
      ARROW_OPTION="$USER_DEFINED_ARROW"
    else
      # Handle invalid user-defined arrow options
      warning "'$USER_DEFINED_ARROW' is not a valid arrow option."
      echo "Available options: ${!ARROWS[@]}"
      warning "Falling back to default arrow: $DEFAULT_ARROW_OPTION"
      ARROW_OPTION="$DEFAULT_ARROW_OPTION"
      sleep 2
    fi
  else
    ARROW_OPTION="$DEFAULT_ARROW_OPTION"
  fi

  SELECTED_ARROW="${ARROWS[$ARROW_OPTION]}"
  COLORED_ARROW="${highlight_color}${SELECTED_ARROW}${reset_color}"
}

################################## END OF DISPLAY-RELATED FUNCTIONS ###############################

################################## BEGIN OF JSON-RELATED FUNCTIONS ################################

# Recursive function to validate JSON against a schema
validate_json_recursive() {
  local json="$1"
  local schema="$2"
  local parent_path="$3" # Track the JSON path for better error reporting
  local valid=true
  local errors=()

  # Extract required keys and properties from the schema
  local required_keys=$(echo "$schema" | jq -r '.required[]? // empty')
  local properties=$(echo "$schema" | jq -c '.properties // empty')
  local additional_properties=$(
    echo "$schema" |
      jq -r 'if has("additionalProperties") then .additionalProperties else "true" end'
  )

  # Check if required keys are present
  for key in $required_keys; do
    if ! echo "$json" | jq -e ". | has(\"$key\")" >/dev/null; then
      errors+=("Missing required key: ${parent_path}${key}")
      valid=false
    fi
  done

  # Validate each property
  for key in $(echo "$properties" | jq -r 'keys[]'); do
    local expected_type
    local actual_type
    local sub_schema
    local value

    expected_type=$(echo "$properties" | jq -r ".\"$key\".type // empty")
    sub_schema=$(echo "$properties" | jq -c ".\"$key\"")
    value=$(echo "$json" | jq -c ".\"$key\"")
    actual_type=$(echo "$value" | jq -r 'type // empty')

    if [ "$expected_type" = "object" ]; then
      # Recursively validate nested objects
      if [ "$actual_type" = "object" ]; then
        validate_json_recursive "$value" "$sub_schema" "${parent_path}${key}."
      else
        errors+=("Key '${parent_path}${key}' expected type 'object', but got '$actual_type'")
        valid=false
      fi
    elif [ "$expected_type" = "array" ]; then
      # Validate array elements
      validate_array "$value" "$sub_schema" "${parent_path}${key}" errors valid
    else
      # Validate primitive types and handle constraints
      validate_primitive "$value" "$sub_schema" \
        "$expected_type" "$actual_type" "${parent_path}${key}" errors valid
    fi
  done

  # Handle additionalProperties
  if [ "$additional_properties" = "false" ]; then
    for key in $(echo "$json" | jq -r 'keys[]'); do
      if ! echo "$properties" | jq -e "has(\"$key\")" >/dev/null; then
        errors+=(
          "Extra property '${parent_path}${key}' found, but additionalProperties is false."
        )
        valid=false
      fi
    done
  fi

  # Print errors if any
  if [ "$valid" = false ]; then
    for error in "${errors[@]}"; do
      echo "$error"
    done
  fi
}

# Validate array elements
validate_array() {
  local array="$1"
  local schema="$2"
  local path="$3"
  local -n errors_ref=$4
  local -n valid_ref=$5

  local items_schema=$(echo "$schema" | jq -c '.items // empty')
  local array_length=$(echo "$array" | jq 'length')

  for ((i = 0; i < array_length; i++)); do
    local element=$(echo "$array" | jq -c ".[$i]")
    local element_type=$(echo "$element" | jq -r 'type')
    local expected_type=$(echo "$items_schema" | jq -r '.type // empty')

    if [ "$element_type" != "$expected_type" ] && [ "$expected_type" != "null" ]; then
      errors_ref+=(
        "Array element ${path}[$i] expected type '$expected_type', but got '$element_type'"
      )
      valid_ref=false
    fi

    # Recursively validate array elements
    validate_json_recursive "$element" "$items_schema" "${path}[$i]."
  done
}

# Validate primitive types and handle constraints
validate_primitive() {
  local value="$1"
  local schema="$2"
  local expected_type="$3"
  local actual_type="$4"
  local path="$5"
  local -n errors_ref=$6
  local -n valid_ref=$7

  if [ "$expected_type" != "$actual_type" ] &&
    [ "$actual_type" != "null" ]; then
    errors_ref+=("Key '${path}' expected type '$expected_type', but got '$actual_type'")
    valid_ref=false
  fi

  # Handle additional constraints (pattern, enum, etc.)
  handle_constraints "$value" "$schema" "$path" errors_ref valid_ref
}

# Handle additional constraints
handle_constraints() {
  local value="$1"
  local schema="$2"
  local path="$3"
  local -n errors_ref=$4
  local -n valid_ref=$5

  local pattern=$(echo "$schema" | jq -r '.pattern // empty')
  local enum_values=$(echo "$schema" | jq -c '.enum // empty')
  local multiple_of=$(echo "$schema" | jq -r '.multipleOf // empty')

  # Pattern matching
  if [ -n "$pattern" ] &&
    ! [[ "$value" =~ $pattern ]]; then
    errors_ref+=("Key '${path}' does not match pattern '$pattern'")
    valid_ref=false
  fi

  # Enum validation
  if [ "$enum_values" != "null" ] &&
    ! echo "$enum_values" | jq -e ". | index($value)" >/dev/null; then
    errors_ref+=("Key '${path}' value '$value' is not in the allowed values: $enum_values")
    valid_ref=false
  fi

  # MultipleOf constraint
  if [ -n "$multiple_of" ] &&
    (($(echo "$value % $multiple_of" | bc) != 0)); then
    errors_ref+=("Key '${path}' value '$value' is not a multiple of $multiple_of")
    valid_ref=false
  fi
}

# Main function to validate a JSON file against a schema
validate_json_from_schema() {
  local json="$1"
  local schema="$2"

  validate_json_recursive "$json" "$schema" ""
}

# Function to decode JSON and base64
query_json64() {
  local item="$1"
  local field="$2"
  echo "$item" | base64 --decode | jq -r "$field" || {
    error "Invalid JSON or base64 input!"
    return 1
  }
}

# Function to convert each element of a JSON array to base64
convert_json_array_to_base64_array() {
  local json_array="$1"
  # Convert each element of the JSON array to base64 using jq
  echo "$json_array" | jq -r '.[] | @base64'
}

# Function to search for an object in a JSON array
search_on_json_array() {
  local json_array_string="$1"
  local search_key="$2"
  local search_value="$3"

  # Validate JSON
  if ! echo "$json_array_string" | jq . >/dev/null 2>&1; then
    echo "Invalid JSON array."
    return 1
  fi

  # Search for an object in the array with the specified key-value pair
  if [[ -n "$search_key" && -n "$search_value" ]]; then
    local matched_item
    matched_item=$(
      echo "$json_array_string" |
        jq -c --arg key "$search_key" --arg value "$search_value" \
          '.[] | select(.[$key] == $value)'
    )

    if [[ -n "$matched_item" ]]; then
      echo "$matched_item"
      return 0
    else
      echo "No matching item found for key '$search_key' and value '$search_value'."
      return 1
    fi
  fi
}

# Function to add JSON objects or arrays
add_json_objects() {
  local json1="$1" # First JSON input
  local json2="$2" # Second JSON input

  # Get the types of the input JSON values
  local type1
  local type2
  type1=$(echo "$json1" | jq -e type 2>/dev/null | tr -d '"')
  type2=$(echo "$json2" | jq -e type 2>/dev/null | tr -d '"')

  # Check if both types were captured successfully
  if [ -z "$type1" ] || [ -z "$type2" ]; then
    echo "One or both inputs are invalid JSON."
    return 1
  fi

  # Perform different operations based on the types of inputs
  local merged
  case "$type1-$type2" in
  object-object)
    # Merge the two JSON objects
    merged=$(jq -sc '.[0] * .[1]' <<<"$json1"$'\n'"$json2")
    ;;
  object-array)
    # Append the object to the array
    merged=$(jq -c '. + [$json1]' --argjson json1 "$json1" <<<"$json2")
    ;;
  array-object)
    # Append the object to the array
    merged=$(jq -c '. + [$json2]' --argjson json2 "$json2" <<<"$json1")
    ;;
  array-array)
    # Concatenate the two arrays
    merged=$(jq -sc '.[0] + .[1]' <<<"$json1"$'\n'"$json2")
    ;;
  *)
    # Unsupported combination
    error "Unsupported JSON types. Please provide valid JSON objects or arrays."
    return 1
    ;;
  esac

  # Output the merged result
  echo "$merged"
}

filter_json_object_by_keys() {
  local json="$1"          # Input JSON string
  local keys=("${@:2}")    # Array of keys (after the first argument)
  local missing_keys=()    # Array to store missing keys
  local filtered_json="{}" # Resultant JSON object

  # Loop through each key
  for key in "${keys[@]}"; do
    # Convert dotted key to array for getpath
    local jq_path
    jq_path=$(echo "$key" | jq -R 'split(".")')

    # Extract the value for the current key
    local value
    value=$(echo "$json" | jq -r --argjson path "$jq_path" 'try getpath($path) // empty')

    if [[ -z "$value" || "$value" == "null" ]]; then
      # Key is missing; add to missing_keys array
      missing_keys+=("$key")
    else
      # Key exists; add it to the filtered JSON object with the dotted key
      filtered_json=$(echo "$filtered_json" | jq --arg key "$key" --arg value "$value" '. + {($key): $value}')
    fi
  done

  # If there are missing keys, print a warning
  if [[ ${#missing_keys[@]} -gt 0 ]]; then
    echo "The following keys are missing in the JSON: ${missing_keys[*]}" >&2
  fi

  # Return the filtered JSON object
  echo "$filtered_json"
}

# Function to sort array1 based on the order of names in array2 using a specified key
sort_array_by_order() {
  local array1="$1"
  local order="$2"
  local key="$3"

  echo "$array1" | jq --argjson order "$order" --arg key "$key" '
    map( .[$key] as $name | {item: ., index: ( $order | index($name) // length) } ) |
    sort_by(.index) | map(.item)
    '
}

# Function to filter items based on the given filter function
filter_items() {
  local items="$1"     # The JSON array of items to filter
  local filter_fn="$2" # The jq filter to apply

  # Apply the jq filter and return the filtered result as a JSON array
  filtered_items=$(echo "$items" | jq "$filter_fn")
  echo "$filtered_items"
}

# Function to get a specific value from a JSON object
query_json_value() {
  local menu_item="$1"
  local query="$2"

  echo "$menu_item" | jq -r "$query"
}

# Function to extract values based on a key
extract_values() {
  echo "$1" | jq -r "map(.$2)"
}

# Function to extract a specific field from a JSON array
extract_field() {
  local json="$1"
  local field="$2"
  echo "$json" | jq -r ".[].$field"
}

get_variable_value_from_collection() {
  local collected_items="$1"
  local variable_name="$2"

  echo "$(
    search_on_json_array "$collected_items" 'name' "$variable_name" | jq -r ".value"
  )"
}

# Function to add a JSON object to an array
append_to_json_array() {
  local json_array="$1"
  local json_object="$2"
  echo "$json_array" | jq ". += [$json_object]"
}

# Function to extract variables from a string without curly braces
extract_variables() {
  local compose_string="$1"
  echo "$compose_string" |
    grep -oE '\{\{[a-zA-Z0-9_]+\}\}' |
    sed 's/[{}]//g' |
    sort -u
}

# Function to sort an array based on another array
sort_array_according_to_other_array() {
  local array1="$1"
  local array2="$2"
  local key="$3"
  order="$(extract_values "$array2" "$key")"
  echo "$(sort_array_by_order "$array1" "$order" "$key")"
}

# Function to convert an associative array to JSON
convert_array_to_json() {
  local -n array_ref=$1 # Reference to the associative array
  local json="{"

  # Iterate over array keys and values
  for key in "${!array_ref[@]}"; do
    # Escape key and value and add them to the JSON object
    json+="\"$key\":\"${array_ref[$key]}\","
  done

  # Remove the trailing comma and close the JSON object
  json="${json%,}}"

  echo "$json"
}

# Function to convert a JSON string to an associative array
convert_json_to_array() {
  local json_string="$1"  # JSON input as a string
  declare -n array_ref=$2 # Reference to the associative array

  # Parse JSON and fill the associative array
  while IFS="=" read -r key value; do
    array_ref["$key"]="$value"
  done < <(echo "$json_string" | jq -r 'to_entries | .[] | "\(.key)=\(.value)"')
}

# Function to save an associative array to a JSON file
save_array_to_json() {
  local file_path="$1" # File path to save the JSON data
  shift                # Remove the first argument, leaving only the associative array parameters

  # Declare the associative array and populate it
  declare -A input_array
  while [[ $# -gt 0 ]]; do
    key="$1"
    value="$2"
    input_array["$key"]="$value"
    shift 2 # Move to the next key-value pair
  done

  # Convert the associative array to JSON
  local json_content
  json_content=$(convert_array_to_json input_array)

  # Save the JSON content to the specified file
  write_json "$file_path" "$json_content"
}

# Function to write JSON content to a file atomically
write_json() {
  local file_path="$1"
  local json_content="$2"

  # Validate the JSON content
  echo "$json_content" | jq . >/dev/null 2>&1
  if [[ $? -ne 0 ]]; then
    echo "Invalid JSON content. Aborting save."
    return 1
  fi

  # Write the JSON content to the specified file using a temporary file for safety
  local temp_file=$(mktemp)
  echo "$json_content" >"$temp_file" && mv "$temp_file" "$file_path"
  chmod 600 "$file_path"

  return 0
}

# Function to load JSON from a file
load_json() {
  local filepath="$1"
  local json_object

  # Check if configuration file exists first
  if [[ -f "$filepath" ]]; then
    json_object=$(cat "$filepath")
  else
    # If file doesn't exist, handle as needed (e.g., return empty JSON or an error)
    warning "Json object '$filepath' not found. Returning empty JSON."
    json_object="{}"
    return 1
  fi

  # Ensure valid JSON by passing it through jq
  if ! echo "$json_object" | jq . >/dev/null 2>&1; then
    warning "Invalid JSON in the file path '$filepath'. Returning empty JSON."
    echo "{}"
    return 1
  else
    # Return the valid JSON
    echo "$json_object"
    return 0
  fi
}

# Function to customize JSON keys with a given identifier
custom_json_keys_with_identifier() {
  local identifier="$1"
  local json_object="$2"

  # Iterate through JSON keys and build a new JSON object with updated keys
  local modified_json
  modified_json=$(
    echo "$json_object" |
      jq --arg id "$identifier" 'with_entries(.key |= "\($id)_\(.)")'
  )

  # Print the modified JSON
  echo "$modified_json"
}

# Function
is_valid_json() {
  local input="$1"

  if jq empty <<<"$input" 2>/dev/null; then
    return 0 # Valid JSON
  else
    return 1 # Invalid JSON
  fi
}

# Function to check if a json object has fields
has_fields() {
  local json_data="$1"
  shift
  local required_fields=("$@")

  # Check if JSON object is valid
  if ! is_valid_json "$json_data"; then
    error "Invalid JSON data"
    return 1
  fi

  # Check if all required fields exist
  for key in "${required_fields[@]}"; do
    if ! jq -e --arg key "$key" 'has($key)' <<<"$json_data" >/dev/null; then
      return 1
    fi
  done

  # All fields are present
  return 0
}

################################## END OF JSON-RELATED FUNCTIONS ################################

############################# BEGIN OF GENERAL UTILITARY FUNCTIONS ##############################

# Function to clean the terminal screen
clean_screen() {
  echo -ne "\033[H\033[J" >&2
}

get_date() {
  date '+%Y-%m-%d %H:%M:%S'
}

# Function to generate a random string
random_string() {
  local length="${1:-16}"

  local word="$(openssl rand -hex $length)"
  echo "$word"
}

# Lower case transformation functions for labels
lowercase() {
  echo "$1" | tr '[:upper:]' '[:lower:]' | tr -s ' ' '_'
}

# Upper case transformation functions for labels
uppercase() {
  echo "$1" | tr '[:lower:]' '[:upper:]'
}

# Function to cast a port to the 'smtp_secure' variable
cast_port_to_smtp_secure() {
  local port="$1"

  # Determine smtp_secure value based on port
  case "$port" in
  465)
    echo "true" # Secure (implicit TLS)
    ;;
  587)
    echo "false" # Not secure (requires STARTTLS to be secure)
    ;;
  25)
    echo "false" # Default SMTP port, not secure
    ;;
  2525)
    echo "false" # Alternative SMTP port, not secure
    ;;
  *)
    echo "unknown" # For any undefined port
    ;;
  esac
}

# Function to strip ANSI escape sequences from a string
strip_color() {
  pattern='s/\x1b\[[0-9;]*[mK]//g'
  echo -e "$1" | sed "$pattern"
}

# Function to strip ANSI escape sequences from a string
strip_ansi() {
  operation="s/\x1b\[[?0-9;]*[a-zA-Z]//g"
  echo -e "$1" | sed "$operation"
}

# Function to convert "true"/"false" to integer 1/0
to_integer() {
  [[ "$1" == "true" ]] && echo 1 || echo 0
}

# Function to convert a numeric result to "true" or "false"
to_boolean() {
  [[ "$1" -ne 0 ]] && echo "true" || echo "false"
}

# Function to display a progress bar
progress_bar() {
  local current="$1"           # Current item
  local total="$2"             # Total items
  local elapsed_ns="$3"        # Elapsed time in nanoseconds
  local total_width="${4:-50}" # Total width of the progress bar (default: 50)
  local marker="${5:-#}"       # Custom marker character (default: #)
  local space_char="${6:- }"   # Character for remaining space (default: space)

  local percentage=$((current * 100 / total))                            # Calculate percentage
  local elapsed_seconds=$(echo "scale=2; $elapsed_ns / 1000000000" | bc) # Convert ns to seconds

  # Clamp the percentage to valid ranges
  percentage=$((percentage > 100 ? 100 : percentage))

  # Calculate the number of markers and spaces
  local filled_width=$((percentage * total_width / 100))
  local empty_width=$((total_width - filled_width))

  # Calculate speed (items per second)
  local speed=0
  if (($(echo "$elapsed_seconds > 0" | bc -l))); then
    speed=$(echo "scale=2; $current / $elapsed_seconds" | bc)
  fi

  # Display speed as secs/item if less than 1 item/sec
  local speed_display="0"
  if (($(echo "$speed > 0" | bc -l))); then
    if (($(echo "$speed < 1" | bc -l))); then
      speed_display=$(echo "scale=2; 1 / $speed" | bc)
      speed_display="${speed_display} secs/item"
    else
      speed_display="${speed} items/sec"
    fi
  fi

  # Estimate time remaining
  local time_remaining="0"
  if ((current < total && $(echo "$speed > 0" | bc -l))); then
    time_remaining=$(echo "scale=2; ($total - $current) / $speed" | bc 2>/dev/null)
  fi

  # Calculate the estimated final time
  local estimated_final_time="0"
  if [[ "$time_remaining" != "0" ]]; then
    estimated_final_time=$(echo "$elapsed_seconds + $time_remaining" | bc 2>/dev/null)
  fi

  local formatted_elapsed_time=$(printf "%6.2f" "$elapsed_seconds")
  local formatted_final_time=$(printf "%6.2f" "$estimated_final_time")

  # Create the progress bar
  local filled_part=$(printf "%-${filled_width}s" "" | tr ' ' "$marker")
  local empty_part=$(printf "%-${empty_width}s" "" | tr ' ' "$space_char")

  # Display the progress bar with current, total, speed, elapsed time, and final estimated time
  printf "\r[%-s] %3d%% (%d/%d) Speed: %10s, Elapsed: %6s secs, Final: %6s secs" \
    "${filled_part}${empty_part}" "$percentage" "$current" "$total" "$speed_display" \
    "$formatted_elapsed_time" "$formatted_final_time"
}

hash_credentials() {
  local username="$1"
  local password="$2"

  hashed_credentials="$(
    htpasswd -nbB "$username" "$password" | sed -e 's/\$/\$\$/g' -e 's/\\\//\//g'
  )"

  echo "$hashed_credentials"
}

build_json_credentials() {
  local username="$1"
  local password="$2"

  jq -n \
    --arg username "$username" \
    --arg password "$password" \
    '{"username": $username, "password": $password}'
}

# Function to check the IP address of a domain
check_domain_ip() {
  local domain="$1"
  local expected_ip="$2"

  # Get the IP address of the domain using dig
  resolved_ip=$(dig +short "$domain")

  # Compare the resolved IP with the expected IP
  if [[ "$resolved_ip" == "$expected_ip" ]]; then
    success "The domain '$domain' resolves to '$expected_ip'."
  else
    error "The domain '$domain' does not resolve to '$expected_ip'. Resolved to '$resolved_ip'."
  fi
}

# Function to check if a command is available
is_command_available() {
  local command="$1"
  command -v "$command" >/dev/null 2>&1
}

# Function to run a command
run_command() {
  local title="$1"
  local command="$2"
  display_header "$title"
  eval "$command"
  wait_for_input
}

# Function to assert domain and IP
assert_domain_and_ip() {
  items='[
      {
          "name": "domain_url",
          "label": "Domain URL",
          "description": "URL to access domain remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      },
      {
          "name": "ip",
          "label": "IP address",
          "description": "String of IP address",
          "required": "yes",
          "validate_fn": ""
      }
  ]'

  collected_items="$(run_collection_process "$items")"

  if [[ "$collected_items" == "[]" ]]; then
    error "Unable to retrieve SMTP test configuration."
    return 1
  fi

  processed_items="$(process_collection_items "$collected_items")"

  domain_url="$(echo "$processed_items" | jq -r '.domain_url')"
  ip="$(echo "$processed_items" | jq -r '.ip')"

  check_domain_ip "$domain_url" "$ip"
}

# Function to run ctop
run_ctop() {
  total_steps=2

  # Check if ctop is already installed
  if command -v ctop &>/dev/null; then
    success "CTOP is already installed. Type 'ctop' in the terminal to use it."
  else
    # Install ctop if not already installed
    install_ctop
    exit_code=$?

    if [[ $exit_code -ne 0 ]]; then
      message="Failed to install CTOP"
      handle_exit $exit_code 2 $total_steps "$message"
      return 1
    fi
  fi

  # Run ctop after ensuring installation
  ctop
}

# Function to generate a UUID
generate_uuid() {
  if command -v uuidgen >/dev/null 2>&1; then
    # Use uuidgen if available
    uuidgen
  elif [[ -f /proc/sys/kernel/random/uuid ]]; then
    # Use the random UUID file on Linux systems
    cat /proc/sys/kernel/random/uuid
  else
    # Fallback: Generate a random UUID manually
    printf '%s-%s-%s-%s-%s\n' \
      "$(cat /dev/urandom | tr -dc 'a-f0-9' | head -c8)" \
      "$(cat /dev/urandom | tr -dc 'a-f0-9' | head -c4)" \
      "$(printf '4%x' $((RANDOM % 16)))$(cat /dev/urandom | tr -dc 'a-f0-9' | head -c3)" \
      "$(printf '%x%x' $((RANDOM % 4 + 8)) $((RANDOM % 16)))$(cat /dev/urandom |
        tr -dc 'a-f0-9' | head -c3)" \
      "$(cat /dev/urandom | tr -dc 'a-f0-9' | head -c12)"
  fi
}

# Function to check if an SMTP port is secure
is_smtp_port_secure() {
  local port="$1"

  case "$port" in
  465 | 587)
    echo "true" # Secure ports
    ;;
  25)
    echo "false" # Not secure by default
    ;;
  *)
    echo "false" # Unknown port; assume not secure
    ;;
  esac
}

# Function to download a file from a URL
download_file() {
  local url="$1"
  local dest_dir="${2:-.}" # Default to the current directory if not specified
  local file_name="${3:-}" # Optional custom file name

  # Check if the URL is provided
  if [[ -z "$url" ]]; then
    error "URL is required."
    return 1
  fi

  # Create the destination directory if it doesn't exist
  if [[ ! -d "$dest_dir" ]]; then
    info "Destination directory does not exist. Creating: $dest_dir"
    mkdir -p "$dest_dir"
  fi

  # Extract the file name from the URL if no custom name is provided
  if [[ -z "$file_name" ]]; then
    file_name=$(basename "$url")
  fi

  # Full path to save the file
  local output_path="$dest_dir/$file_name"

  # Download the file using curl
  info "Downloading file from: $url"
  info "Saving to: $output_path"

  if curl -fSL "$url" -o "$output_path"; then
    success "Download successful."
    return 0
  else
    error "Failed to download the file.\033[0m"
    return 1
  fi
}

############################# END OF GENERAL UTILITARY FUNCTIONS #############################

############################## BEGIN OF EMAIL-RELATED FUNCTIONS ##############################

# Function to send an email
send_email() {
  local from_email=$1
  local to_email=$2
  local server=$3
  local port=$4
  local user=$5
  local pass=$6
  local subject=$7
  local body=$8

  # Attempt to send the email using swaks and capture output and error details
  local output
  output=$(swaks \
    --to "$to_email" \
    --from "$from_email" \
    --server "$server" \
    --port "$port" \
    --auth LOGIN --auth-user "$user" \
    --auth-password "$pass" \
    --tls \
    --header "Subject: $subject" \
    --header "Content-Type: text/html; charset=UTF-8" \
    --data "Content-Type: text/html; charset=UTF-8\n\n$body" 2>&1)

  # Capture the exit status of the swaks command
  local status=$?

  # Check if the email was sent successfully
  if [ $status -eq 0 ]; then
    success "Test email sent successfully to $to_email."
  else
    error "Failed to send test email. Details: $output"
    exit $status
  fi
}

################################## END OF EMAIL-RELATED FUNCTIONS #################################

############################### BEGIN OF SYSTEM-RELATED FUNCTIONS #################################

# Function to generate and print machine specifications and resource usage
generate_machine_specs() {
  # Helper function to print key-value pairs
  print_spec() {
    local key="$1"
    local value="$2"

    # If the value is empty or contains 'N/A', use a default fallback value
    if [[ -z "$value" || "$value" == "N/A" ]]; then
      value="No data available"
    fi

    # Print the key-value pair
    printf "%-20s: %s\n" "$key" "$value"
  }

  # Helper function to safely execute a command and return the result
  safe_exec() {
    local cmd="$1"
    result=$(eval "$cmd" 2>/dev/null)
    if [[ -z "$result" || "$result" == "N/A" ]]; then
      result="No data available"
    fi
    echo "$result"
  }

  # Machine Specifications
  print_spec "Hostname" "$(hostname)"
  print_spec "Operating System" "$(
    safe_exec "lsb_release -d | cut -f2"
  )"
  print_spec "Kernel Version" "$(
    safe_exec "uname -r"
  )"
  print_spec "Processor Model" "$(
    safe_exec "lscpu | awk -F ':' '/^Model name/ {gsub(/^[ \t]+/, \"\", \$2); print \$2}'"
  )"
  print_spec "Processor Cores" "$(
    safe_exec "lscpu | awk -F ':' '/^CPU\\(s\\):/ {gsub(/^[ \t]+/, \"\", \$2); print \$2}'"
  )"
  print_spec "Processor Threads" "$(
    safe_exec \
      "lscpu | awk -F ':' '/^Thread\\(s\\) per core:/ {gsub(/^[ \t]+/, \"\", \$2); print \$2}'"
  )"
  print_spec "Clock Speed" "$(
    safe_exec "lscpu | grep 'Model name' | grep -o '@ [0-9.]\+GHz' || echo 'N/A'"
  )"
  print_spec "Total Memory" "$(
    safe_exec "free -h | awk '/^Mem:/ {print \$2}'"
  )"
  print_spec "GPU Details" "$(
    safe_exec "lspci | grep -i 'vga\\|3d\\|2d' || echo 'GPU information unavailable.'"
  )"
  print_spec "Docker Version" "$(
    safe_exec "docker --version || echo 'Not installed'"
  )"

  echo
  if command -v upower &>/dev/null; then
    upower -i $(
      upower -e | grep BAT
    ) |
      grep -E 'state|to full|percentage' |
      awk -F ':' '{gsub(/^[ \t]+|[ \t]+$/, "", $1); gsub(/^[ \t]+|[ \t]+$/, "", $2); printf "%-15s: %s\n", $1, $2}'
  else
    print_spec "Battery Status" "No battery information available."
  fi
}

# Function to generate a complete HTML representation of machine specifications and resource usage
generate_machine_specs_table() {
  local html_content=""

  # Helper function to create a table
  create_table() {
    local caption="$1"
    local headers="$2"
    local rows="$3"
    echo "<table style='width: 100%; border-collapse: collapse; margin-top: 20px; border: 1px solid #ddd;'>"
    echo "<caption style='font-size: 1.5em; margin-bottom: 10px; font-weight: bold;'>$caption</caption>"
    echo "<thead style='background-color: #f9f9f9;'><tr>$headers</tr></thead>"
    echo "<tbody>$rows</tbody>"
    echo "</table>"
  }

  # Helper function to generate a row
  generate_table_row() {
    local key="$1"
    local value="$2"

    # If the value is empty or contains 'N/A', use a default fallback value
    if [[ -z "$value" || "$value" == "N/A" ]]; then
      value="No data available"
    fi

    echo "<tr style='border-bottom: 1px solid #ddd;'><td style='padding: 8px;'>$key</td><td style='padding: 8px;'>$value</td></tr>"
  }

  # Helper function to safely execute a command and return the result
  safe_exec() {
    local cmd="$1"

    # Try to execute the command
    result=$(eval "$cmd" 2>/dev/null)

    # If no result, return a fallback message
    if [[ -z "$result" || "$result" == "N/A" ]]; then
      result="No data available"
    fi

    echo "$result"
  }

  # Machine Specifications Table
  local machine_specs_rows=""
  machine_specs_rows+=$(
    generate_table_row "Hostname" \
      "$(hostname)"
  )
  machine_specs_rows+=$(
    generate_table_row "Operating System" \
      "$(safe_exec "lsb_release -d | cut -f2")"
  )
  machine_specs_rows+=$(
    generate_table_row "Kernel Version" \
      "$(safe_exec "uname -r")"
  )
  machine_specs_rows+=$(
    generate_table_row "Processor Model" \
      "$(safe_exec "lscpu | awk -F ':' '/Model name/ {gsub(/^[ \t]+/, \"\", \$2); print \$2}'")"
  )
  machine_specs_rows+=$(
    generate_table_row "Processor Cores" \
      "$(safe_exec "lscpu | awk -F ':' '/^CPU\(s\):/ {gsub(/^[ \t]+/, \"\", \$2); print \$2}'")"
  )

  command="lscpu | awk -F ':' '/^Thread\(s\) per core:/ {gsub(/^[ \t]+/, \"\", \$2); print \$2}'"
  machine_specs_rows+=$(
    generate_table_row "Processor Threads" "$(safe_exec "$command")"
  )
  machine_specs_rows+=$(
    generate_table_row "Clock Speed" \
      "$(safe_exec "lscpu | grep 'Model name' | grep -o '@ [0-9.]\+GHz' || echo 'N/A'")"
  )
  machine_specs_rows+=$(
    generate_table_row "Total Memory" \
      "$(safe_exec "free -h | awk '/^Mem:/ {print \$2}'")"
  )
  machine_specs_rows+=$(
    generate_table_row "GPU Details" \
      "$(safe_exec "lspci | grep -i 'vga\|3d\|2d' || echo 'GPU information unavailable.'")"
  )
  machine_specs_rows+=$(
    generate_table_row "Docker Version" \
      "$(safe_exec "docker --version || echo 'Not installed'")"
  )

  html_content+=$(create_table "Machine Specifications" "<th>Attribute</th><th>Details</th>" "$machine_specs_rows")

  # Disk Usage Table
  local disk_usage_rows=$(
    df -h --output=source,fstype,size,used,avail,pcent |
      grep -E '^/dev' |
      awk '{printf "<tr><td>%s</td><td>%s</td><td>%s</td><td>%s</td><td>%s</td><td>%s</td></tr>", $1, $2, $3, $4, $5, $6}'
  )
  html_content+=$(
    create_table "Disk Usage" \
      "<th>Source</th><th>Filesystem Type</th><th>Total Size</th><th>Used</th><th>Available</th><th>Use%</th>" \
      "$disk_usage_rows"
  )

  # Battery Status Table (only if upower is available)
  if command -v upower &>/dev/null; then
    local battery_rows=$(
      upower -i $(upower -e | grep BAT) | grep -E 'state|to full|percentage' |
        awk -F ':' '{gsub(/^[ \t]+|[ \t]+$/, "", $1); gsub(/^[ \t]+|[ \t]+$/, "", $2); print "<tr><td>" $1 "</td><td>" $2 "</td></tr>"}'
    )
    if [[ -n "$battery_rows" ]]; then
      html_content+=$(
        create_table "Battery Status" \
          "<th>Status</th><th>Details</th>" "$battery_rows"
      )
    else
      html_content+=$(
        create_table "Battery Status" \
          "<th>Status</th><th>Details</th>" "<tr><td colspan='2'>No battery information available.</td></tr>"
      )
    fi
  fi

  # Network Information Table (Ethernet and Wi-Fi)
  local ethernet_info=$(
    safe_exec "ip -4 addr show | grep 'state UP' -A2 | grep inet | awk '{print \$2}' || echo 'No Ethernet connection.'"
  )
  local wifi_info=$(
    safe_exec "nmcli device status | grep wifi | awk '{print \$1, \$3, \$4}' || echo 'No Wi-Fi connection.'"
  )
  local network_rows=""
  network_rows+=$(generate_table_row "Ethernet" "$ethernet_info")
  network_rows+=$(generate_table_row "Wi-Fi" "$wifi_info")
  html_content+=$(
    create_table "Network Information" "<th>Type</th><th>Details</th>" "$network_rows"
  )

  # Return the complete HTML content
  echo "$html_content"
}

# Functions for diagnostics
# Show uptime with start and current time
uptime_usage() {
  # Example usage of display_text to show a centered header
  echo ""
  format_="%Y-%m-%d %H:%M:%S"
  echo "$(uptime -p) since $(date -d "$(uptime -s)" +"$format_") to $(date +"$format_")" >&2
  echo ""
}

memory_usage() {
  echo ""
  free -h
  echo ""
}

# Function to display disk usage
disk_usage() {
  # Get the used, available, and total space in bytes
  read -r used avail total <<<"$(df --output=used,avail,size --block-size=1 / | tail -n1)"

  # Calculate the percentage of space used with decimal precision
  if [[ $total -gt 0 ]]; then
    percentage=$(awk "BEGIN {printf \"%.2f\", ($used / $total) * 100}")
  else
    percentage="0.00"
  fi

  # Convert bytes to gigabytes (with two decimal places)
  used_gb=$(awk "BEGIN {printf \"%.2f\", $used / (1024^3)}")
  avail_gb=$(awk "BEGIN {printf \"%.2f\", $avail / (1024^3)}")
  total_gb=$(awk "BEGIN {printf \"%.2f\", $total / (1024^3)}")

  # Print the results in a structured format
  echo "Used: ${used_gb}G, Available: ${avail_gb}G, Total: ${total_gb}G, Usage: ${percentage}%"
}

# Function to display network usage
show_interface_stats() {
  echo ""
  ip -s link
  echo ""
}

# Function to display top processes
top_processes() {
  echo ""

  # Display only the relevant columns: PID, USER, %CPU, %MEM, and COMMAND
  ps aux --sort=-%cpu,-%mem | awk 'NR<=6 {print $1, $2, $3, $4, $11}' | column -t

  echo ""
}

# Function to display security diagnostics
security_diagnostics() {
  echo -e "${blue}Open Ports:${normal}"
  ss -tuln
  echo -e "\n${blue}Failed Login Attempts:${normal}"
  grep "Failed password" /var/log/auth.log | tail -n 5
  echo ""
}

# Function to display storage insights
storage_insights() {
  echo ""
  echo -e "${blue}Largest Files:${normal}"
  du -ah / | sort -rh | head -n 10
  echo -e "\n${blue}Inode Usage:${normal}"
  df -i
  echo ""
}

# Function to display formatted load average and uptime
load_average() {
  echo ""
  # Extract and format uptime information
  uptime | awk -F'( |,|:)+' '{
        printf "System Uptime: %s days, %s hours, %s minutes\n", $6, $8, $9;
        printf "Logged-in Users: %s\n", $10;
        printf "Load Averages: 1 min: %s, 5 min: %s, 15 min: %s\n", $(NF-2), $(NF-1), $NF;
    }'
  echo ""
}

# Function to display bandwidth usage
bandwidth_usage() {
  if command -v vnstat &>/dev/null; then
    vnstat
  else
    echo -e "${red}vnstat is not installed. Please install it to monitor bandwidth.${normal}"
  fi
  echo ""
}

# Function to check disk usage
check_disk_usage() {
  local threshold="${1:-80}"
  local mount_point="${2:-/}"

  # Get the disk usage percentage for the mount point.
  # df output typically has the percentage in the 5th column (e.g. "80%")
  local usage
  usage=$(df "$mount_point" | awk 'NR==2 {gsub(/%/,""); print $5}')

  if [ -z "$usage" ]; then
    failure "Unable to determine disk usage for $mount_point."
    return 3
  fi

  if [ "$usage" -ge "$threshold" ]; then
    warning "Disk usage on $mount_point is ${usage}% which is above the threshold of ${threshold}%."
    return 1
  else
    return 0
  fi
}

#######################################################################################

# Function to show help
show_help() {
  local menu_options_count="$1"
  local page_size="$2"

  echo -e "${highlight_color}↗↘${reset_color}  - Navigate down- and upwards"

  # Check if there are more items than the page size
  if (($menu_options_count > page_size)); then
    echo -e "${highlight_color}◁▷${reset_color}  - Navigate sideways"
  fi

  echo -e "${select_color}↵${reset_color}   - Select current option"
  echo -e "${back_color}g${reset_color}   - Go to specific page"
  echo -e "${back_color}r${reset_color}   - Return to menu begin"
  echo -e "${search_color}/${reset_color}   - Search on current menu"
  echo -e "${quit_color}q${reset_color}   - Return to previous menu / Quit the application"
  echo -e "${help_color}h${reset_color}   - Show this help menu"
  echo -e "${exit_color}x${reset_color}   - Exit the application"
}

# Function to clean up mustache variables
sanitize_template() {
  local template="$1"
  # Remove any spaces between the mustache braces and the variable name
  template=$(echo "$template" | sed 's/{{\s*\([a-zA-Z0-9_]*\)\s*}}/{{\1}}/g')
  echo "$template"
}

# Function to replace mustache variables
replace_mustache_variables() {
  local template="$1"
  local -n vars_ref="$2"

  for key in "${!vars_ref[@]}"; do
    value="${vars_ref[$key]}"

    # Escape special characters for awk and perform substitution
    template=$(echo "$template" | awk -v key="$key" -v value="$value" \
      '{gsub("{{ *" key " *}}", value); print}')

  done

  echo "$template"
}

# Function to find the next available port
find_next_available_port() {
  local trigger_port="$1"
  local current_port="$trigger_port"

  # Check if the trigger port is valid
  validate_port_availability "$current_port" >/dev/null 2>&1
  if [[ $? -eq 0 ]]; then
    # Return the trigger port if it's available
    echo "$current_port"
    return 0
  fi

  # If trigger port is in use, try subsequent ports
  while true; do
    ((current_port++)) # Increment the port number

    # Ensure the port number stays within the valid range (1-65535)
    if ((current_port > 65535)); then
      echo "No available ports found in the valid range."
      return 1
    fi

    # Check if the current port is available
    validate_port_availability "$current_port"
    if [[ $? -eq 0 ]]; then
      echo "$current_port" # Return the first available port
      return 0
    fi
  done
}

# Function to run a command and display its output
command() {
  local command="$1"
  local current_step="$2"
  local total_steps="$3"
  local step_message="$4"

  local log_file="/tmp/log.txt"
  local allow_dangerous_commands="${5:no}"

  # Ensure we don't run any destructive commands unintentionally unless explicitly allowed
  if [[ "$allow_dangerous_commands" != "yes" && "$command" =~ (rm|mv|dd|reboot|shutdown) ]]; then
    error "This function does not support potentially destructive commands."
    return 1
  fi

  # Format and display step message
  step_info $current_step $total_steps "$step_message"

  # Run the command and process its output line by line, logging both stdout and stderr
  {
    DEBIAN_FRONTEND=noninteractive $command
  } 2>&1 | while IFS= read -r line; do
    # Format and display each line as it is outputted
    if [[ "$line" =~ ^(Hit|Reading|Fetched|Get|Reading|Building|Done|Fetched).* ]]; then
      format "info" "$line"
    else
      format "normal" "$line"
    fi
  done | tee "$log_file"

  # Get the exit status of the last command run
  exit_code=$?
  handle_exit $? $current_step $total_steps "$step_message"

  # Clean up the log file if needed
  rm -f "$log_file"

  return $exit_code
}

# Function to build api url
get_api_url() {
  protocol="$1"
  url="$2"
  resource="$3"
  echo "https://$url/api/$resource"
}

# Function to handle all API requests with enhanced error handling
request() {
  local method="$1"       # HTTP method (GET, POST, DELETE, etc.)
  local url="$2"          # Full API URL
  local token="$3"        # Bearer token
  local content_type="$4" # Content-Type header (default: application/json)
  local data="$5"         # Optional JSON data for POST/PUT requests

  # Validate required parameters
  if [[ -z "$method" || -z "$url" || -z "$token" ]]; then
    echo "Missing required parameters"
    return 1
  fi

  # Make the API request using curl, capturing both body and HTTP status code
  response=$(curl -k -s -w "%{http_code}" -X "$method" "$url" \
    -H "Authorization: Bearer $token" \
    -H "Content-Type: ${content_type:-application/json}" \
    ${data:+-d "$data"})

  # Extract HTTP response code from the response
  http_code="${response: -3}"

  # Extract response body (remove the last 3 characters, which are the HTTP status code)
  response_body="${response%???}"

  # Check if the request was successful (HTTP 2xx response)
  if [[ ! "$http_code" =~ ^2 ]]; then
    echo "API request failed with status code $http_code"
    echo "Response: $response_body"
    return 1
  else
    # Return the response body if successful
    echo "$response_body"
    return 0
  fi
}

# Function to perform requests on portainer URL
filtered_request() {
  local method="$1"                             # HTTP method (GET, POST, DELETE, etc.)
  local url="$2"                                # Full API URL or resource
  local token="$3"                              # Bearer token for authentication
  local content_type="${4:-'application/json'}" # Content-Type (default: application/json)
  local data="${5:-'{}'}"                       # JSON data for POST/PUT requests (optional)
  local filter=${6:-''}                         # Optional jq filter to extract specific output

  # Make the API request
  response=$(request "$method" "$url" "$token" "$content_type" "$data")

  # Apply the jq filter if provided, otherwise return the raw response
  if [[ -n "$filter" ]]; then

    echo "$response" | jq -r "$filter"
  else
    echo "$response"
  fi
}

# Function to trim leading/trailing spaces
trim() {
  pattern='s/^ *//;s/ *$//'
  echo "$1" | sed "$pattern"
}

# Function to check the key and set the boolean
set_move_boolean() {
  local key_to_check="$1"
  local key_value="$2"

  if [[ "$key_to_check" = "$key_value" ]]; then
    echo true
  else
    echo false
  fi
}

# Function to wait for a specified number of seconds
wait_secs() {
  local seconds=$1
  sleep "$seconds"
}

# Function to clear previous line
clear_line() {
  tput cuu1 # Move the cursor up one line
  tput el   # Clear the current line
}

# Function to clear multiple previous lines
clear_lines() {
  # Number of lines to clear
  local lines=$1
  for i in $(seq 1 "$lines"); do
    clear_line
  done
}

# Function to wait apt process lock to free
wait_apt_lock() {
  local attempt_interval=${1-5}
  local max_wait_time=${2-60}

  # Wait for the lock to be released or forcefully remove it if needed
  wait_time=0
  while fuser /var/lib/dpkg/lock-frontend >/dev/null 2>&1; do
    if [ "$wait_time" -ge "$max_wait_time" ]; then
      error "APT lock held for too long. Attempting to kill process."
      lock_pid=$(lsof /var/lib/dpkg/lock-frontend | awk 'NR==2 {print $2}')
      if [[ -n "$lock_pid" ]]; then
        kill -9 "$lock_pid"
        info "Killed process $lock_pid holding APT lock."
      fi
    fi
    info "Waiting for APT lock to be released..."
    sleep $WAIT_INTERVAL
    wait_time=$((wait_time + attempt_interval))
  done
}

# Function to clean the local docker environment
clean_docker_environment() {
  highlight "Cleaning local docker environment"
  sanitize

  wait_for_input
}

# Function to remove dangling images
remove_dangling_images() {
  # Find dangling images
  dangling_images=$(docker images -f "dangling=true" -q)

  if [[ -z "$dangling_images" ]]; then
    # No dangling images found
    echo "no_dangling_images"
    echo "No dangling images to clean up."
  else
    # Initialize counters
    success_count=0
    failure_count=0
    failed_images=()

    for image_id in $dangling_images; do
      # Attempt to remove each dangling image
      if docker rmi "$image_id" &>/dev/null; then
        ((success_count++))
      else
        ((failure_count++))
        failed_images+=("$image_id")
      fi
    done

    # Prepare status and message
    if [[ $failure_count -eq 0 ]]; then
      echo "success"
      echo "Removed $success_count dangling images successfully."
    elif [[ $success_count -eq 0 ]]; then
      echo "error"
      echo "Failed to remove $failure_count dangling images. Images might be in use."
    else
      echo "partial_success"

      local non_removed_images="Failed to remove $failure_count images: ${failed_images[*]}"
      echo "Removed $success_count images successfully. $non_removed_images"
    fi
  fi
}

# Function to clean docker environment with one confirmation step
sanitize() {
  total_steps=5

  # Ask for confirmation before proceeding
  explanation="This will prune unused containers, networks, volumes, images, and build cache"
  confirmation_query="Are you sure you want to continue? [y/N]"
  message="$explanation. $confirmation_query"
  formatted_message="$(format "question" "$message")"

  if handle_confirmation_prompt "$formatted_message" 'y' 5; then
    # Run commands with explicit permission for destructive operations
    message="Pruning unused containers, networks, volumes, and build cache"
    command="docker system prune --all --volumes -f"
    command "$command" 1 $total_steps "$message" "yes"

    # Call the function and capture its output
    message="Removing dangling images"
    step_info 2 $total_steps "$message"

    status_message=$(remove_dangling_images)
    status=$(echo "$status_message" | head -n 1)
    message=$(echo "$status_message" | tail -n 1)

    # Handle status after the function call
    if [[ "$status" == "success" ]]; then
      step_success 2 $total_steps "Cleanup completed successfully: $message"
    elif [[ "$status" == "no_dangling_images" ]]; then
      step_warning 2 $total_steps "No dangling images found."
    else
      step_error 2 $total_steps "$message"
    fi

    message="Removing stopped containers"
    command="docker container prune -f"
    command "$command" 3 $total_steps "$message" "yes"

    message="Removing unused Docker networks"
    command="docker network prune -f"
    command "$command" 4 $total_steps "$message" "yes"

    message="Removing orphaned volumes"
    command="docker volume prune -f"
    command "$command" 5 $total_steps "$message" "yes"
  else
    failure "Aborted by user."
  fi
}

################################ BEGIN OF VALIDATION-RELATED FUNCTION #############################

# Function to validate empty values
validate_empty_value() {
  local value="$1"
  if [[ -z "$value" ]]; then
    echo "The value is empty or not set."
    return 1
  else
    return 0
  fi
}

# Function to validate name values with extensive checks
validate_name_value() {
  local value="$1"

  # Check if the name starts with a number
  if [[ "$value" =~ ^[0-9] ]]; then
    echo "The value '$value' should not start with a number."
    return 1
  fi

  # Check if the name contains invalid characters
  if [[ ! "$value" =~ ^[a-zA-Z0-9][a-zA-Z0-9@#\&*_-]*$ ]]; then
    allowed_chars="'@', '#', '&', '*', '_', '-'"
    criterium="Only letters, numbers, and the characters $allowed_chars are allowed."
    error_message="The value '$value' contains invalid characters."
    echo "$error_message $criterium"
    return 1
  fi

  # Check if the name is too short (less than 3 characters)
  if ((${#value} < 3)); then
    echo "The value '$value' is too short. It must be at least 3 characters long."
    return 1
  fi

  # Check if the name is too long (more than 50 characters)
  if ((${#value} > 50)); then
    echo "The value '$value' is too long. It must be at most 50 characters long."
    return 1
  fi

  # Check for spaces in the name
  if [[ "$value" =~ [[:space:]] ]]; then
    echo "The value '$value' contains spaces. Spaces are not allowed."
    return 1
  fi

  # If all validations pass
  return 0
}

# Function to validate email values
validate_email_value() {
  local value="$1"

  # Check if the value matches an email pattern
  if [[ ! "$value" =~ ^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$ ]]; then
    echo "The value '$value' is not a valid email address."
    return 1
  fi

  return 0
}

validate_smtp_port() {
  local port=$1

  # Check valid smpt ports: 25, 587, 465
  if [[ ! "$port" =~ ^(25|587|465)$ ]]; then
    echo "The value '$port' is not a valid SMTP port. Valid ports are 25, 587, and 465."
    return 1
  fi

  return 0
}

# Function to validate url suffix
validate_url_suffix() {
  local value="$1"

  # Regular expression to match the part after "https://"
  local url_suffix_regex="^([a-zA-Z0-9-]+\.)+[a-zA-Z]{2,}(/.*)?$"

  # Check if the value matches the suffix pattern
  if [[ ! "$value" =~ $url_suffix_regex ]]; then
    echo "The value '$value' is not a valid URL suffix (domain and optional path)."
    return 1
  fi

  return 0
}

# Function to validate integer values
validate_integer_value() {
  local value="$1"

  # Check if the value is an integer (allow negative and positive integers)
  if [[ ! "$value" =~ ^-?[0-9]+$ ]]; then
    echo "The value '$value' is not a valid integer."
    return 1
  fi

  return 0
}

# Function to validate port availability
validate_port_availability() {
  local port="$1"

  # Check if the port is a valid number between 1 and 65535
  if [[ ! "$port" =~ ^[0-9]+$ ]] || ((port < 1 || port > 65535)); then
    explanation="Port numbers must be between 1 and 65535."
    echo "The value '$port' is not a valid port number. $explanation"
    return 1
  fi

  # Use netcat (nc) to check if the port is open on localhost
  # The -z flag checks if the port is open (without sending data)
  # The -w1 flag specifies a timeout of 1 second
  nc -z -w1 127.0.0.1 "$port" 2>/dev/null

  # Check the result of the netcat command
  if [[ $? -eq 0 ]]; then
    echo "The port '$port' is already in use."
    return 1
  else
    echo "The port '$port' is available."
    return 0
  fi
}

# Function to validate SMTP server connectivity
validate_smtp_host() {
  local server=$1
  if ping -c 1 "$server" >/dev/null 2>&1; then
    echo "SMTP server $server is reachable."
  else
    echo "Unable to reach SMTP server $server. Please check the server address."
    exit 1
  fi
}

# Function to validate username
validate_username() {
  local value="$1"

  # Check if the value contains only letters, numbers, and underscores
  if [[ ! "$value" =~ ^[a-zA-Z0-9_]+$ ]]; then
    warn_message="The value '$value' is not a valid username"
    reason="It can only contain letters, numbers, and underscores."
    echo "$warn_message. $reason"
    return 1
  fi

  return 0
}

# Function to validate password
validate_password() {
  local value="$1"

  # Common warning message
  local warn_message="The value '$value' is not a valid password"

  # Check if the value contains at least 5 characters
  if [[ ${#value} -lt 5 ]]; then
    local reason="It must be at least 5 characters long."
    echo "$warn_message. $reason"
    return 1
  fi

  # Check if the value contains at least one uppercase letter
  if [[ ! "$value" =~ [A-Z] ]]; then
    local reason="It must contain at least one uppercase letter."
    echo "$warn_message. $reason"
    return 1
  fi

  # Check if the value contains at least one lowercase letter
  if [[ ! "$value" =~ [a-z] ]]; then
    local reason="It must contain at least one lowercase letter."
    echo "$warn_message. $reason"
    return 1
  fi

  # Check if the value contains at least one number
  if [[ ! "$value" =~ [0-9] ]]; then
    local reason="It must contain at least one number."
    echo "$warn_message. $reason"
    return 1
  fi

  # Check if the value contains at least one valid special character
  if [[ ! "$value" =~ [\!\@\#\$\%\^\&\*\(\)\_\+\-\=] ]]; then
    local reason="It must contain at least one valid special character (!@#$%^&*()_+-=)."
    echo "$warn_message. $reason"
    return 1
  fi

  # Check if the value does not contain spaces
  if [[ "$value" =~ [[:space:]] ]]; then
    local reason="It cannot contain spaces."
    echo "$warn_message. $reason"
    return 1
  fi

  # Check for invalid special characters (e.g., '<', '>')
  if [[ "$value" =~ [\<\>] ]]; then
    local reason="It contains invalid special characters (<>)."
    echo "$warn_message. $reason"
    return 1
  fi

  # If all checks pass
  return 0
}

# Function to validate boolean
validate_boolean() {
  local value="$1"

  # Check if the value is a valid boolean
  if [[ "$value" != "true" && "$value" != "false" ]]; then
    echo "The value '$value' is not a valid boolean."
    return 1
  fi

  return 0
}

# Function to validate yes-no reponse
validate_yn_response() {
  local value="$1"

  # Check if the value is a valid yes/no response
  if [[ 
    "$value" != "y" && "$value" != "n" &&
    "$value" != "Y" && "$value" != "N" ]] \
    ; then
    echo "The value '$value' is not a valid yes/no response."
    return 1
  fi
}

################################# END OF VALIDATION-RELATED FUNCTION ##############################

############################### BEGIN OF GENERAL UTILITARY FUNCTIONS #############################

# Function to display progress for a running command
show_progress() {
  local pid=$1
  local message=${2:-""}
  local spinner='|/-\\'
  local delay=0.1
  echo -n "$message "

  while kill -0 $pid 2>/dev/null; do
    for i in $(seq 0 3); do
      echo -ne "\b${spinner:i:1}"
      sleep $delay
    done
  done

  echo -ne "\b"
  success "Done!"
}

# Function to validate the input and return errors for invalid fields
validate_value() {
  local value="$1"
  local validate_fn="${2-validate_empty_value}"

  # Capture the output from the validation function
  error_message=$($validate_fn "$value")

  # Check the return code of the validation function
  if [[ $? -ne 0 ]]; then
    # If validation failed, capture and print the error message
    echo "$error_message"
    return 1
  fi
  return 0
}

create_error_item() {
  local name="$1"
  local message="$2"
  local validate_fn="$3"

  # Find the line number of the function definition by parsing the current script
  local line_number
  pattern="^[[:space:]]*(function[[:space:]]+|)[[:space:]]*$validate_fn[[:space:]]*\(\)"
  line_number=$(grep -n -E "$pattern" "$BASH_SOURCE" | cut -d: -f1)

  # Escape the message for jq
  local escaped_message
  escaped_message=$(printf '%s' "$message" | jq -R .)

  # Create the error object using jq
  jq -n \
    --arg name "$name" \
    --arg value "$value" \
    --arg message "$escaped_message" \
    --arg line_number "$line_number" \
    --arg validate_fn "$validate_fn" \
    '{
        name: $name,
        message: ($message | fromjson),
        value: $value,
        line_number: $line_number,
        function: $validate_fn
    }'
}

# Function to generate a JSON configuration for a service
generate_schema_stack_config() {
  local required_fields=($1) # Convert input string to array

  # Initialize an empty JSON object with formatted structure
  local schema=$(jq -n '
    {
      variables: {},
      target: {
        type: "string",
        values: ["swarm", "portainer"]
      },
      dependencies: {
        type: "array",
        items: { type: "string", minLength: 1 }
      },
      actions: {
        type: "object",
        properties: {
          refresh: { type: "array", items: { type: "object" } },
          refresh: { type: "array", items: { type: "object" } },
          prepare: { type: "array", items: { type: "object" } },
          finalize: { type: "array", items: { type: "object" } }
        }
      }
    }')

  # Add required fields to "variables"
  for field in "${required_fields[@]}"; do
    schema=$(
      echo "$schema" |
        jq --arg key "$field" '.variables[$key] = {type: "string", minLength: 1}'
    )
  done

  echo "$schema"
}

# Function to extract required fields and generate schema
validate_stack_config() {
  local stack_config="$1"

  # Get the stack name
  stack_name="$(echo $stack_config | jq -r '.name')"

  # Get required fields from the stack template
  required_fields=$(list_stack_compose_required_fields "$stack_name")

  # Generate the JSON schema
  schema=$(generate_schema_stack_config "$required_fields")

  # Step 5: Validate if the provided JSON has all required variables
  validate_json_from_schema "$config_json" "$schema"
}

# Function to prompt for user input
prompt_for_input() {
  local item="$1"

  name=$(query_json64 "$item" '.name')
  label=$(query_json64 "$item" '.label')
  description=$(query_json64 "$item" '.description')
  required=$(query_json64 "$item" '.required')
  default_value=$(query_json64 "$item" '.default_value')

  # Assign the 'required' label based on the 'required' field value
  if [[ "$required" == "yes" ]]; then
    required_label="required"
  else
    required_label="optional"
  fi

  local general_info="Prompting $required_label variable $name: $description"
  local explanation="Enter a value, type 'q' to quit"

  # Notify the user if a default value is provided, only if it is non-empty
  if [[ -n "$default_value" && "$default_value" != "null" ]]; then
    explanation="$explanation or Enter to use the default value '$default_value'"
  fi

  local prompt="$explanation: "
  question "$general_info"
  fmt_prompt=$(format 'question' "$prompt")

  while true; do
    read -rp "$fmt_prompt" value
    if [[ "$value" == "q" ]]; then
      echo "q"
      return
    fi

    # Use default value if input is empty and default is provided
    if [[ -z "$value" && -n "$default_value" && "$default_value" != "null" ]]; then
      value="$default_value"
    fi

    if [[ -n "$value" || "$required" == "no" ]]; then
      echo "$value"
      return
    else
      warning "$label is a required field. Please enter a value."
    fi
  done
}

# Function to collect and validate information
collect_prompt_info() {
  local items="$1"
  json_array="[]"

  for item in $(convert_json_array_to_base64_array "$items"); do
    value=$(prompt_for_input "$item")
    if [[ "$value" == "q" ]]; then
      echo "[]"
      return 0
    fi

    json_object=$(
      create_prompt_item \
        "$(query_json64 "$item" '.name')" \
        "$(query_json64 "$item" '.label')" \
        "$(query_json64 "$item" '.description')" \
        "$value" \
        "$(query_json64 "$item" '.required')" \
        "$(query_json64 "$item" '.validate_fn')"
    )

    json_array=$(append_to_json_array "$json_array" "$json_object")
  done

  echo "$json_array"
}

# Function to confirm and modify prompt information
confirm_and_modify_prompt_info() {
  local json_array="$1"

  while true; do
    # Display collected information to stderr (for terminal)
    info "Provided values: "
    max_length=$(
      echo "$json_array" |
        jq -r '.[] | .name' |
        awk '{ print length }' |
        sort -nr | head -n1
    )

    formatted_length=$((max_length + PADDING))

    # Display the collected information with normalized name length
    echo "$json_array" |
      jq -r '.[] | "\(.name): \(.value)"' |
      while IFS=: read -r name value; do
        printf "  %-*s: %s\n" "$formatted_length" "$name" "$value" >&2
      done

    # Ask for confirmation (stderr)
    options="y) Yes, n) No, q) Quit, ? Show options"
    confirmation_msg="$(
      format "question" "Is the information correct? ($options) "
    )"
    read -rp "$confirmation_msg" confirmation

    case "$confirmation" in
    y)
      # Validate the confirmed data before returning
      for item in $(echo "$json_array" | jq -r '.[] | @base64'); do
        _jq() {
          echo "$item" | base64 --decode | jq -r "$1"
        }

        value=$(_jq '.value')
        validate_fn=$(_jq '.validate_fn')

        # Call validate_value function (ensure you have this function implemented)
        validation_output=$(validate_value "$value" "$validate_fn" 2>&1)

        if [[ $? -ne 0 ]]; then
          warning "Validation failed for '$value': $validation_output"
          echo "$json_array" | jq -r ".[] | select(.value == \"$value\")"
          continue # Continue looping to re-modify the invalid value
        fi
      done

      # If no validation failed, output the final JSON to stdout (for file capture)
      echo "$json_array"
      break
      ;;
    n)
      # Ask for the field to modify (stderr)
      field_query="$(
        format "question" "Which field would you like to modify? "
      )"
      read -rp "$field_query" field_to_modify

      # Check if the field exists in the JSON and ask for modification
      current_value=$(
        echo "$json_array" |
          jq -r \
            --arg field "$field_to_modify" \
            '.[] | select(.name == $field) | .value'
      )

      if [[ -n "$current_value" ]]; then
        info "Current value for $field_to_modify: $current_value"

        new_value_query="$(format "question" "Enter new value: ")"
        read -rp "$new_value_query" new_value

        if [[ -n "$new_value" ]]; then
          # Validate new value
          pattern=".[] | select(.name == \"$field_to_modify\") | .validate_fn"
          validate_fn=$(echo "$json_array" | jq -r "$pattern")
          validation_output=$(validate_value "$new_value" "$validate_fn" 2>&1)

          if [[ $? -ne 0 ]]; then
            warning "Validation failed for '$new_value': $validation_output"
            continue
          fi

          # Modify the JSON by updating the value of the specified field
          json_array=$(
            echo "$json_array" |
              jq \
                --arg field "$field_to_modify" \
                --arg value "$new_value" \
                '(.[] | select(.name == $field) | .value) = $value'
          )
        else
          error "Value cannot be empty."
        fi
      else
        warning "Field '$field_to_modify' not found."
      fi
      ;;
    q)
      exit 0
      ;;
    ?)
      # Show the options description again
      info "Options:"
      info "  y) Yes - Confirm the information is correct"
      info "  n) No - Modify a field in the information"
      info "  q) Quit - Exit the program"
      info "  ?) Show options - Display available options"
      ;;
    *)
      error "Invalid input. Please enter 'y', 'n', or 'q'."
      ;;
    esac
  done
}

create_prompt_item() {
  local name="$1"
  local label="$2"
  local description="$3"
  local value="$4"
  local required="$5"
  local validate_fn="${6-validate_empty_value}"

  # Check if the item is required and the value is empty
  if [[ "$required" == "yes" && -z "$value" ]]; then
    error_message="The value for '$name' is required but is empty."
    error_obj=$(create_error_item "$name" "$error_message" "${FUNCNAME[0]}")
    echo "$error_obj"
    return 1
  fi

  # Validate the value using the provided validation function
  validation_output=$(validate_value "$value" "$validate_fn" 2>&1)

  # If validation failed, capture the validation message
  if [[ $? -ne 0 ]]; then
    # Validation failed, use the validation message captured in validation_output
    error_obj=$(create_error_item "$name" "$validation_output" "$validate_fn")
    echo "$error_obj"
    return 1
  fi

  # Build the JSON object for the individual item
  item_json=$(echo "
    {
        \"name\": \"$name\",
        \"label\": \"$label\",
        \"description\": \"$description\",
        \"value\": \"$value\",
        \"required\": \"$required\",
        \"validate_fn\": \"$validate_fn\"
    }" | jq .)

  # Check if jq creation was successful
  if [[ $? -ne 0 ]]; then
    echo "Failed to create JSON object"
    return 1
  fi

  # Return the JSON object
  echo "$item_json"
}

# Function to process a JSON array and collect values into a JSON object
process_prompt_items() {
  local input_json="$1"
  local result_json="{"

  # Iterate over the array of prompt items in the input JSON
  for prompt_item in $(echo "$input_json" | jq -r '.[] | @base64'); do
    # Decode the base64 encoded JSON object for each item
    _jq() {
      echo "$prompt_item" | base64 --decode | jq -r "${1}"
    }

    # Extract values from the prompt item JSON
    name=$(_jq '.name')
    value=$(_jq '.value')

    # Check if the item creation was successful
    if [[ $? -eq 0 ]]; then
      # Append to result_json, using the 'name' as the key and 'value' as the value
      result_json+="\"$name\": \"$value\","
    else
      failure "Error processing item: $name"
      return 1
    fi
  done

  # Remove the trailing comma and close the JSON object
  result_json="${result_json%,}}"

  # Return the final JSON object
  echo "$result_json"
}

# Function to collect and validate information, then re-trigger collection for errors
run_collection_process() {
  local items="$1"
  local all_collected_info="[]"
  local has_errors=true

  # Keep collecting and re-requesting info for errors
  while [[ "$has_errors" == true ]]; do
    collected_info="$(collect_prompt_info "$items")"

    # If no values were collected, exit early
    if [[ "$collected_info" == "[]" ]]; then
      warning "No data collected. Exiting process."
      echo "[]"
      exit 0
    fi

    # Separate valid collection items and error objects
    labels='.name and .label and .description and .value and .required'
    collection_item_filter="[.[] | select($labels)]"
    valid_items=$(filter_items "$collected_info" "$collection_item_filter")

    error_item_filter="[.[] | select(.message and .function)]"
    error_items=$(filter_items "$collected_info" "$error_item_filter")

    # Ensure valid JSON formatting by stripping any unwanted characters
    valid_items_json=$(echo "$valid_items" | jq -c .)
    all_collected_info_json=$(echo "$all_collected_info" | jq -c .)

    # Merge valid items with previously collected information
    all_collected_info=$(add_json_objects "$all_collected_info" "$valid_items")

    # Step 1: Extract the names of items with errors from error_items
    error_names=$(echo "$error_items" | jq -r '.[].name' | jq -R -s .)

    # Step 2: Filter the original items to keep only those whose names match the error items
    pattern='[.[] | select(.name as $item_name | $error_names | index($item_name))]'
    items_with_errors=$(echo "$items" | jq --argjson error_names "$error_names" "$pattern")

    # Check if there are still errors left
    if [[ "$(echo "$error_items" | jq 'length')" -eq 0 ]]; then
      has_errors=false
    else
      # If there are still errors, re-trigger the collection process for error items only
      warning "Re-collecting information for items with errors..."
      display_error_items "$error_items"

      items="$items_with_errors"
    fi
  done

  # Step to sort the collected information by the original order (using 'name' for sorting)
  all_collected_info="$(
    sort_array_according_to_other_array "$all_collected_info" "$items" "name"
  )"

  # Return all collected and validated information
  confirmed_info="$(confirm_and_modify_prompt_info "$all_collected_info")"

  echo "$confirmed_info"
}

# Function to display each error item with custom formatting
display_error_items() {
  local error_items="$1" # JSON array of error objects

  # Parse and iterate over each error item in the JSON array
  echo "$error_items" |
    jq -r '.[] | "\(.name): \(.message) (Function: \(.function))"' |
    while IFS= read -r error_item; do
      # Display the error item using the existing error function
      error "$error_item"
    done
}

wait_for_input() {
  local timeout="$1"                                        # Timeout is the first argument
  local prompt_message="${2:-Press any key to continue...}" # Default prompt message if not provided

  # Format the message
  prompt_message="$(format "question" "$prompt_message")"

  # Display the prompt message
  echo -n "$prompt_message" >&2 # Display the message without a newline

  if [[ -n "$timeout" ]]; then
    # Countdown loop for the timeout
    for ((i = timeout; i > 0; i--)); do
      echo -ne "\r${prompt_message} (${i}s remaining)" >&2
      read -n 1 -s -t 1 user_input && {
        echo >&2
        return 0
      } # Exit on key press
    done
    # Erasing the line content
    echo -e "\r${prompt_message}" >&2 # Timeout message
    return 1                          # Timeout
  else
    # Wait for key press without a timeout
    read -n 1 -s user_input
    echo >&2
    return 0
  fi
}

# Function to prompt user and wait for any key press
press_any_key() {
  # Prompt user and wait for any key press
  echo -e "${highlight_color}Press any key to continue...${normal}"

  # Wait for a single key press without the need to press Enter
  read -n 1 -s # -n 1 means read one character, -s means silent mode (no echo)

  # Newline for better readability after key press
  echo ""
}

# Function to handle exit codes and display success or failure messages
handle_exit() {
  local exit_code="$1"
  local current_step="$2" # Current step index (e.g., 3)
  local total_steps="$3"  # Total number of steps (e.g., 4)
  local message="$4"      # Descriptive message for success or failure

  # Validate that current step is less than or equal to total steps
  if [ "$current_step" -gt "$total_steps" ]; then
    warning "Current step ($current_step) exceeds total steps ($total_steps)."
  fi

  local status="success"
  local status_message="$message succeeded"

  if [ "$exit_code" -ne 0 ]; then
    status="error"
    status_message="$message failed"
    error "Error Code: $exit_code"
  fi
  step "$current_step" "$total_steps" "$status_message" "$status"
}

# Function to escape special characters in a string
escape_sed_special_chars() {
  local input="$1"
  # Escape &, /, and \ characters, and handle newlines
  echo "$input" | sed -e 's/[\/&]/\\&/g' -e 's/\\/\\\\/g' | tr '\n' '\\n'
}

####################################################################################################

######################################## BEGIN OF MENU UTILS #######################################

# Function to get the label of a menu item
get_menu_item_label() {
  local menu_item="$1"
  query_json_value "$menu_item" ".label"
}

# Function to get the description of a menu item
get_menu_item_description() {
  local menu_item="$1"
  query_json_value "$menu_item" '.description'
}

# Function to get the action of a menu item
get_menu_item_action() {
  local menu_item="$1"
  query_json_value "$menu_item" '.action'
}

# Function to display a message, move the cursor, and read user input with an optional timeout
request_input() {
  local message="$1"
  local variable_name="$2"
  local timeout="$3"

  echo -ne "$message" >&2

  # Use read with or without timeout
  if [[ -n "$timeout" ]]; then
    read -rsn1 -t "$timeout" "$variable_name" || eval "$variable_name=''"
  else
    read -rsn1 "$variable_name"
  fi

  # Trim leading/trailing spaces
  eval "$variable_name=\$(echo -n \"\${$variable_name}\" | tr -d '[:space:]')"
}

# Function to request confirmation (yes/no)
request_confirmation() {
  local message="$1"
  local default_value="${2:-y}"
  local timeout="$3"

  local user_input=''
  request_input "$message" user_input "$timeout"

  # Use default value if input is empty
  if [[ -z "$user_input" ]]; then
    user_input="$default_value"
  fi

  # Validate the input
  while [[ ! "$user_input" =~ ^[yYnN]$ ]]; do
    error "\nInvalid input \"$user_input\". Please enter 'y' for yes or 'n' for no."
    user_input=''
    request_input "$message" user_input "$timeout"
    if [[ -z "$user_input" ]]; then
      user_input="$default_value"
    fi
  done

  # Normalize the input to lowercase and trim spaces
  echo "$user_input" | tr '[:upper:]' '[:lower:]'
}

# Function to display invalid input message
display_invalid_input_message() {
  local input=$1
  local prompt_message=$2

  reason="Invalid input \"$input\""
  select_options="Please enter 'y' for yes or 'n' for no."
  invalid_message="$reason\n$select_options\n"

  # Print the invalid message
  error "$invalid_message"
  echo -ne "${faded_color}$prompt_message${reset_color}" >&2
}

# Function to handle confirmation prompt
handle_confirmation_prompt() {
  local prompt_message=$1
  local default_value=${2:-false}
  local timeout=$3

  while true; do
    # Request confirmation from the user
    confirm_var=$(
      request_confirmation "$prompt_message" "$default_value" "$timeout"
    )

    # Validate input
    case "$confirm_var" in
    [yY]) return 0 ;; # Confirmed
    [nN]) return 1 ;; # Declined
    *) display_invalid_input_message "$confirm_var" "$prompt_message" ;;
    esac
  done
}

# Function to truncate option text to a max length
truncate_option() {
  local option="$1"
  local max_length="${2-$TRUNCATED_DEFAULT_LENGTH}"
  if [[ ${#option} -gt $max_length ]]; then
    echo "${option:0:$((max_length - 3))}..."
  else
    echo "$option"
  fi
}

# Function to calculate total pages
calculate_total_pages() {
  local total_items="$1"    # Total number of items
  local items_per_page="$2" # Number of items per page

  # Calculate total pages, rounding up if necessary
  total_pages=$(((total_items + items_per_page - 1) / items_per_page))

  echo "$total_pages"
}

# Function to check if the current item is the first item on the page
is_first_page_item() {
  local current_item="$1" # Current item number (0-based index)
  local items_per_page="$2"

  # Check if the current item is the first item on the page
  # First items are those which are of the form: 0, p, 2p+1, 3p+2, ...
  local first_item_mod=$((current_item % items_per_page))
  if [ "$first_item_mod" -eq 0 ]; then
    echo "1" # Return 1 (true)
  else
    echo "0" # Return 0 (false)
  fi
}

# Function to check if the current item is the last item on the page
is_last_page_item() {
  local current_item="$1"   # Current item number (0-based index)
  local items_per_page="$2" # Items per page
  local total_items="$3"    # Total number of items

  # Calculate the last item index of the current page (0-based)
  # Last items are those which are of the form: p-1, 2p, 3p+1, ...
  local last_item_mod=$(((current_item + 1) % items_per_page))
  if [ "$last_item_mod" -eq 0 ] || [ "$current_item" -eq "$((total_items - 1))" ]; then
    echo "1" # Return 1 (true)
  else
    echo "0" # Return 0 (false)
  fi
}

# Function to check if there is movement to a new page
is_new_page_handler() {
  local key="$1"
  local current_idx="$2"
  local num_options="$3"
  local page_size="$4"

  # Calculate total pages
  local total_pages=$(((num_options + page_size - 1) / page_size)) # ceiling division
  local more_than_one_page=$((total_pages > 1))

  # Get booleans for navigation keys
  local move_up_bool=$(to_integer "$(set_move_boolean "$key" "$up_key")")
  local move_down_bool=$(to_integer "$(set_move_boolean "$key" "$down_key")")
  local move_left_bool=$(to_integer "$(set_move_boolean "$key" "$left_key")")
  local move_right_bool=$(to_integer "$(set_move_boolean "$key" "$right_key")")

  # Check for first and last page items
  is_first_page_item_bool=$(is_first_page_item "$current_idx" "$page_size")
  is_last_page_item_bool=$(is_last_page_item "$current_idx" "$page_size" "$num_options")

  # Determine if there is movement to a new page
  local move_sideways=$((move_left_bool || move_right_bool))
  local move_up_first_page=$((is_first_page_item_bool && move_up_bool))
  local move_down_last_page=$((is_last_page_item_bool && move_down_bool))

  # Determine if it's a new page
  local is_new_page=$((\
    more_than_one_page && (\
    move_sideways || move_down_last_page || move_up_first_page)))

  # Output result
  echo "$is_new_page"
}

# Custom function to join an array into a single string with a delimiter
join_array() {
  local delimiter="$1"
  shift
  local array=("$@")
  local result=""

  for item in "${array[@]}"; do
    if [ -z "$result" ]; then
      result="$item"
    else
      result+="$delimiter$item"
    fi
  done

  echo "$result"
}

# Improved and fancy header display using '=' and '|', with colorized minus signs
show_header() {
  local header="$1"
  local width=${2:-$HEADER_WIDTH} # Default width to 50 if not provided
  local border_color="\033[1;34m" # Blue border color
  local header_color="\033[1;37m" # White text for header
  local reset_color="\033[0m"     # Reset color

  # Create the top and bottom border with colorized minus signs
  local border=$(printf '%*s' $((width - 2)) '' | tr ' ' '-')
  local colorized_lu_border="${border//-/${border_color}-}"

  # Print top border
  echo -e "${border_color}+${reset_color}${colorized_lu_border}${border_color}+${reset_color}"

  # Print header with padding
  local colorized_side_border="${border_color}|${reset_color}"
  local colorized_header="${header_color}${header}${reset_color}"
  local left_padding=$(((width - ${#header}) / 2))
  local right_padding=$((width - ${#header} - left_padding - 2))
  local spaced_header="$(
    printf '%*s' $left_padding ''
  )$colorized_header$(printf '%*s' $right_padding '')"

  # Print the header inside borders
  printf "${colorized_side_border}${spaced_header}${colorized_side_border}\n"

  # Print bottom border
  echo -e "${border_color}+${reset_color}${colorized_lu_border}${border_color}+${reset_color}"
}

# Define individual menu item
build_menu_item() {
  local label="$1"
  local description="$2"
  local action="$3"

  # Validate inputs
  if [ -z "$label" ] || [ -z "$action" ]; then
    echo "Error: Missing argument(s). Arguments (label, action) are required." >&2
    return 1
  fi

  # Generate JSON object using jq directly
  jq -n \
    --arg label_ "$label" \
    --arg description_ "$description" \
    --arg action_ "$action" \
    '{
        label: $label_,
        description: $description_,
        action: $action_
    }'
}

# Remove one of the redundant build_menu functions
build_menu() {
  local key="$1"
  shift
  local title="$1"
  shift
  local page_size="$1"
  shift
  local json_array

  if [ $# -eq 0 ]; then
    echo "Error: At least one menu item is required."
    return 1
  fi

  # Build the menu as a JSON array
  menu_items=$(build_array_from_items "$@")

  # Create final menu object
  jq -n \
    --arg key "$key" \
    --arg title "$title" \
    --arg page_size "$page_size" \
    --argjson items "$menu_items" \
    '{
      key: $key,
      title: $title,
      page_size: $page_size,
      items: $items
    }'
}

# Append a menu object to the MENUS array
define_menu() {
  local menu_object="$1"
  key="$(echo "$menu_object" | jq -r '.key')"

  MENUS["$key"]+="$menu_object"
}

# Function to get the current menu
get_current_menu() {
  if [ ${#menu_navigation_history[@]} -gt 0 ]; then
    echo "${menu_navigation_history[-1]}"
  fi
}

# Function to get a specific menu
get_menu() {
  echo "${MENUS[$1]}"
}

# Modify push_menu to accept multiple levels of nesting
push_menu_in_history() {
  if [[ -n "$1" ]]; then
    menu_navigation_history+=("$1")
  else
    echo "Invalid menu name. Cannot push an empty menu."
  fi
}

# Pop menu from stack
pop_menu_from_history() {
  if [ ${#menu_navigation_history[@]} -gt 0 ]; then
    unset menu_navigation_history[-1]
  fi
}

# Function to reset the menu navigation history
reset_menu_navigation_history() {
  menu_navigation_history=("main")
}

# Helper function to check if a menu is already in the stack
is_menu_in_history() {
  local menu_name=$1
  for menu in "${menu_navigation_history[@]}"; do
    if [[ "$menu" == "$menu_name" ]]; then
      return 0 # menu found
    fi
  done
  return 1 # menu not found
}

# Return to the parent menu (previous menu)
return_to_parent_menu() {
  if [ ${#menu_navigation_history[@]} -gt 1 ]; then
    pop_menu
    local parent_menu=$(get_current_menu)
    navigate_menu "$parent_menu"
  else
    navigate_menu "main"
  fi
}

# Build a JSON array of menu items
build_array_from_items() {
  # Capture all arguments as an array
  local items=("$@")

  echo "["$(join_array "," "${items[@]}")"]"
}

# Function to calculate the page number
index_to_page() {
  local current_index="$1"
  local page_size="$2"

  # Check for valid inputs
  if [[ -z "$current_index" || -z "$page_size" || "$page_size" -le 0 ]]; then
    echo "Invalid arguments: current_index=$current_index, page_size=$page_size" >&2
    return 1
  fi

  # Calculate the page number (zero-indexed)
  local page_number=$((current_index / page_size + 1))

  # Output the calculated page number
  echo "$page_number"
}

# Function to move the cursor
move_cursor() {
  tput cup "$1" "$2" > /dev/tty
}

# Function to clear everything below a specific line
clear_below_line() {
  local line=$1

  # Move the cursor to the desired line (line is zero-indexed)
  move_cursor "$line" 0

  # Clear everything below the current line
  tput ed > /dev/tty
}

# Function to clear everything between two lines
clear_between_lines() {
  local start_line=$1
  local end_line=$2

  for (( line=start_line; line<=end_line; line++ )); do
    move_cursor "$line" 0
    tput el > /dev/tty
  done
}

# Function to calculate the arrow position in the terminal
get_arrow_position() {
  local current_idx="$1"
  local page_size="$2"
  local header_height="$3"

  # Calculate the start index for the current page
  local start=$((current_idx / page_size * page_size))

  # Calculate the arrow row position based on header lines and current item
  local arrow_row=$((header_height + (current_idx - start)))

  echo "$arrow_row"
}

# Function to process all lines in parallel and maintain order
display_parallel() {
  local -n _lines=$1 # Array passed by reference
  local -a pids=()   # Array to hold process IDs

  # Process each line in parallel
  for i in "${!_lines[@]}"; do
    line="${_lines[i]}"
    {
      echo -e "$line"
    } &
    pids+=($!) # Store the process ID for each background process
  done

  # Wait for all processes to finish
  for pid in "${pids[@]}"; do
    wait "$pid"
  done
}

kill_current_pid() {
  # Start the scrolling message for the selected option
  if [[ "$current_pid" -ne 0 ]]; then
    kill "$current_pid" 2>/dev/null # Kill the previous background process
  fi
}

# Cleanup function to restore terminal state and stop background processes
cleanup() {
  tput cnorm # Restore cursor visibility
  kill_current_pid
  tput reset       # Reset terminal to a clean state
  echo -e '\e[5 q' # Restore cursor shape
}

# Function to display a great farewell message
farewell_message() {
  farewell_messages=(
    ""
    "🌟 Thank you for using the Deployment Tool $TOOL_NAME! 🌟"
    ""
    "Your journey doesn't end here: it's just a new beginning."
    "Remember: Success is the sum of small efforts, repeated day in and day out. 🚀"
    ""
    "We hope to see you again soon. Until then, happy coding and stay curious! ✨"
    ""
  )

  # Format the array of farewell messages
  format_array "celebrate" farewell_messages

  # Display the formatted messages
  display_parallel farewell_messages
}

# Function to finish the session
finish_session() {
  cleanup
  clean_screen
  farewell_message
  exit 0
}

# Function to shift a message in the background
shift_message() {
  local message="$1"
  local max_width="$2"
  local x_position="$3"
  local y_position="$4"
  local shifted_message="$message"
  local shift_offset=0

  tput civis # Hide the cursor
  while true; do
    # Prepare the shifted message
    local rotated_message="${shifted_message:shift_offset}${shifted_message:0:shift_offset}"
    rotated_message="${rotated_message:0:$max_width}"

    # Move cursor to the specified position and print the message
    tput cnorm
    tput cup "$y_position" "$x_position"
    printf "%-*s" "$max_width" "$rotated_message" > /dev/tty
    tput civis

    # Increment the shift offset
    ((shift_offset++))
    if [[ "$shift_offset" -ge ${#shifted_message} ]]; then
      shift_offset=0
    fi

    sleep 0.15
  done
}

# Function to start the scrolling message for the selected option
run_shift_message() {
  local current_idx="$1"
  local page_size="$2"
  local header_height="$3"
  local page_width="$4"
  local menu_options=("${@:5}")

  # Start the scrolling message for the selected option
  kill_current_pid

  # Get the current option
  current_option="${menu_options[current_idx]}"
  item_label="$(get_menu_item_label "$current_option")"
  item_description="$(get_menu_item_description "$current_option")"
  item_label_length="${#item_label}"

  # Calculate the arrow row position based on header lines and current item
  arrow_position="$(get_arrow_position "$current_idx" "$page_size" "2")"
  horizontal_shift=$((2 + item_label_length + 2))

  local pad=2
  shift_length="$((page_width - horizontal_shift + pad))"

  shift_message "$item_description " "$shift_length" "$horizontal_shift" "$arrow_position" &
  current_pid=$! # Store the background process ID
}

# Helper: Calculate the range of options to display
calculate_display_range() {
  local current_idx="$1"
  local page_size="$2"
  local num_options="$3"

  local start=$((current_idx / page_size * page_size))
  local end=$((start + page_size))
  end=$((end > num_options ? num_options : end))

  echo "$start $end"
}

# Helper: Render menu options
render_options() {
  local start="$1"
  local end="$2"
  local current_idx="$3"
  local header_height="$4"
  local page_width="$5"
  local menu_options=("${@:6}")

  local menu_lines=()

  for i in $(seq $start $((end - 1))); do
    option_label=$(get_menu_item_label "${menu_options[i]}")
    option_desc=$(get_menu_item_description "${menu_options[i]}")

    truncation_length="$((page_width - 2 - ${#option_label}))"
    truncated_desc="$(truncate_option "$option_desc" "$truncation_length")"

    if [[ -z "$option_desc" ]]; then
      option="${option_label}"
    else
      option="${option_label}: ${truncated_desc}"
    fi

    menu_lines+=("$option")
  done


  # Fill remaining space if fewer items than page size
  local remaining_space=$((page_size - end + start))
  for _ in $(seq 1 $remaining_space); do
    menu_lines+=(" ")
  done

  # Render each menu line
  for i in "${!menu_lines[@]}"; do
    tput cup $((i + header_height)) 0
    local menu_line="${menu_lines[$i]}"
    if [[ $((start + i)) -eq $current_idx ]]; then
      echo -e "${COLORED_ARROW} ${menu_line}" >&2
    else
      echo -e "  ${menu_line} " >&2
    fi
  done
}

# Function to print a centered header with customizable width
print_centered_header() {
  local text="$1"
  local width="$2"
  local padding

  # Calculate padding for centering
  padding=$(((width - ${#text}) / 2))

  # Print the header with padding
  printf "%-${padding}s" " " # Left padding
  echo -e "${bold}${green}${text}${normal}"
  printf "%-${padding}s" " " # Right padding
}

# Render breadcrumb trail with each node separated by ' > '
render_breadcrumb() {
  local breadcrumb=""

  # Loop through each menu node in the history
  for menu in "${menu_navigation_history[@]}"; do
    # Extract the last part after the last colon
    last_part="${menu##*:}"

    # Append it to the breadcrumb with ' > ' separator
    breadcrumb+="$last_part > "
  done

  # Remove the trailing ' > ' from the breadcrumb
  breadcrumb=${breadcrumb% > }

  # Display the breadcrumb
  echo -e "${highlight_color}Current Path: ${breadcrumb}${reset_color}" >&2
}

# Helper: Render the footer with page count and navigation
render_footer() {
  local current_idx="$1"
  local page_size="$2"
  local menu_width="$3"
  local num_options="$4"
  local keyboard_options_string="$5"

  local total_pages=$(((num_options + page_size - 1) / page_size))
  local current_page=$((current_idx / page_size + 1))
  local page_text="Page $current_page/$total_pages"

  # Display keyboard options
  tput cup $((page_size + 3)) 0
  echo -e "$keyboard_options_string" >&2

  tput cup $((page_size + 4)) 0
  render_breadcrumb

  # Display page text
  tput cup $((page_size + 5)) 0
  echo -e "\n$(display_text "$page_text" "$menu_width" --center)" >&2
  tput cup $((page_size + 6)) 0
}

# Main: Render the menu with the given parameters
render_menu() {
  local title="$1"
  local current_idx="$2"
  local page_size="$3"
  local is_new_page="$4"
  local menu_options=("${@:5}")

  local menu_height=0

  # Disable keyboard input temporarily
  stty -echo -icanon
  tput civis

  trap "stty echo icanon; tput cnorm; exit" SIGINT SIGTERM EXIT

  move_cursor 0 0

  local num_options=${#menu_options[@]}

  # Prepare keyboard shortcuts
  local ud_nav_option="${highlight_color}↗↘${reset_color}: Nav"
  local sel_nav_option="${select_color}↵${reset_color}: Sel"
  local lr_nav_option=""
  local goto_nav_option=""
  local back_option="${back_color}r${reset_color}: Return"
  local search_option="${search_color}/${reset_color}: Search"
  local help_option="${help_color}h${reset_color}: Help"
  local quit_option=""

  if ((num_options > page_size)); then
    lr_nav_option="${highlight_color}◁▷${reset_color}: Pages"
  fi

  if ((num_options / page_size > 1)); then
    goto_nav_option="${goto_color}g${reset_color}: Go to Page"
  fi

  current_menu_name="$(get_current_menu)"
  if [[ $current_menu_name == "main" ]]; then
    quit_option="${quit_color}q${reset_color}: Quit"
  else
    quit_option="${quit_color}q${reset_color}: Back"
  fi

  # Combine keyboard options
  local keyboard_options=(
    "$ud_nav_option"
    "$sel_nav_option"
    "$search_option"
    "$back_option"
    "$help_option"
  )

  # Conditionally add non-empty options
  [[ -n "$lr_nav_option" ]] && keyboard_options+=("$lr_nav_option")
  [[ -n "$goto_nav_option" ]] && keyboard_options+=("$goto_nav_option")
  [[ -n "$quit_option" ]] && keyboard_options+=("$quit_option")

  local keyboard_options_string=$(join_array ", " "${keyboard_options[@]}")
  local keyboard_options_length=${#keyboard_options_string}

  local tmp="$(strip_color "$keyboard_options_string")"
  local page_width="${#tmp}"

  # Handle new page rendering
  if [[ "$is_new_page" == "1" ]]; then
    clear
    render_header "$title" "$page_width"
  fi

  header_height="$(get_header_height "$title" "$page_width")"
  header_height="$(strip_ansi "$header_height")"
  header_height="$(strip_color "$header_height")"

  # Render header
  ((menu_height+= (header_height+1)))

  # Determine the range of options to display
  local range
  range=$(\
    calculate_display_range "$current_idx" "$page_size" "$num_options"\
  )

  local start end
  read -r start end <<<"$range"

  # Render menu options
  start_index="$((header_height+1))"
  end_index="$((header_height + 1 + page_size))"

  if [[ "$is_new_page" == "1" ]]; then
    clear_between_lines "$start_index" "$end_index"
  fi
  move_cursor "$start_index" 0

  render_options "$start" "$end" "$current_idx" \
    "$header_height" "$page_width" "${menu_options[@]}"

  ((menu_height+=$page_size))

  move_cursor "$((menu_height + 1))" 0

  # Render footer
  if [[ "$is_new_page" == "1" ]]; then
    render_footer "$current_idx" "$page_size" "$page_width" \
        "$num_options" "$keyboard_options_string"
  else
    move_cursor "$((menu_height + 4))" 0
  fi
  
  ((menu_height+=4))

  # Handle option-specific description
  local current_item_description
  current_item_description=$(get_menu_item_description "${menu_options[$current_idx]}")
  current_item_label=$(get_menu_item_label "${menu_options[$current_idx]}")

  local desc_length=${#current_item_description}
  local label_length=${#current_item_label}

  menu_width=$((2 + desc_length + 2 + label_length))

  # FIXME: Shift message is not working :-(
  #if [[ "$menu_width" -gt "$page_width" ]]; then
  #  run_shift_message "$current_idx" "$page_size" "$header_height" "$page_width" "${menu_options[@]}"
  #else
  #  kill_current_pid
  #fi

  # Re-enable keyboard input
  stty echo icanon
  
  # Restores the cursor visibility
  tput cnorm

  trap - SIGINT SIGTERM EXIT # Clear trap

  echo $menu_height
}

# Helper: Handle arrow key input
handle_arrow_key() {
  local key="$1"
  local current_idx="$2"
  local num_options="$3"
  local page_size="$4"
  local total_pages="$5"

  case "$key" in
  "$up_key")
    if ((current_idx > 0)); then
      ((current_idx--))
    else
      current_idx=$((num_options - 1)) # Wrap to the last option
    fi
    ;;

  "$down_key")
    if ((current_idx < num_options - 1)); then
      ((current_idx++))
    else
      current_idx=0 # Wrap to the first option
    fi
    ;;

  "$left_key")
    if ((total_pages > 1)); then
      if ((current_idx - page_size >= 0)); then
        # Navigate to the previous page
        current_idx=$(((current_idx / page_size - 1) * page_size))
      else
        # Wrap to the last page
        current_idx=$((((num_options - 1) / page_size) * page_size))
      fi
    fi
    ;;

  "$right_key")
    if ((total_pages > 1)); then
      next_page_start=$(((current_idx / page_size + 1) * page_size))
      if ((next_page_start < num_options)); then
        current_idx=$next_page_start # Move to the next page
      else
        current_idx=0 # Wrap to the first page
      fi
    fi
    ;;
  esac

  echo "$current_idx"
}

# Function to validate page number
validate_page_number() {
  local page_number="$1"
  local max_page="$2"

  if ! [[ "$page_number" =~ ^[1-9][0-9]*$ ]]; then
    echo "Invalid input! Must be a number."
    return 1
  elif ((page_number > max_page)); then
    echo "Page number out of range!"
    return 1
  fi
  return 0
}

# Function to navigate to a specific page
go_to_specific_page() {
  local current_idx="$1"
  local page_size="$2"
  local title="$3"
  local is_new_page="$4"
  shift 5
  local menu_options=("$@")

  num_options=${#menu_options[@]}

  # Input page number
  while true; do
    echo -ne "${faded_color}Enter the page number: ${reset_color}" >&2
    read -r page_number

    # Validate page number
    if validate_page_number "$page_number" "$(((num_options - 1) / page_size + 1))"; then
      break
    else
      echo -e "${error_color}Invalid page number! Please try again.${reset_color}" >&2
    fi
  done

  # Update current index to new page
  current_idx=$((page_number * page_size))
  render_menu "$title" "$current_idx" "$page_size" "$is_new_page" "${menu_options[@]}"

  # Prompt to return to the previous menu
  while true; do
    message="Would you like to return to the previous menu? (y/n): "
    echo -ne "${faded_color}$message${reset_color}" >&2
    read -r go_back_choice
    case "$go_back_choice" in
    [yY])
      current_idx=$previous_idx
      break
      ;;
    [nN])
      break
      ;;
    *)
      echo -e "${error_color}Invalid choice! Please enter 'y' or 'n'.${reset_color}" >&2
      ;;
    esac
  done

  echo "$current_idx"
}

# Function to handle enter key
handle_enter_key() {
  local menu_item="${menu_options[current_idx]}"

  option_label="$(get_menu_item_label "$menu_item")"
  question="Are you sure you want to select \"$option_label\"? (Y/n)"
  message="${faded_color}$question${reset_color}"
  if handle_confirmation_prompt "$message" 'y'; then
    option_action=$(get_menu_item_action "$menu_item")

    clean_screen
    kill_current_pid

    message="\n${faded_color}Operation interrupted. Exiting script...${reset_color}"
    command="clean_screen; error \"$message\"; wait_for_input; cleanup; clean_screen; return"
    trap "$command" SIGINT

    (eval "$option_action") || echo -e "$message"
    sleep 1

    trap - SIGINT

    clean_screen
  fi
}

handle_quit_key() {
  local confirm_exit

  message="${faded_color}Are you sure you want to exit this menu? (y/n)${reset_color}"
  confirm_exit="$(request_confirmation "$message" "y")"

  if [[ "${confirm_exit}" == "y" || "${confirm_exit}" == "Y" ]]; then
    clean_screen
    current_menu=$(get_current_menu)
    pop_menu_from_history
    previous_menu=$(get_current_menu)

    if [[ "$current_menu" == "main" ]]; then
      message="${faded_color}Exiting program.${reset_color}"
    else
      last_menu_label="${previous_menu##*:}"

      message="${faded_color}Returning to $last_menu_label menu.${reset_color}"
    fi

    echo -e "$message" >&2
    sleep 0.1

    return 0
  fi

  return 1
}

# Enhanced animated transition between menus with spinning loader and text effects
transition_to_menu() {
  local new_menu="$1"
  local progress_bar=""
  local progress_length=30
  local colors=("\033[1;34m" "\033[1;32m" "\033[1;36m" "\033[1;35m" "\033[1;31m")
  local spin_chars=('/' '-' '\\' '|')

  # Clear the line and show the initial transition message
  echo -ne "\r${colors[0]}Transitioning to ${new_menu}... ${reset_color}" >&2

  for ((i = 0; i < progress_length; i++)); do
    # Update the progress bar
    progress_bar+="="

    # Cycle through colors for a smooth transition effect
    color_index=$((i % ${#colors[@]}))

    # Add spinning loader
    spin_index=$((i % ${#spin_chars[@]}))
    spin_char="${spin_chars[$spin_index]}"

    message="${spin_char} Transitioning to ${new_menu}... [${progress_bar}]"
    echo -ne "\r${colors[color_index]}$message${reset_color}" >&2

    # Delay to create the animation effect
    sleep 0.04
  done

  # Finalize the transition with a fade-in effect
  message="${spin_char} Transitioning to ${new_menu}... [${progress_bar}] Done!"
  echo -ne "\r${highlight_color}$message${reset_color}\n" >&2
  sleep 0.1
}

# Function to navigate to a specific menu
navigate_menu() {
  local menu_name="$1"

  menu_json=$(get_menu "$menu_name") || {
    error "Failed to load menu ${menu_name}" >&2
    return 1
  }

  menu_title=$(echo "$menu_json" | jq -r '.title')

  clean_screen
  transition_to_menu "$menu_title"
  clean_screen

  # If the menu_navigation_history is empty, set the first menu as the current menu
  if ! is_menu_in_history "$menu_name"; then
    push_menu_in_history "$menu_name"
  fi

  local title page_size menu_items_json
  local menu_options=()
  local debounce_time=0.25

  title=$(jq -r '.title' <<<"$menu_json")
  page_size=$(jq -r '.page_size' <<<"$menu_json")
  menu_items_json=$(jq -r '.items' <<<"$menu_json")

  # Convert JSON array to Bash array
  while IFS= read -r item; do
    menu_options+=("$item")
  done < <(jq -r '.[] | @json' <<<"$menu_items_json")

  local original_menu_options=("${menu_options[@]}")
  local num_options=${#menu_options[@]}

  local total_pages is_new_page=1 previous_idx=0 current_idx=0

  if [[ $num_options -eq 0 ]]; then
    error "No options provided to the menu!"
    exit 1
  fi

  while true; do
    menu_height=$(\
      render_menu "$title" "$current_idx" "$page_size" "$is_new_page" "${menu_options[@]}"\
    )

    menu_height="$(strip_ansi "$menu_height")"

    # Locking the keyboard input to avoid unnecessary display of captured characters
    read -rsn1 user_key

    # Remove ANSI escape sequences (matches sequences like ESC [ ... m)
    menu_height=$(strip_ansi "$menu_height")

    # Now remove any non-digit characters
    menu_height="${menu_height//[!0-9]/}"

    # Stop the background process
    kill_current_pid

    # Dynamically calculate the vertical position for the message
    num_options=${#menu_options[@]}
    total_pages="$(calculate_total_pages "$num_options" "$page_size")"

    # Save for later usage
    previous_idx=$current_idx

    case "$user_key" in
    $'\x1B') # Detect escape sequences (e.g., arrow keys)
      read -rsn2 -t "$debounce_time" user_key

      is_new_page=$(is_new_page_handler "$user_key" "$current_idx" "$num_options" "$page_size")

      # Call the function to handle arrow key input
      current_idx=$(
        handle_arrow_key "$user_key" \
          "$current_idx" "$num_options" "$page_size" "$total_pages"
      )
      ;;

      # Go to specific page
    "g")
      previous_idx="$current_idx"

      current_idx="$(
        go_to_specific_page "$current_idx" \
          "$page_size" "$title" "$is_new_page" "$menu_options"
      )"

      is_new_page="$current_idx"!="$previous_idx"
      ;;

      # Reset menu options
    "r")
      menu_options=("${original_menu_options[@]}")
      current_idx=0
      continue
      ;;

      # Start search
    "/")
      echo -ne "${faded_color}Search: ${reset_color}" >&2
      read -e -r search_key

      # Clear the line if the prompt disappears after backspace
      echo -ne "\033[2K\r"

      # Reset to original options if 'r' is pressed
      if [[ "$search_key" == "r" ]]; then
        menu_options=("${original_menu_options[@]}")
        current_idx=0 # Reset the index to 0 if 'r' is pressed
        return
      fi

      local filtered_options=()
      shopt -s nocasematch
      for option in "${original_menu_options[@]}"; do
        # Extract label and description using jq
        label=$(echo "$option" | jq -r '.label // empty')
        description=$(echo "$option" | jq -r '.description // empty')

        # Match search_key against label or description
        if [[ "$label" == *"$search_key"* || "$description" == *"$search_key"* ]]; then
          filtered_options+=("$option")
        fi
      done

      # Turn it off after the loop
      shopt -u nocasematch

      # If no matches, reset to original options
      if [[ ${#filtered_options[@]} -eq 0 ]]; then
        menu_options_ref=("${original_menu_options[@]}")
        warning "No matches found, resetting to original options."
        sleep 0.5
      else
        # Update filtered options and reset index
        menu_options=("${filtered_options[@]}")

        # Reset the index after filtering
        current_idx=0
      fi

      is_new_page=1
      ;;

      # Show help
    "h")
      show_help "$num_options" "$page_size"
      sleep 2
      ;;

      # Enter key (select option)
    "")
      echo >&2
      handle_enter_key "${menu_options[current_idx]}"
      is_new_page=1
      ;;

      # Exit menu
    "q")
      handle_quit_key

      if [[ "$?" -eq 0 ]]; then
        break
      else
        continue
      fi
      ;;

    *)
      echo >&2
      shoutout="Invalid key pressed!"
      keyboard_options="Please use ↑/↓ to navigate, ←/→ to switch pages, or Enter to select."
      error "$shoutout $keyboard_options"
      sleep 0.5
      ;;
    esac

    move_cursor 0 0 
    clear_below_line $menu_height
  done

  return 0
}

######################################### END OF MENU UTILS ########################################

################################## BEGIN OF DOCKER DEPLOYMENT UTILS ################################

# Function to map stacks to services and convert to JSON object
map_stacks_to_services() {
  # Fetch all stacks
  stacks=($(docker stack ls --format "{{.Name}}"))

  # Initialize an empty JSON object for the stack to service mapping
  json_object='{}'

  # Check if there are any stacks in the swarm
  if [ ${#stacks[@]} -eq 0 ]; then
    echo "No stacks found in the swarm."
    exit 0
  fi

  # Loop through each stack to list its services and build the JSON object
  for stack in "${stacks[@]}"; do
    # Fetch the services for the current stack
    services=($(docker stack services "$stack" --format "{{.Name}}"))

    # Initialize an empty JSON array to store services for the current stack
    services_json_array='[]'

    # Append each service to the JSON array
    for service in "${services[@]}"; do
      services_json_array=$(append_to_json_array "$services_json_array" "\"$service\"")
    done

    # Add the services JSON array to the main JSON object under the stack key
    json_object=$(echo "$json_object" | jq ". + {\"$stack\": $services_json_array}")
  done

  # Output the final JSON object
  echo "$json_object"
}

# Function to wait for all services to be healthy using docker service ps
wait_for_services() {
  local stack_name="$1"

  local timeout=300
  local interval=5
  local elapsed=0

  timout_min="$((timeout / 60))"

  # Get the list of service names from the docker-compose setup (in swarm mode)
  services=$(docker stack services --format '{{.Name}}' "$stack_name")

  start_time=$(date +%s) # Record the start time
  while true; do
    all_healthy=true
    for service in $services; do
      # Get the current state of the service using docker service ps
      service_state=$(
        docker service ps \
          --filter "desired-state=running" \
          --format "{{.CurrentState}}" "$service" |
          grep -o "Running"
      )

      # If the service is not running or not in the "Running" state
      if [[ -z "$service_state" ]]; then
        all_healthy=false
        current_time=$(date +%s)
        elapsed=$(((current_time - start_time) / 60)) # Convert to minutes
        time_info="elapsed time: ${elapsed} minutes (timeout: ${timeout_min} minutes)."
        info "Service '$service' is not healthy yet. Waiting... $time_info"
        break
      fi
    done

    # If all services are healthy, exit the loop
    if [[ "$all_healthy" == true ]]; then
      success "All services of stack $stack_name are healthy!"
      break
    fi

    # Check if we've exceeded the timeout
    current_time=$(date +%s)
    elapsed=$((current_time - start_time)) # Elapsed time in seconds
    if ((elapsed >= timeout)); then
      failure "Timeout reached! Not all services of stack $stack_name are healthy."
      exit 1
    fi

    # Sleep for the interval before checking again
    sleep "$interval"
  done
}

# Function to download stack compose templates with progress bar
download_stack_compose_templates() {
  local destination_folder="$TOOL_TEMPLATES_DIR"

  # Ensure the destination folder is provided
  if [[ -z "$destination_folder" ]]; then
    error "Destination folder not specified."
    return 1
  fi

  # Remove the destination folder if it already exists
  rm -rf "$destination_folder"

  # Create the destination folder if it doesn't exist
  mkdir -p "$destination_folder" || {
    error "Failed to create destination folder $destination_folder."
    return 1
  }

  info "Fetching file list from GitHub API..."
  # Fetch the file information from the API
  file_urls=$(
    curl -s -H "Accept: application/vnd.github.v3+json" "$TOOL_STACKS_TEMPLATE_URL" |
      jq -r '.[] | select(.type == "file") | .download_url'
  )

  # Check if files were found
  if [[ -z "$file_urls" ]]; then
    warning "No files found at $TOOL_STACKS_TEMPLATE_URL."
    return 1
  fi

  total_files=$(echo "$file_urls" | wc -l)

  # Prepare a variable to track failed downloads
  failed_downloads=()

  # Initialize the progress bar
  current=0

  # Prepare the failed download log file
  local failed_filename="$destination_folder/failed_downloads.txt"

  # Download all files in parallel with a progress bar
  {
    echo "$file_urls" | while read -r url; do
      {
        file_name=$(basename "$url")
        destination_file="$destination_folder/$file_name"

        # Download the file and handle errors
        if ! curl -s --fail -o "$destination_file" "$url"; then
          # Log the failed download with HTTP error message
          error_message=$(curl -s -w "%{http_code}" -o /dev/null "$url")
          failed_downloads+=(
            "$(date '+%Y-%m-%d %H:%M:%S') - $file_name - Error: HTTP $error_message"
          )
        fi
      } &
    done

    # Wait for all background processes to complete
    wait
    echo # Move to a new line after progress indicators
  } >/dev/null 2>&1

  # Wait for all background jobs to finish
  wait

  # Write failed downloads to the file
  if [[ ${#failed_downloads[@]} -gt 0 ]]; then
    for failed in "${failed_downloads[@]}"; do
      echo "$failed" >>"$failed_filename"
    done
  fi
}

# Function to list the services of a stack
list_stack_services() {
  local stack_name=$1
  declare -a services_array

  # Check if stack exists
  if ! docker stack ls --format '{{.Name}}' | grep -q "^$stack_name\$"; then
    error "Stack '$stack_name' does not exist."
    return 1
  fi

  info "Fetching services for stack: $stack_name"

  # Get the services associated with the specified stack and store them in an array
  services_array=($(docker stack services "$stack_name" --format '{{.Name}}'))

  # Optionally return the array as a result (useful if called from another script)
  echo "${services_array[@]}"
}

# Function to get the latest stable version
get_latest_stable_version() {
  local image_name=$1
  local base_url=""
  local current_url=""
  local total_count=0
  local stable_tags=()
  local latest_version=""

  # Set the correct base URL
  base_url="https://hub.docker.com/v2/repositories"
  if [ "$(is_official_image "$image_name")" == "true" ]; then
    base_url="$base_url/library/${image_name}/tags?page_size=100"
  else
    base_url="$base_url/${image_name}/tags?page_size=100"
  fi

  # Fetch the first page to determine total pages
  response=$(curl -fsSL "$base_url" || echo "")
  if [ -z "$response" ] || [ "$(echo "$response" | jq -r '.count')" == "null" ]; then
    warning "Image '$image_name' not found or registry unavailable."
    return 1
  fi

  total_count=$(echo "$response" | jq -r '.count')
  total_pages=$(((total_count + 99) / 100))

  # Perform binary search for latest stable version
  low=1
  high=$total_pages
  while [ $low -le $high ]; do
    mid=$(((low + high) / 2))
    current_url="${base_url}&page=$mid"

    # Fetch the page
    response=$(curl -fsSL "$current_url" || echo "")
    if [ -z "$response" ]; then
      # Skip to upper half if the page is invalid
      low=$((mid + 1))
      continue
    fi

    # Extract stable tags
    page_tags=$(fetch_stable_tags_from_page "$response")
    if [ -n "$page_tags" ]; then
      stable_tags+=($page_tags)

      # Search lower half for potentially newer tags
      high=$((mid - 1))
    else
      # Search upper half
      low=$((mid + 1))
    fi
  done

  # Find the latest stable version
  if [ ${#stable_tags[@]} -gt 0 ]; then
    latest_version=$(printf "%s\n" "${stable_tags[@]}" | sort -V | uniq | tail -n 1)
    echo "$latest_version"
    return 0
  else
    warning "No stable version found for $image_name."
    return 1
  fi
}

# Function to check if a stack exists by name
stack_exists() {
  local stack_name="$1"
  # Check if the stack exists by listing stacks and filtering by name
  if docker stack ls --format '{{.Name}}' | grep -q "^$stack_name$"; then
    return 0
  else
    return 1 # Stack does not exist
  fi
}

# Function to check if all stacks in an array exist
stacks_exist() {
  local stacks=("$@") # Array of stack names passed as arguments
  local all_exist=true
  local stack_name

  for stack_name in "${stacks[@]}"; do
    if ! stack_exists "$stack_name"; then
      all_exist=false
      break
    fi
  done

  if [ "$all_exist" = true ]; then
    return 0
  else
    return 1
  fi
}

# Function to get the URL of a stack
stack_url() {
  local stack_name="$1"
  local host='raw.githubusercontent.com'
  local organization='whosbash'
  local repository='stackme'
  local path="refs/heads/main/stacks/$stack_name.yaml"
  echo "https://${host}/${organization}/${repository}/${path}"
}

# Function to list the required fields on a stack docker-compose
list_stack_compose_required_fields() {
  local stack_name="$1"
  stack_template="${TOOL_TEMPLATES_DIR}/${stack_name}.yaml"
  cat "$stack_template" | grep -oP '\{\{\K[^}]+(?=\}\})' | sort -u

  if [[ $? -ne 0 ]]; then
    error "Failed to list required fields for stack $stack_name"
    return 1
  fi
}

# Function to rollback a stack
rollback_stack() {
  local stack_name="$1"

  docker stack rm "$stack_name"

  if [[ $? -ne 0 ]]; then
    failure "Rollback of stack $stack_name failed"
    return 1
  fi

  success "Rollback of stack $stack_name successful"
}

# Function to check if Docker Swarm is active
is_swarm_active() {
  local state=$(
    docker info --format '{{.Swarm.LocalNodeState}}' 2>/dev/null |
      tr -d '\n' | tr -d ' '
  )
  if [[ -z "$state" ]]; then
    warning "Swarm state is empty or undefined." >&2
    return 1
  fi
  if [[ "$state" == "active" ]]; then
    return 0
  else
    return 1
  fi
}

# Function to deploy a service using a Docker Compose file
deploy_stack_on_swarm() {
  local stack_name="$1"
  local compose_path="$2"

  # Ensure Python is installed
  if ! command -v python3 &>/dev/null; then
    error "Python3 is required but not installed. Please install it and try again."
    exit 1
  fi

  # Deploy the service using Docker stack
  docker stack deploy \
    --detach=false --prune --resolve-image always \
    -c "$compose_path" "$stack_name"

  if [ $? -eq 0 ]; then
    success "Stack $stack_name deployed and running successfully."
  else
    error "Stack $stack_name failed to deploy or is not running correctly."
    return 1
  fi
}

################################### END OF DOCKER DEPLOYMENT UTILS ################################

################################ BEGIN OF PORTAINER DEPLOYMENT UTILS ##############################

# Function to check if Portainer credentials are correct
is_portainer_credentials_correct() {
  local portainer_url="$1"
  local credentials="$2"

  if [[ -z "$credentials" ]]; then
    error "No credentials provided."
    return 1
  fi

  if [[ "$credentials" != *"username"* || "$credentials" != *"password"* ]]; then
    error "Invalid credentials format."
    return 1
  fi

  protocol="https"
  content_type="application/json"
  resource='auth'

  url="$(
    get_api_url "$protocol" "$portainer_url" "$resource"
  )"

  response=$(
    curl -k -s -X POST -H "Content-Type: $content_type" -d "$credentials" "$url"
  )

  # Check if the response contains a valid token
  token=$(echo "$response" | jq -r .jwt)

  if [[ "$token" == "null" || -z "$token" ]]; then
    error "Invalid Portainer credentials" >&2
    return 1 # Exit with status 1 for failure
  else
    success "Valid Portainer credentials" >&2
    return 0 # Exit with status 0 for success
  fi
}

# Function to signup on portainer with retry mechanism
signup_on_portainer() {
  local portainer_url="$1"
  local username="$2"
  local password="$3"
  local max_retries=5 # Maximum number of retry attempts
  local retry_delay=5 # Delay (in seconds) between retries

  # Credentials (raw, not indented)
  credentials="{\"username\": \"$username\",\"password\": \"$password\"}"

  # Setup headers and endpoint
  local protocol="https"
  local content_type="application/json"
  local resource='users/admin/init'
  local header="Content-Type: $content_type"

  # Get the URL
  url="$(get_api_url "$protocol" "$portainer_url" "$resource")"

  for attempt in $(seq 1 $max_retries); do
    info "Attempt $attempt/$max_retries: Signing up on portainer..."

    # Perform the request
    response="$(curl -s -k -X POST "$url" -H "$header" -d "$credentials")"
    info "Response: $response" >&2

    # Check for existing administrator user
    if [[ "$response" == *"An administrator user already exists"* ]]; then
      warning "An administrator user already exists. Stopping further attempts."
      return 1
    fi

    # Check if the response is a valid JSON
    if echo "$response" | jq -e . >/dev/null 2>&1; then
      # Parse the response and check if it contains the expected fields
      user_info=$(echo "$response" | jq -c 'select(.Id and .Username and .Password and .Role)')
      if [ $? -eq 0 ]; then
        # Ensure the password is hashed correctly
        password_hash=$(echo "$response" | jq -r '.Password')
        if [[ "$password_hash" =~ ^\$2a\$10\$ ]]; then
          info "Administrator user created successfully on attempt $attempt."
          return 0
        else
          error "Password hashing failed or response is incorrect."
        fi
      else
        error "The response does not contain the expected fields."
      fi
    else
      error "The response is not a valid JSON."
    fi

    # If we've reached here, the attempt has failed
    warning "Signup failed on attempt $attempt. Retrying in $retry_delay seconds..."
    sleep "$retry_delay"
  done

  error "Failed to create an administrator user after $max_retries attempts."
  return 1
}

# Function to retrieve a Portainer authentication token
get_portainer_auth_token() {
  local portainer_url="$1"
  local credentials="$2"

  if [[ -z "$credentials" ]]; then
    error "No credentials provided."
    return 1
  fi

  if [[ "$credentials" != *"username"* || "$credentials" != *"password"* ]]; then
    error "Invalid credentials format."
    return 1
  fi

  if ! is_portainer_credentials_correct "$portainer_url" "$credentials"; then
    error "Invalid credentials."
    return 1
  fi

  local token=""

  protocol="https"
  method="POST"
  content_type="application/json"

  resource='auth'

  url="$(get_api_url $protocol $portainer_url $resource)"

  token=$(
    curl -k -s \
      -X POST \
      -H "Content-Type: $content_type" \
      -d "$credentials" "$url" |
      jq -r ".jwt"
  )

  echo "$token"
}

# Function to retrieve the endpoint ID from Portainer
get_portainer_endpoint_id() {
  local portainer_url="$1"
  local token="$2"

  local endpoint_id
  protocol='https'
  method="GET"
  resource="endpoints"
  content_type="application/json"
  data="{}"
  jq_filter='.[] | select(.Name == "primary") | .Id'

  url="$(
    get_api_url "$protocol" "$portainer_url" "$resource"
  )"

  endpoint_id="$(
    filtered_request "$method" "$url" "$token" \
      "$content_type" "$data" "$jq_filter"
  )"

  if [[ -z "$endpoint_id" ]]; then
    exit 1
  fi

  echo "$endpoint_id"
}

# Function to retrieve the Swarm ID (used during stack deployment)
get_portainer_swarm_id() {
  local portainer_url="$1"
  local token="$2"
  local endpoint_id="$3"

  protocol='https'
  method="GET"
  resource="endpoints/$endpoint_id/docker/swarm"
  content_type='application/json'
  jq_filter='.ID'

  url="$(
    get_api_url "$protocol" "$portainer_url" "$resource"
  )"

  local swarm_id
  swarm_id=$(
    filtered_request "$method" "$url" \
      "$token" "$content_type" "$data" "$jq_filter"
  )

  if [[ -z "$swarm_id" ]]; then
    error "Failed to retrieve Swarm ID."
    exit 1
  fi

  echo "$swarm_id"
}

# Function to get stacks from Portainer
get_portainer_swarm_stacks() {
  local portainer_url="$1"
  local token="$2"

  # Fetch the list of stack names from the Portainer API
  local stacks

  protocol='https'
  method="GET"
  resource="stacks"
  content_type='application/json'
  jq_filter='.ID'

  url="$(
    get_api_url "$protocol" "$portainer_url" "$resource"
  )"

  local swarm_id
  stacks=$(
    request "$method" "$url" \
      "$token" "$content_type" \
      "$data"
  )

  # Check if any stacks were returned
  if [[ "$stacks" -eq 0 ]]; then
    echo "No stacks found or failed to retrieve stacks."
    return 1
  fi

  echo "$stacks"
}

# Function to get stacks and check if a specific stack exists
check_portainer_stack_exists() {
  local portainer_url="$1"
  local token="$2"
  local stack_name="$3"

  if [[ "$token" != "" ]]; then
    # Fetch stack names and check if the specified stack exists
    protocol='https'
    method="GET"
    resource="stacks"
    content_type='application/json'
    data='{}'
    jq_query=".[] | select(.Name == \"$stack_name\") | .Id"

    url="$(get_api_url $protocol $portainer_url $resource)"

    # Fetch the stack ID using filtered_request
    local stack_id
    stack_id=$(
      filtered_request "$method" "$url" "$token" \
        "$content_type" "$data" "$jq_query"
    )

    # Check if stack ID was retrieved
    if [[ -z "$stack_id" ]]; then
      return 1
    fi

    # If stack ID is found, return the ID
    echo "$stack_id"
    return 0
  else
    error "Portainer token is not provided. Skipping stack check."
    return 1
  fi
}

# Function to upload a stack
upload_stack_on_portainer() {
  local portainer_config="$1"
  local stack_name="$2"
  local compose_file="$3"

  # Extract portainer_url and portainer_credentials
  portainer_url="$(echo "$portainer_config" | jq -r '.portainer_url')"
  portainer_credentalias="$(echo "$portainer_config" | jq -r '.portainer_credentials')"

  highlight "Uploading stack $stack_name on Portainer $portainer_url"
  token="$(get_portainer_auth_token "$portainer_url" "$portainer_credentials")"

  if [[ -z "$token" ]] || [[ "$token" == "" ]]; then
    error "Failed to retrieve Portainer token."
    return 1
  fi

  # Swarm ID and endpoint id is required for Swarm stack deployments
  local swarm_id

  endpoint_id="$(get_portainer_endpoint_id "$portainer_url" "$token")"
  if [[ -z "$endpoint_id" ]]; then
    error "Failed to retrieve Endpoint ID."
    return 1
  fi

  swarm_id=$(get_portainer_swarm_id "$portainer_url" "$token" "$endpoint_id")
  if [[ -z "$swarm_id" ]]; then
    error "Failed to retrieve Swarm ID."
    return 1
  fi

  # Upload the stack
  advice="It may take mostly less than 5 minutes. Ctrl+C if it takes longer."
  info "Uploading stack: ${stack_name}... ($advice)"
  resource="stacks/create/swarm/file"
  content_type="application/json"
  url="$(get_api_url "https" "$portainer_url" "$resource")"

  response=$(
    curl -s -k -X POST \
      -H "Authorization: Bearer $token" \
      -F "Name=$stack_name" \
      -F "file=@$compose_file" \
      -F "SwarmID=$swarm_id" \
      -F "endpointId=$endpoint_id" \
      "$url" &&
      success "Stack '$stack_name' uploaded successfully."
  )

  if [[ $? -ne 0 ]]; then
    error "Failed to upload stack: $stack_name"
    return 1
  fi

  info "Deployment response: $response"

  is_portainer_response_valid "$response"

  if [[ $? -ne 0 ]]; then
    error "Failed to upload stack: $stack_name"
    return 1
  fi

  return 0
}

# Function to deploy a stack
deploy_stack_on_portainer() {
  local portainer_config="$1"
  local stack_name="$2"
  local compose_path="$3"

  portainer_url="$(echo "$portainer_config" | jq -r '.portainer_url')"
  portainer_credentials="$(echo "$portainer_config" | jq -r '.portainer_credentials')"

  # Get Portainer auth token
  portainer_auth_token="$(
    get_portainer_auth_token "$portainer_url" "$portainer_credentials"
  )"

  if [[ -z "$portainer_auth_token" ]]; then
    error "Failed to retrieve Portainer token."
    return 1
  fi

  # Check if the stack already exists
  check_portainer_stack_exists "$portainer_url" "$portainer_auth_token" "$stack_name"

  if [[ $? -eq 0 ]]; then
    warning "Stack $stack_name exists"
    return 1
  else
    warning "Stack $stack_name does not exist"
  fi

  # Upload the stack
  upload_stack_on_portainer "$portainer_config" "$stack_name" "$compose_path" || {
    error "Failed to upload stack '$stack_name'."
    return 1
  }
}

# Function to deploy a stack
delete_stack_on_portainer() {
  local portainer_config="$1"
  local stack_name="$2"

  portainer_url="$(echo "$portainer_config" | jq -r '.portainer_url')"
  portainer_credentials="$(echo "$portainer_config" | jq -r '.portainer_credentials')"

  # Get Portainer auth token
  portainer_auth_token="$(
    get_portainer_auth_token "$portainer_url" "$portainer_credentials"
  )"

  if [[ -z "$portainer_auth_token" ]]; then
    error "Failed to retrieve Portainer token."
    return 1
  fi

  # Check if the stack already exists
  check_portainer_stack_exists "$portainer_url" "$portainer_auth_token" "$stack_name"

  if [[ $? -eq 1 ]]; then
    warning "Stack $stack_name does not exist"
    return 1
  fi

  # Upload the stack
  highlight "Deleting stack '$stack_name' on Portainer $portainer_url"

  # Retrieve stack ID based on the stack name
  info "Retrieving stack ID for '${stack_name}'..."
  local protocol='https'
  local resource="stacks"
  local jq_filter=".[] | select(.Name == \"$stack_name\") | .Id"
  local stack_id

  stack_id=$(
    check_portainer_stack_exists "$portainer_url" "$portainer_auth_token" "$stack_name"
  )

  if [[ -z "$stack_id" ]]; then
    warning "Stack '${stack_name}' not found. Exiting without error."
    return 0
  fi

  # Retrieve Endpoint ID for the stack
  info "Retrieving endpoint ID for stack '${stack_name}'"
  resource="stacks/$stack_id"
  jq_filter=".EndpointId"
  local endpoint_id

  endpoint_id=$(get_portainer_endpoint_id "$portainer_url" "$portainer_auth_token")

  if [[ -z "$endpoint_id" ]]; then
    error "Failed to retrieve Endpoint ID for stack '${stack_name}'."
    return 1
  fi

  # Delete the stack
  info "Deleting stack '${stack_name}'"
  resource="stacks/${stack_id}?endpointId=${endpoint_id}"
  url="$(get_api_url $protocol $portainer_url $resource)"

  request "DELETE" "$url" "$portainer_auth_token" "application/json" &&
    success "Stack '$stack_name' deleted successfully." ||
    error "Failed to delete stack '$stack_name'."
}

load_portainer_url_and_credentials() {
  local portainer_config_json
  portainer_config_json=$(
    load_json "$TOOL_STACKS_DIR/portainer/stack_config.json"
  )

  portainer_info="$(
    filter_json_object_by_keys "$portainer_config_json" \
      "variables.portainer_url" "variables.portainer_credentials"
  )"

  # Extract the portainer_url as a string
  portainer_url="$(echo "$portainer_info" | jq -r '.["variables.portainer_url"]')"

  # Parse the portainer_credentials string into a JSON object (using fromjson)
  portainer_credentials="$(
    echo "$portainer_info" |
      jq -r '.["variables.portainer_credentials"] | fromjson'
  )"

  # Return the filtered JSON with portainer_url and portainer_credentials
  jq -n \
    --arg portainer_url "$portainer_url" \
    --argjson portainer_credentials "$portainer_credentials" \
    '{"portainer_url": $portainer_url, "portainer_credentials": $portainer_credentials}'
}

traefik_and_portainer_exist() {
  stack_names=("traefik" "portainer")

  if ! stacks_exist "${stack_names[@]}"; then
    return 1
  fi

  return 0
}

is_portainer_response_valid() {
  local portainer_response
  portainer_response="$1"

  echo "$portainer_response" | jq -e '
      has("Id") and
      has("Name") and
      has("Type") and
      has("ResourceControl") and
      has("Status") and
      has("ProjectPath") and
      has("CreationDate")
  ' >/dev/null 2>&1

  if [[ $? -ne 0 ]]; then
    error "Invalid Portainer response: $portainer_response"
    wait_for_input
    return 1
  fi

  return 0
}

################################# END OF PORTAINER DEPLOYMENT UTILS ###############################

############################### BEGIN OF GENERAL DEPLOYMENT FUNCTIONS #############################

# Function to display a deploy failed message
deploy_failed_message() {
  stack_name="$1"
  error "Failed to deploy service $stack_name!"
  wait_for_input
}

# Function to display a deploy success message
deploy_success_message() {
  stack_name="$1"
  success "Successfully deployed stack $stack_name!"
  wait_for_input
}

# Function to create Prometheus scrape_config
create_scrape_config_object() {
  # Input parameters
  local job_name=""
  local metrics_path="/metrics" # Default
  local honor_timestamps="true" # Default
  local honor_labels="false"    # Default
  local scrape_interval="15s"   # Default
  local targets=()

  # Parse named parameters
  while [[ "$#" -gt 0 ]]; do
    case "$1" in
    --job_name)
      job_name="$2"
      shift 2
      ;;
    --metrics_path)
      metrics_path="$2"
      shift 2
      ;;
    --honor_timestamps)
      honor_timestamps="$2"
      shift 2
      ;;
    --honor_labels)
      honor_labels="$2"
      shift 2
      ;;
    --scrape_interval)
      scrape_interval="$2"
      shift 2
      ;;
    --scheme)
      scheme="$2"
      shift 2
      ;;
    --targets)
      # Split targets into an array
      IFS=',' read -r -a targets <<<"$2"
      shift 2
      ;;
    *)
      echo "Error: Unknown parameter '$1'" >&2
      return 1
      ;;
    esac
  done

  # Input validation
  if [[ -z "$job_name" ]]; then
    echo "Error: 'job_name' is required." >&2
    return 1
  fi
  if [[ ${#targets[@]} -eq 0 ]]; then
    echo "Error: At least one target must be provided using --targets." >&2
    return 1
  fi

  # Use jq to create the JSON object
  jq -n \
    --arg job_name "$job_name" \
    --arg metrics_path "$metrics_path" \
    --argjson honor_timestamps "$honor_timestamps" \
    --argjson honor_labels "$honor_labels" \
    --arg scrape_interval "$scrape_interval" \
    --argjson targets "$(printf '%s\n' "${targets[@]}" | jq -R . | jq -s .)" \
    '{
      job_name: $job_name,
      metrics_path: $metrics_path,
      honor_timestamps: $honor_timestamps,
      honor_labels: $honor_labels,
      scrape_interval: $scrape_interval,
      static_configs: [
        {
          targets: $targets
        }
      ]
    }'
}

# Function to add scrape_config to YAML file
add_scrape_config_object() {
  # Input parameters
  local filename="$1"
  local scrape_config="$2"

  # Step 1: Check if the file exists
  if [[ ! -f "$filename" ]]; then
    # Step 1: Check if the file exists, and create the directory if necessary
    if [[ ! -f "$filename" ]]; then
      # Extract the directory from the filename
      local dir
      dir=$(dirname "$filename")

      # Ensure the directory exists
      if [[ ! -d "$dir" ]]; then
        info "Directory $dir does not exist. Creating it."
        mkdir -p "$dir"
      fi
    fi

    info "File $filename does not exist. Initializing with default content."
    tee "$filename" > /dev/null <<EOF
global:
  scrape_interval: 15s
  scrape_timeout: 10s
  evaluation_interval: 15s
alerting:
  alertmanagers:
    - static_configs:
        - targets: []
scrape_configs:
EOF
  fi

  # Step 2: Check if the job_name already exists
  local job_name
  job_name=$(echo "$scrape_config" | jq -r '.job_name')
  check_existing_job_name "$filename" "$job_name"

  if [[ $? -eq 0 ]]; then
    warning "job_name '$job_name' already exists in $filename." >&2
    return 1
  fi

  # Step 3: Add the scrape_config to the YAML file
  yq eval -i ".scrape_configs += [$scrape_config]" "$filename"
  success "Added scrape_config for job '$job_name' to $filename."
}

# Function to check if a job_name exists in the scrape_configs of a YAML file
check_existing_job_name() {
  # Input parameters
  local filename="$1"
  local job_name="$2"

  # Validate inputs
  if [[ -z "$filename" || -z "$job_name" ]]; then
    error "Filename and job_name are required."
    return 1
  fi

  # Gather all existing job_names into an array
  local job_names
  job_names=$(yq eval '.scrape_configs[].job_name' "$filename" 2>/dev/null)

  # Check if the job_name exists in the array
  if echo "$job_names" | grep -qx "$job_name"; then
    return 0 # Key exists
  else
    return 1 # Key does not exist
  fi
}

# Function to remove a failed deployment
remove_compose_if_failed_deployment() {
  local compose_path="$1"
  local exit_code="$2"

  # Ensure exit_code is a valid integer
  if [[ ! "$exit_code" =~ ^[0-9]+$ ]]; then
    error "Invalid exit code: \"$exit_code\". Must be an integer."
    return 1
  fi

  if [ "$exit_code" -ne 0 ]; then
    rm -f "$compose_path"
    warning "Deployment failed. Docker Compose file \"$compose_path\" was removed."
    wait_for_input
    return 1
  fi
}

# Function to build config and compose files for a service
build_stack_info() {
  local stack_name="$1"

  # Build JSON object
  local json_output
  json_output=$(
    jq -n \
      --arg config_path "${TOOL_STACKS_DIR}/${stack_name}/stack_config.json" \
      --arg compose_path "${TOOL_STACKS_DIR}/${stack_name}/docker-compose.yaml" \
      --arg compose_func "compose_file_${stack_name}" \
      '{
      config_path: $config_path,
      compose_path: $compose_path,
      compose_func: $compose_func
    }'
  )

  # Return JSON
  echo "$json_output"
}

# Function to request permission for stack removal
should_remove_stack() {
  local stack_name="$1"
  local question
  local prompt_message

  if stack_exists "$stack_name"; then
    question='Would you like to remove it? (Y/n)'
    prompt_message="${yellow}Stack '$stack_name' exists. $question${normal}"
    if handle_confirmation_prompt "$prompt_message" "n" 5; then
      echo "" >&2
      warning "Proceeding to remove stack '$stack_name'."

      if [[ "$stack_name" == "traefik" || "$stack_name" == "portainer" ]]; then
        docker stack rm "$stack_name"
      else
        portainer_config="$(load_portainer_url_and_credentials)"

        delete_stack_on_portainer "$portainer_config" "$stack_name"
      fi

      exit_code=$?
      if [[ $exit_code -ne 0 ]]; then
        error "Failed to remove stack '$stack_name'."
        return 1
      else
        info "Stack '$stack_name' has been removed."
        return 0
      fi
    else
      echo "" >&2
      warning "Stack '$stack_name' was not removed. Proceeding..."
      return 1
    fi
  else
    return 0
  fi
}

# Function to validate a Docker Compose file
validate_compose_file() {
  local compose_file="$1"

  # Check if the file exists
  if [ ! -f "$compose_file" ]; then
    error "File '$compose_file' not found."
    exit 1
  fi

  # Validate the syntax of the Docker Compose file
  docker compose -f "$compose_file" config >/dev/null 2>&1

  local EXIT_CODE=$?
  return $EXIT_CODE
}

# Function to determine if an image is official
is_official_image() {
  # Measure execution time
  local image_name=$1
  local response=""

  # Try fetching the official image first
  response=$(
    curl -fsSL "https://hub.docker.com/v2/repositories/library/${image_name}" 2>/dev/null
  )

  # Check if the response contains 'name' indicating it's an official image
  if [ $? -eq 0 ] && echo "$response" | jq -e '.name' >/dev/null 2>&1; then
    echo "true" # It's an official image
    return
  fi

  # If official image fails, try fetching the non-official image (user/organization image)
  response=$(curl -fsSL "https://hub.docker.com/v2/repositories/${image_name}")

  # If the response contains 'name', it's a valid (non-official) image
  if [ $? -eq 0 ] && echo "$response" | jq -e '.name' >/dev/null 2>&1; then
    echo "false" # It's a non-official image
  else
    # If neither the official nor non-official image is found, return false
    echo "false" # Image not found
  fi
}

# Function to fetch stable tags from a response
fetch_stable_tags_from_page() {
  pattern='^[0-9]+\.[0-9]+\.[0-9]+$|^[0-9]+\.[0-9]+$'
  echo "$1" | jq -r '.results[].name' | grep -E "$pattern"
}

# Function to create a Docker network if it doesn't exist
create_network_if_not_exists() {
  local network_name="${1:-$DEFAULT_NETWORK}"

  # Check if the network already exists
  if ! docker network ls --format '{{.Name}}' | grep -wq "$network_name"; then
    info "Creating network: $network_name"

    # Create the overlay network
    if docker network create --driver overlay "$network_name" -- 2>&1; then
      success "Network $network_name created successfully."
    else
      error "Failed to create network $network_name."
      wait_for_input
      exit 1 # Exit with error status if network creation fails
    fi
  else
    warning "Network $network_name already exists."
  fi
}

# Function to execute a setUp action
execute_action() {
  local action_json="$1"
  local action_variables="$2"

  # Extract the name and command safely using jq
  local action_name
  action_name=$(echo "$action_json" | jq -r '.name')

  local action_command
  action_command=$(echo "$action_json" | jq -r '.command')

  # Declare an associative array
  declare -A variables_array
  convert_json_to_array "$action_variables" variables_array

  action_command="$(replace_mustache_variables "$action_command" variables_array)"

  # Use eval safely to execute the command
  eval "$action_command" >&2

  # Check command success
  local exit_code=$?
  if [ $exit_code -ne 0 ]; then
    failure "Action '$action_name' failed with exit code $exit_code"
  else
    success "Action '$action_name' executed successfully"
  fi
}

# Function to deploy dependencies
deploy_dependencies() {
  local stack_name="$1"
  local dependencies_json="$2"

  info "Deploying dependencies for stack '$stack_name'"

  # Read dependencies as an array using jq
  local dependencies
  mapfile -t dependencies < <(echo "$dependencies_json" | jq -r '.[]')

  # Iterate over the array
  for dependency in "${dependencies[@]}"; do
    info "Processing dependency: $dependency"

    if ! docker stack ls --format '{{.Name}}' | grep -q "^$dependency$"; then
      info "Deploying dependency: $dependency"
      deploy_stack "$dependency"

      wait_for_services "$stack_name"

      if [ $? -ne 0 ]; then
        error "Failed to deploy dependency: $dependency"
        return 1
      fi
    else
      warning "Dependency \"$dependency\" already exists. Skipping..."
    fi
  done
}

# Function to execute a refresh action (command must output JSON)
execute_refresh_actions() {
  local refresh_actions_json="$1"
  local stack_variables="$2"
  local updated_variables="$stack_variables" # Initialize with input variables

  # Validate that refresh_actions_json is a valid JSON
  echo "$refresh_actions_json" | jq empty >/dev/null 2>&1 || {
    error "Invalid JSON in refresh actions"
    return 1
  }

  # Check if there are no actions in the JSON
  if [ "$(echo "$refresh_actions_json" | jq length)" -eq 0 ]; then
    warning "No refresh actions to execute."
    echo "$updated_variables"
    return 0
  fi

  # Convert the JSON array to a Bash array
  while IFS= read -r item; do
    actions+=("$item")
  done < <(jq -r '.[] | @json' <<<"$refresh_actions_json")

  # Declare an associative array
  declare -A variables_array

  # Iterate over the refresh actions
  for action in "${actions[@]}"; do
    local command

    convert_json_to_array "$stack_variables" variables_array

    command=$(echo "$action" | jq -r '.command') || {
      error "Missing 'command' field in refresh action."
      return 1
    }

    command="$(replace_mustache_variables "$command" variables_array)" || {
      error "Failed to replace mustache variables in refresh action."
      return 1
    }

    # Variable name or empty name
    local name
    name="$(jq -r --arg key "name" '.[$key] // empty' <<<"$action")"

    # Execute the command and capture its output (must be a valid JSON)
    command_output=$(eval "$command") || {
      error "Failed to execute refresh action: $name"
      return 1
    }

    # If variable 'name' is empty, check if it is a json object
    if [ -z "$name" ]; then
      constraint="a valid JSON when property 'name' is empty or not provided"
      message="Refresh action command must be $constraint."
      # Validate if the output is a valid JSON object
      echo "$command_output" | jq empty >/dev/null 2>&1 || {
        error
        return 1
      }

      # Merge the command output with the existing stack variables using add_json_objects
      updated_variables=$(add_json_objects "$updated_variables" "$command_output") || {
        error "Failed to update stack variables after executing refresh action."
        return 1
      }
      continue
    fi

    variable_to_update="$(
      echo "\"$command_output\"" | jq -c --arg key "$name" '{($key): .}'
    )"

    # Merge the command output with the existing stack variables using add_json_objects
    updated_variables=$(
      add_json_objects "$updated_variables" "$variable_to_update"
    ) || {
      error "Failed to update stack variables after executing variable '$name'"
      return 1
    }
  done

  info "Refreshed stack variables: $(echo "$updated_variables" | jq -c '.')"

  echo "$updated_variables"
}

# Function to execute prepare actions
execute_prepare_actions() {
  local prepare_actions_json="$1"
  local stack_variables="$2"

  if [ "$(echo "$prepare_actions_json" | jq length)" -eq 0 ]; then
    warning "No prepare actions to execute."
    return 0
  fi

  echo "$prepare_actions_json" | jq -c '.[]' | while IFS= read -r action; do
    local action_name
    action_name=$(echo "$action" | jq -r '.name')
    info "Executing prepare action: $action_name"

    execute_action "$action" "$stack_variables"
    if [ $? -ne 0 ]; then
      error "Failed to execute prepare action: $action_name"
      return 1
    fi
  done
}

# Function to build the Docker Compose template
build_compose_file() {
  local stack_name="$1"
  local stack_variables_json="$2"

  info "Building Docker Compose template for stack '$stack_name'"

  # Get stack info
  local stack_info
  stack_info=$(build_stack_info "$stack_name")

  # Extract paths and function for template generation
  local stack_dir="${TOOL_STACKS_DIR}/${stack_name}"
  local stack_compose_template_path="${TOOL_TEMPLATES_DIR}/${stack_name}.yaml"

  local config_path="${stack_dir}/stack_config.json"
  local compose_path="${stack_dir}/docker-compose.yaml"
  local compose_url="$(stack_url "$stack_name")"

  # Ensure the directory for the compose file exists
  local compose_dir
  compose_dir=$(dirname "$compose_path")
  if [ ! -d "$compose_dir" ]; then
    mkdir -p "$compose_dir" || {
      error "Failed to create directory: $compose_dir"
      return 1
    }
  fi

  # Convert stack_variables JSON into an array of key=value pairs
  declare -A stack_variables

  # Parse JSON into an associative array
  while IFS="=" read -r key value; do
    stack_variables["$key"]="$value"
  done < <(echo "$stack_variables_json" | jq -r 'to_entries | .[] | "\(.key)=\(.value)"')

  # Generate the substituted template
  local substituted_template
  substituted_template=$(
    replace_mustache_variables "$(cat "$stack_compose_template_path")" stack_variables
  )

  # Write the template to the compose file
  echo "$substituted_template" >"$compose_path"
  if [ $? -ne 0 ]; then
    error "Failed to write Docker Compose template to $compose_template_path"
    return 1
  fi

  echo "$compose_path"
}

# Function to deploy the stack on the target
deploy_stack_on_target() {
  local stack_name="$1"
  local compose_path="$2"
  local target="$3"

  case "$target" in
  swarm)
    info "Deploying stack '$stack_name' on Docker Swarm"
    docker stack deploy -c "$compose_path" "$stack_name"

    return $?
    ;;
  portainer)
    info "Deploying stack '$stack_name' on Portainer"
    portainer_config="$(load_portainer_url_and_credentials)"

    deploy_stack_on_portainer "$portainer_config" "$stack_name" "$compose_path"

    return $?
    ;;
  *)
    error "Unknown deployment target: $target"
    return 1
    ;;
  esac

  if [ $? -ne 0 ]; then
    error "Failed to deploy stack '$stack_name' on $target"
    return 1
  fi
}

# Function to execute finalize actions
execute_finalize_actions() {
  local finalize_actions_json="$1"
  local stack_variables="$2"

  if [ "$(echo "$finalize_actions_json" | jq length)" -eq 0 ]; then
    warning "No finalize actions to execute."
    return 0
  fi

  echo "$finalize_actions_json" | jq -c '.[]' | while IFS= read -r action; do
    local action_name
    action_name=$(echo "$action" | jq -r '.name')
    info "Executing finalize action: $action_name"

    execute_action "$action" "$stack_variables"
    if [ $? -ne 0 ]; then
      error "Failed to execute finalize action: $action_name"
      return 1
    fi
  done
}

# Function to save stack configuration
save_stack_configuration() {
  local stack_name="$1"
  local stack_config_json="$2"

  local stack_config_path
  stack_config_path="$TOOL_STACKS_DIR/$stack_name/stack_config.json"
  echo "$stack_config_json" | jq '.' >"$stack_config_path"
  if [ $? -ne 0 ]; then
    error "Failed to save stack configuration for stack '$stack_name'"
    return 1
  fi
}

# Function to generate the stack configuration pipeline
generate_stack_config_pipeline() {
  local config_instructions="$1"

  total_steps=2

  stack_name="$(echo "$config_instructions" | jq -r '.name')"

  # Set target to 'swarm' if variable 'stack_name' is either 'traefik' or 'portainer'.
  # Otherwise, set target to 'portainer'.
  local target
  if [ "$stack_name" == "traefik" ] || [ "$stack_name" == "portainer" ]; then
    target="swarm"
  else
    target="portainer"
  fi

  # Prompting step
  step_info 1 $total_steps "Prompting required $stack_name information"

  prompt_items="$(echo "$config_instructions" | jq -c '.actions.prompt // []')"

  if [[ "$prompt_items" != "[]" ]]; then
    display_prompt_items "$prompt_items"
  else
    warning "No prompt items found for stack '$stack_name'."
  fi

  collected_items="$(run_collection_process "$prompt_items")"

  if [[ "$collected_items" == "[]" && "$prompt_items" != "[]" ]]; then
    step_error 1 $total_steps "Unable to prompt configuration."
    return 1
  fi

  # Step 2: Retrieve network name
  step_info 2 $total_steps "Retrieving network name"
  network_name="$(get_network_name)"

  if [ -z "$network_name" ]; then
    step_error 2 $total_steps "Unable to retrieve network name."
    return 1
  fi

  variables="$(process_prompt_items "$collected_items")"
  variables="$(
    echo "$variables" |
      jq --arg network_name "$network_name" '. + { "network_name": $network_name }'
  )"

  dependencies="$(echo "$config_instructions" | jq -c '.dependencies // []')"
  actions="$(echo "$config_instructions" | jq -c '.actions // {}')"

  instructions="{
    \"name\": \"$stack_name\",
    \"target\": \"$target\",
    \"variables\": $variables,
    \"dependencies\": $dependencies,
    \"actions\": $actions
  }"

  echo "$instructions"
}

# Function to deploy a stack
deployment_pipeline() {
  local config_json="$1"

  local stack_name="$(echo "$config_json" | jq -r '.name')"

  total_steps=7

  # Parse stack variables
  local stack_variables
  stack_variables=$(echo "$config_json" | jq -r '.variables // []')

  highlight "Starting deployment pipeline for stack '$stack_name'"

  # Step 1: Deploy dependencies
  step_info 1 $total_steps "Deploying dependencies"
  local dependencies
  dependencies=$(echo "$config_json" | jq -r '.dependencies // []')
  deploy_dependencies "$stack_name" "$dependencies" || {
    failure "Failed to deploy dependencies"
    return 1
  }

  # Step 2: Execute refresh actions
  step_info 2 $total_steps "Executing refresh actions"
  local refresh_actions
  refresh_actions=$(jq -r '.actions.refresh // []' <<<"$config_json")

  stack_variables=$(
    execute_refresh_actions "$refresh_actions" "$stack_variables"
  ) || {
    failure "Failed to execute refresh actions"
    return 1
  }

  # Update variables property on config_json
  config_json=$(
    echo "$config_json" |
      jq --argjson stack_variables "$stack_variables" '.variables = $stack_variables'
  )

  # Step 3: Execute prepare actions
  step_info 3 $total_steps "Executing prepare actions"
  local prepare_actions
  prepare_actions=$(echo "$config_json" | jq -r '.actions.prepare // []')
  execute_prepare_actions "$prepare_actions" "$stack_variables" || {
    failure "Failed to execute prepare actions"
    return 1
  }

  # Step 4: Build and substitute Docker Compose template
  step_info 4 $total_steps "Building Docker Compose template"
  local compose_path
  compose_path=$(build_compose_file "$stack_name" "$stack_variables") || {
    failure "Failed to build Docker Compose template"
    return 1
  }

  # Step 5: Deploy the stack on the target
  step_info 5 $total_steps "Deploying stack on target"
  local target
  target=$(echo "$config_json" | jq -r '.target // "swarm"')

  deploy_stack_on_target "$stack_name" "$compose_path" "$target" || {
    failure "Failed to deploy stack on target: $target"
    return 1
  }

  wait_for_services "$stack_name"

  # Step 6: Execute finalize actions
  step_info 6 $total_steps "Executing finalize actions"
  local finalize_actions
  finalize_actions=$(echo "$config_json" | jq -r '.actions.finalize // []')
  execute_finalize_actions "$finalize_actions" "$stack_variables" || {
    failure "Failed to execute finalize actions"
    return 1
  }

  # Step 7: Save configuration and finalize
  step_info 7 $total_steps "Saving configuration and finalizing"
  save_stack_configuration "$stack_name" "$config_json" || {
    failure "Failed to save stack configuration"
    return 1
  }

  # Success message
  deploy_success_message "$stack_name"
}

# Function to deploy a traefik service
deploy_stack() {
  local stack_name="$1"

  cleanup
  clean_screen

  # Check if there is space on the disk
  check_disk_usage

  if [[ $? -eq 1 ]]; then
    warning "Disk usage is above the threshold. Deployment will continue on your own risk."
    wait_for_input
  fi

  # Check if the stack is WIP
  if [[ "$stack_status" == "development" ]]; then
    warning "Stack '$stack_name' is under maintenance. Skipping deployment."
    wait_for_input
    return 1
  fi

  # Check if the stack is WIP
  if [[ "$stack_status" == "beta" ]]; then
    warn_message="It might not work properly. Deployment will continue on your own risk."
    warning "Stack '$stack_name' is under testing. $warn_message"
    wait_for_input
  fi

  traefik_and_portainer_exist
  exit_code=$?

  # If Traefik or Portainer do not exist:
  if [[ $exit_code -ne 0 ]]; then
    # Allow installation if the stack is Traefik or Portainer
    if [[ "$stack_name" == "traefik" || "$stack_name" == "portainer" ]]; then
      info "Installing missing startup stack: $stack_name"
    else
      # Otherwise, block installation
      error "Traefik and Portainer are required before deploying $stack_name."
      error "Select option 'Startup' on menu 'Stacks' to install them."
      wait_for_input
      return 1
    fi
  fi

  if [[ "$stack_name" != "traefik" && "$stack_name" != "portainer" ]]; then
    # Check current stack is WIP from associative array STACKS
    #   object property 'stack_status' (case insensitive) is
    stack_object="${STACKS[$stack_name]}"

    if [[ -z "$stack_object" ]]; then
      return 1
    fi

    # Avoiding deploying a WIP stack with property 'stack_status' set to 'development'
    stack_status="$(echo "$stack_object" | jq -r '.stack_status // "development"')"
    stack_status="$(uppercase "$stack_status")"
  fi

  # Check if the stack should be removed
  should_remove_stack "$stack_name"

  # Check if the stack exists
  if [ $? -eq 1 ]; then
    return 0
  fi

  # Generate the stack JSON configuration
  local stack_config
  stack_config=$(eval "generate_stack_config_$stack_name")

  if [ -z "$stack_config" ]; then
    return 1
  fi

  # Check required fields
  validate_stack_config "$stack_config"

  if [ $? -ne 0 ]; then
    failure "Stack \'$stack_name\' configuration validation failed."
    return 1
  fi

  # Deploy the n8n service using the JSON
  deployment_pipeline "$stack_config"
}

################################ END OF GENERAL DEPLOYMENT FUNCTIONS ##############################

####################################### BEGIN OF E-MAIL UTILS #####################################

EMAIL_TEMPLATE='<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <title>{{email_title}}</title>
  <style>
    body {
      font-family: 'Arial', sans-serif;
      background-color: #f9f9fb;
      margin: 0;
      padding: 0;
      color: #333;
      line-height: 1.6;
    }

    /* Container Styles */
    .container {
      margin: 20px auto;
      padding: 20px;
      max-width: 600px;
      background-color: #ffffff;
      border-radius: 10px;
      box-shadow: 0 4px 10px rgba(0, 0, 0, 0.1);
    }

    /* Header Styles */
    .header {
      text-align: center;
      background-color: #4caf50;
      color: #ffffff;
      padding: 20px;
      border-radius: 10px 10px 0 0;
    }
    .header img {
      max-width: 80px;
      margin-bottom: 10px;
    }
    .header h1 {
      font-size: 1.6em;
      margin: 0;
    }

    /* Content Styles */
    .content {
        text-align: center; /* Centers inline-block elements like the button */ 
    }

    /* Footer Styles */
    .footer {
      text-align: center;
      padding: 20px 0;
      color: #aaaaaa;
      border-top: 1px solid #eeeeee;
      font-size: 0.9em;
    }
    .footer img {
      width: 24px;
      height: 24px;
      vertical-align: middle;
    }
    .footer a {
      text-decoration: none;
      color: #aaaaaa;
    }

    /* Button centeredStyling */
    .button {
        display: inline-block; /* Ensures it only takes as much space as needed */
        margin: 20px auto; /* Adds spacing around the button */
        padding: 12px 25px;
        background-color: #4caf50;
        color: #ffffff;
        text-decoration: none;
        font-size: 1.1em;
        font-weight: bold;
        border-radius: 5px;
        text-align: center;
        cursor: pointer;
        transition: background-color 0.3s ease, transform 0.2s ease;
    }

    .button:hover {
        background-color: #45a049;
        transform: translateY(-2px);
    }

    .button:active {
        background-color: #3e8e41;
        transform: translateY(2px);
    }

    /* Global Link Styling */
    a {
      color: #4caf50;
      font-weight: bold;
      text-decoration: none;
    }
    a:hover {
      text-decoration: underline;
    }
    a:focus {
      outline: 3px solid #4caf50;
      outline-offset: 2px;
    }

    /* Responsive Styling */
    @media only screen and (max-width: 600px) {
      .container {
        padding: 15px;
        margin: 10px;
      }
      .header h1 {
        font-size: 1.4em;
      }
      .content {
        font-size: 0.9em;
      }
      .button {
        padding: 10px 20px;
        font-size: 1em;
      }
    }

    /* Preheader (Hidden Text for Email Clients) */
    .preheader {
      display: none;
      max-height: 0;
      overflow: hidden;
      mso-hide: all;
      visibility: hidden;
    }
  </style>
</head>
<body>  
  <section class="container">
    <header class="header" role="banner">
      <img src="{{tool_logo_url}}" alt="{{tool_name}} Logo">
      <h1>{{header_title}}</h1>
    </header>
    <section class="content">
      {{email_content}}
    </section>
    <footer class="footer" role="contentinfo">
      <p>Sent using a Shell Script and the Swaks tool.</p>
      <p>
        <a href="{{tool_repository_url}}" target="_blank" aria-label="Visit {{tool_name}} GitHub page">
          <img src="https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png" alt="GitHub Logo">
        </a>
      </p>
    </footer>
  </section>
</body>
</html>'

declare -A tool_variables=(
  [tool_name]="$TOOL_NAME"
  [tool_repository_url]="$TOOL_REPOSITORY_URL"
  [tool_logo_url]="$TOOL_LOGO_URL"
)
EMAIL_TEMPLATE=$(
  replace_mustache_variables "$EMAIL_TEMPLATE" tool_variables
)

# Function to generate email
generate_html() {
  local base_template="$1"
  local email_title="$2"
  local header_title="$3"
  local email_content="$4"

  # Prepare an associative array with the replacements
  declare -A email_variables=(
    [email_title]="$email_title"
    [header_title]="$header_title"
    [email_content]="$email_content"
  )

  # Use the replace_mustache_variables function to substitute variables in the template
  local email_html=$(replace_mustache_variables "$base_template" email_variables)

  # Output the final HTML email
  echo "$email_html"
}

check_smtp_config() {
  local smtp_host="$1"
  local smtp_username="$2"
  local smtp_password="$3"

  # Run swaks to check authentication
  swaks --to "$smtp_username" \
    --from "$smtp_username" \
    --server "$smtp_host" \
    --auth LOGIN \
    --auth-user "$smtp_username" \
    --auth-password "$smtp_password" \
    --tls --quit-after=DATA >/dev/null 2>&1

  # Check if swaks command was successful (exit status 0) or failed (non-zero exit status)
  if [[ $? -eq 0 ]]; then
    return 0 # Success
  else
    return 1 # Failure
  fi
}

# Function to generate HTML for an email
generate_test_smtp_hmtl() {
  # Content for the email
  local email_content='<div style="text-align: left;">
  <p>Hi there,</p>
  <p>We are thrilled to have you onboard! Explore the features of {{tool_name}} and elevate your workflow.</p>
  <div style="text-align: center;">
    <a href="{{tool_repository_url}}" class="button">Get Started</a>
  </div>
  <p>If you have any questions, feel free to submit an issue to
    <a href="{{tool_repository_url}}/issues" title="Visit our Issues page on GitHub">our repository</a>. We''re here to help!
  </p>
</div>'

  email_content="$(replace_mustache_variables "$email_content" tool_variables)"

  # Generate the email
  generate_html "$EMAIL_TEMPLATE" "Welcome to $TOOL_NAME" "Welcome to $TOOL_NAME" "$email_content"
}

# Function to generate HTML table row
generate_table_row() {
  local category="$1"
  local details="$2"
  echo "<tr><td style='padding: 8px; border: 1px solid #ddd;'>$category</td>
    <td style='padding: 8px; border: 1px solid #ddd;'>$details</td></tr>"
}

# Function to fetch system information
fetch_system_info() {
  local command="$1"
  local default_value="$2"
  command -v "$command" &>/dev/null && eval "$command" || echo "$default_value"
}

format_disk_usage() {
  local header="<table style='width: 100%; border-collapse: collapse; text-align: left;'>
<caption style='font-size: 1.5em; margin-bottom: 10px;'>Disk Usage</caption>
<tr style='background-color: #f2f2f2;'>
  <th>Source</th>
  <th>Filesystem Type</th>
  <th>Total Size</th>
  <th>Used</th>
  <th>Available</th>
  <th>Use%</th>
</tr>"
  local rows=$(df -h --output=source,fstype,size,used,avail,pcent | grep -E '^/dev' |
    awk '{printf "<tr><td>%s</td><td>%s</td><td>%s</td><td>%s</td><td>%s</td><td>%s</td></tr>\n", $1, $2, $3, $4, $5, $6}')
  local footer="</table>"

  echo "$header$rows$footer"
}

# Function to generate the machine specs email
generate_machine_specs_html() {
  # Example usage
  email_content=$(generate_machine_specs_table)
  generate_html "$EMAIL_TEMPLATE" "VPS Status" "Machine Specifications" "$email_content"
}

# Function to request SMTP information
prompt_smtp_information() {
  local items='[
      {
          "name": "smtp_host",
          "label": "SMTP host",
          "description": "Server to receive SMTP requests",
          "required": "yes",
          "validate_fn": "validate_smtp_host",
          "default_value": "smtp.gmail.com"
      },
      {
          "name": "smtp_port",
          "label": "SMTP port",
          "description": "Port on SMTP server",
          "required": "yes",
          "validate_fn": "validate_integer_value",
          "default_value": 587
      },
      {
          "name": "smtp_username",
          "label": "SMTP username",
          "description": "Username of SMTP server",
          "required": "yes",
          "validate_fn": "validate_email_value" 
      },
      {
          "name": "smtp_password",
          "label": "SMTP password",
          "description": "Password of SMTP server",
          "required": "yes",
          "validate_fn": "validate_empty_value" 
      },
      {
          "name": "smtp_from_email",
          "label": "SMTP e-mail sender",
          "description": "SMTP e-mail sender",
          "required": "yes",
          "validate_fn": "validate_empty_value" 
      }
  ]'

  collected_items="$(run_collection_process "$items")"

  if [[ "$collected_items" == "[]" ]]; then
    error "Unable to retrieve server and network names."
    return 1
  fi

  collected_object="$(process_prompt_items "$collected_items")"

  echo "$collected_object"
}

# Function to save SMTP information
save_smtp_information() {
  local filename="$TOOL_BASE_DIR/smtp_info.json"
  local smtp_json="$1"

  if [[ -z "$smtp_json" || "$smtp_json" == "[]" ]]; then
    error "Invalid SMTP configuration."
    return 1
  fi

  info "Saving SMTP configuration to file: $filename"
  write_json "$filename" "$smtp_json"

  echo "$smtp_json"
}

# Function to load SMTP configuration from file
load_smtp_information() {
  local filename="$TOOL_BASE_DIR/smtp_info.json"

  if [[ ! -f "$filename" ]]; then
    error "SMTP configuration file not found: $filename"
    return 1
  fi

  local smtp_json
  smtp_json=$(load_json "$filename")

  if [[ -z "$smtp_json" ]]; then
    error "Unable to retrieve SMTP configuration from file $filename."
    return 1
  fi

  info "Loaded SMTP configuration from file: $filename"
  echo "$smtp_json"
}

# Unified function to handle SMTP retrieval
get_or_request_smtp_configuration() {
  local smtp_json

  smtp_json=$(load_smtp_information 2>/dev/null)
  if [[ $? -ne 0 ]]; then
    smtp_json=$(prompt_smtp_information)
    save_smtp_information "$smtp_json" || return 1
  fi

  echo "$smtp_json"
}

# Function to confirm and possibly overwrite SMTP configuration
overwrite_or_request_smtp_information() {
  local smtp_json question

  smtp_json=$(load_smtp_information 2>/dev/null)
  if [[ $? -ne 0 ]]; then
    error "SMTP configuration not found."
    question="Would you like to add tool SMTP configuration?"
  else
    info "Current SMTP configuration:\n$(
      echo "$smtp_json" | jq -r '. | to_entries | map("\(.key): \(.value)") | join("\n")'
    )"
    question="Would you like to overwrite the current SMTP configuration?"
  fi

  local confirmation_message="${faded_color}$question [y/N]${reset_color}"
  if handle_confirmation_prompt "$confirmation_message" "y"; then
    smtp_json=$(prompt_smtp_information)
    save_smtp_information "$smtp_json" || return 1

    # Place the next messages here, after the confirmation prompt
    info "SMTP configuration successfully updated!"
  fi

  wait_for_input
}

custom_send_email() {
  local to_email="$1"
  local subject="$2"
  local body="$3"

  # Retrieve SMTP configuration (load from file or request and save)
  smtp_json=$(get_or_request_smtp_configuration) >/dev/null 2>&1

  if [[ $? -ne 0 ]]; then
    error "Unable to retrieve SMTP configuration."
    return 1
  fi

  smtp_host="$(echo "$smtp_json" | jq -r ".smtp_host")"
  smtp_port="$(echo "$smtp_json" | jq -r ".smtp_port")"
  smtp_username="$(echo "$smtp_json" | jq -r ".smtp_username")"
  smtp_password="$(echo "$smtp_json" | jq -r ".smtp_password")"
  smtp_from_email="$(echo "$smtp_json" | jq -r ".smtp_from_email")"

  # Send the test email
  send_email \
    "$smtp_from_email" "$to_email" "$smtp_host" "$smtp_port" \
    "$smtp_username" "$smtp_password" "$subject" "$body"

  wait_for_input
}

# Function to send a test SMTP email
send_smtp_test_email() {
  subject="[$TOOL_NAME] Test SMTP e-mail"
  body="$(generate_test_smtp_hmtl)"

  # Retrieve SMTP configuration (load from file or request and save)
  smtp_json=$(get_or_request_smtp_configuration) >/dev/null 2>&1

  if [[ $? -ne 0 ]]; then
    error "Unable to retrieve SMTP configuration."
    return 1
  fi

  smtp_username="$(echo "$smtp_json" | jq -r ".smtp_username")"

  info "Sending test email to $smtp_username..."

  custom_send_email "$smtp_username" "$subject" "$body"

  wait_for_input
}

# Function to send machine specs email
send_machine_specs_email() {
  subject="[$TOOL_NAME] Machine Specifications"
  body="$(generate_machine_specs_html)"

  # Retrieve SMTP configuration (load from file or request and save)
  smtp_json="$(get_or_request_smtp_configuration)" >/dev/null 2>&1

  if [[ $? -ne 0 ]]; then
    error "Unable to retrieve SMTP configuration."
    return 1
  fi

  smtp_username="$(echo "$smtp_json" | jq -r ".smtp_username")"

  info "Sending Machine Specs email to $smtp_username..."

  custom_send_email "$smtp_username" "$subject" "$body"
}

######################################## END OF E-MAIL UTILS ######################################

###################################### BEGIN OF SETUP FUNCTIONS ###################################

# Generalized function to check if a package is already installed
is_package_installed() {
  local package="$1"

  # Check for dpkg packages
  if dpkg -l | grep -q "^ii.*$package"; then
    return 0
  fi

  # Check for snap packages
  if snap list | grep -q "^$package"; then
    return 0
  fi

  # Check if the command exists in PATH (binary check)
  if command -v "$package" >/dev/null 2>&1; then
    return 0
  fi

  # If none of the checks match, return not installed
  return 1
}

# Function to install a package
install_package() {
  local command="$1"
  local package="$2"

  # Check if the package is already installed
  if is_package_installed "$package"; then
    warning "Package '$package' is already installed, skipping..."
  else
    info "Starting installation of package: $package"

    # Try to install the package and check for success
    if ! DEBIAN_FRONTEND=noninteractive $command install "$package" >/dev/null 2>&1; then
      error "Failed to install package: $package. Check logs for more details."
    else
      success "Successfully installed package: $package"
    fi
  fi
}

# Function to install all packages and track progress
install_all_packages() {
  # The list of packages to install (passed as arguments)
  local command="$1"
  shift
  local packages=("$@")
  local total_packages=${#packages[@]}
  local installed_count=0

  # Install each package
  for package in "${packages[@]}"; do
    install_package "$command" "$package"
    installed_count=$((installed_count + 1))
  done
}

# Function to update and check VPS packages
update_and_check_packages() {
  # Check for the package manager (apt)
  if command -v apt &>/dev/null; then
    # Check for upgradable packages
    upgradable_packages=$(apt list --upgradable 2>/dev/null)
    if [[ -z "$upgradable_packages" ]]; then
      warning "No upgradable packages."
    else
      info "Upgradable packages detected."

      # Ask for confirmation
      message="$(format "question" "Would you like to update and upgrade the packages? (Y/n)")"
      if handle_confirmation_prompt "$message" "y" 5; then
        echo ""

        # Update packages with feedback
        hold_on "Updating package list..."
        apt-get update -y >/dev/null 2>&1 &
        show_progress $!

        # Upgrade packages with feedback
        hold_on "Upgrading packages..."
        apt-get upgrade -y

        # Remove unused packages with feedback
        hold_on "Removing unused packages..."
        apt-get autoremove -y >/dev/null 2>&1 &
        show_progress $!

        # Clean package cache with feedback
        hold_on "Cleaning up package cache..."
        apt-get clean >/dev/null 2>&1 &
        show_progress $!

        # Notify update completion
        success "Update complete!"
      else
        failure "Update aborted."
      fi
    fi
  else
    failure "Package manager not supported."
  fi

  echo ""
  wait_for_input
}

# Function to prepare the environment
prepare_environment() {
  # Function constants
  local total_steps=6

  highlight "Preparing environment"

  # Step 1: Update the system
  step_message="Updating system and upgrading packages"
  step_progress 1 $total_steps "$step_message"
  command "apt-get update -yq" 1 $total_steps "$step_message" >/dev/null 2>&1 &
  show_progress $!

  # Step 3: Autoclean the system
  step_message="Cleaning up package cache"
  step_progress 2 $total_steps "$step_message"
  command "apt-get autoclean -yq --allow-downgrades" 2 $total_steps "$step_message" >/dev/null 2>&1 &
  show_progress $!

  # Check for apt locks on installation
  wait_apt_lock 5 60

  # Install required apt packages quietly
  apt_packages=(
    "sudo" "apt-utils" "apparmor-utils" "apache2-utils" "jq" "python3" "uuid"
    "docker" "figlet" "swaks" "netcat" "vnstat" "network-manager" "upower" "ctop"
  )
  step_message="Installing required apt-get packages"
  step_progress 3 $total_steps "$step_message"
  install_all_packages "apt-get -yq" "${apt_packages[@]}" >/dev/null 2>&1 &
  show_progress $!

  handle_exit $? 3 $total_steps "$step_message"

  snap_packages=(
    "yq"
  )
  step_message="Installing required snap packages"
  step_progress 4 $total_steps "$step_message"
  install_all_packages "snap" "${snap_packages[@]}" >/dev/null 2>&1 &
  show_progress $!
  handle_exit $? 4 $total_steps "$step_message"

  step_message="Create stackme folder"
  step_progress 5 $total_steps "$step_message"
  mkdir -p "$TOOL_BASE_DIR"

  handle_exit $? 5 $total_steps "$step_message"

  step_message="Download stacks templates"
  step_progress 6 $total_steps "$step_message"
  download_stack_compose_templates &
  handle_exit $? 6 $total_steps "$step_message"

  wait_for_input
}

install_docker() {
  # Ensure the script is running with elevated privileges
  if [[ $EUID -ne 0 ]]; then
    error "This script must be run as root or with sudo." >&2
    return 1
  fi

  info "Starting Docker installation..."

  # Step 1: Check and install prerequisites
  info "Checking prerequisites..."
  if dpkg -l |
    grep -qE "apt-transport-https|ca-certificates|curl|software-properties-common"; then
    success "Prerequisites are already installed."
  else
    info "Installing prerequisites..."
    if apt-get install -y -qq \
      apt-transport-https ca-certificates curl software-properties-common; then
      success "Prerequisites installed."
    else
      failure "Failed to install prerequisites." >&2
      return 1
    fi
  fi

  # Step 2: Add Docker's official GPG key and repository (if not already added)
  info "Checking Docker GPG key and repository..."
  keyring_path="/usr/share/keyrings/docker-archive-keyring.gpg"
  if [[ -f "$keyring_path" ]] &&
    grep -q "download.docker.com" /etc/apt/sources.list.d/docker.list; then
    success "Docker GPG key and repository are already configured."
  else
    info "Adding Docker GPG key and repository..."
    url="https://download.docker.com/linux/ubuntu/"
    arch="$(dpkg --print-architecture)"
    source="deb [arch=$arch signed-by=$keyring_path] $url $(lsb_release -cs) stable"
    if curl -fsSL https://download.docker.com/linux/ubuntu/gpg |
      gpg --dearmor --yes -o "$keyring_path" &&
      echo "$source" | tee /etc/apt/sources.list.d/docker.list >/dev/null; then
      success "Docker repository added."
    else
      failure "Failed to add Docker GPG key or repository." >&2
      return 1
    fi
  fi

  # Step 3: Install Docker (if not already installed)
  info "Checking Docker installation..."
  if command -v docker >/dev/null 2>&1; then
    success "Docker is already installed: $(docker --version)"
  else
    info "Installing Docker..."
    if apt-get update -qq &&
      apt-get install -y -qq docker-ce docker-ce-cli containerd.io; then
      success "Docker installed successfully."
    else
      failure "Failed to install Docker." >&2
      return 1
    fi
  fi

  # Step 4: Enable Docker service
  info "Checking Docker service status..."
  if systemctl is-enabled docker >/dev/null 2>&1; then
    success "Docker service is already enabled."
  else
    info "Enabling Docker service..."
    if systemctl enable docker >/dev/null 2>&1; then
      success "Docker service enabled to start on boot."
    else
      failure "Failed to enable Docker service." >&2
      return 1
    fi
  fi

  # Step 5: Start Docker service
  info "Checking if Docker service is running..."
  if systemctl is-active docker >/dev/null 2>&1; then
    success "Docker service is already running."
  else
    info "Starting Docker service..."
    if systemctl start docker >/dev/null 2>&1; then
      success "Docker service started successfully."
    else
      failure "Failed to start Docker service." >&2
      return 1
    fi
  fi

  success "Docker installation and setup completed successfully."
  return 0
}

# Function to merge server, network, and IP information
prompt_server_info() {
  local server_array ip_object merged_result

  # Get the server and network information
  local items='[
        { 
            "name": "server_name",
            "label": "Server Name",
            "description": "The name of the server", 
            "required": "yes",
            "validate_fn": "validate_name_value"
        }, 
        { 
            "name": "network_name", 
            "label": "Network Name", 
            "description": "The name of the network for Docker stack", 
            "required": "yes",
            "validate_fn": "validate_name_value"
        }
    ]'

  collected_items="$(run_collection_process "$items")"
  if [[ "$collected_items" == "[]" ]]; then
    error "Unable to retrieve server and network names."
    return 1
  fi

  collected_object="$(process_prompt_items "$collected_items")"

  # Print the merged result
  echo "$collected_object"
}

# Function to fetch server info and validate required fields
fetch_server_info() {
  local server_info_json
  server_info_json=$(prompt_server_info)

  if ! has_fields "$server_info_json" "server_name" "network_name"; then
    error "Unable to retrieve server and network names."
    return 1
  fi

  echo "$server_info_json"
}

# Function to save server info to a file
save_server_info() {
  local filename="$1"
  local content="$2"
  local dir

  dir=$(dirname "$filename")

  # Ensure directory exists before writing the file
  [[ -d "$dir" ]] || mkdir -p "$dir" || {
    error "Failed to create directory: $dir"
    return 1
  }

  echo "$content" >"$filename"
}

# Function to fetch and save server, network, and IP information
fetch_and_save_server_info() {
  local server_filename="$TOOL_BASE_DIR/server_info.json"
  local server_info_json

  # Check if the server info file exists
  if [[ -f "$server_filename" ]]; then
    server_info_json=$(<"$server_filename")

    # Validate JSON file
    if jq -e . >/dev/null 2>&1 <<<"$server_info_json"; then
      info "Valid $server_filename found. Using existing information."
    else
      error "Invalid content in $server_filename. Reinitializing..."
      server_info_json=$(fetch_server_info) || return 1
      save_server_info "$server_filename" "$server_info_json" || return 1
    fi
  else
    # Fetch new server info if the file does not exist
    server_info_json=$(fetch_server_info) || return 1
    save_server_info "$server_filename" "$server_info_json" || return 1
  fi

  echo "$server_info_json"
}

# Function to initialize the server information
initialize_server() {
  total_steps=8

  message="Initialization of server information"
  highlight "$message"

  # Step 1: Check if server_info.json exists and is valid
  step_progress 1 $total_steps "$message"
  server_info_json="$(fetch_and_save_server_info)"

  # Output results
  if [[ -z "$server_info_json" ]]; then
    exit 1
  fi

  # Extract server_name and network_name
  server_name="$(echo "$server_info_json" | jq -r ".server_name")"
  network_name="$(echo "$server_info_json" | jq -r ".network_name")"

  step_success 1 $total_steps "Server information saved to file $server_filename"

  # Update /etc/hosts
  step_message="Add name to server name in hosts file at path /etc/hosts"
  step_progress 2 $total_steps "$step_message"
  # Ensure /etc/hosts has the correct entry
  if ! grep -q "^127.0.0.1[[:space:]]$server_name" /etc/hosts; then
    sed -i "/^127.0.0.1[[:space:]]/d" /etc/hosts # Remove old entries
    echo "127.0.0.1 $server_name" >>/etc/hosts
  else
    step_info 2 $total_steps "$server_name is already present in /etc/hosts"
  fi
  handle_exit $? 2 $total_steps "$step_message"

  # Set Hostname
  step_message="Set Hostname"
  step_progress 3 $total_steps "$step_message"

  current_hostname="$(hostnamectl --static)"

  if [[ "$current_hostname" != "$server_name" ]]; then
    hostnamectl set-hostname "$server_name"
    handle_exit $? 3 $total_steps "Set Hostname"

    step_success 3 $total_steps "Hostname set to $server_name"

    # Allow a brief delay for changes to propagate
    sleep 1
  else
    step_info 3 $total_steps "Hostname is already set to $server_name"
  fi

  # Install docker
  step_message="Installing Docker"
  step_progress 4 $total_steps "$step_message"
  install_docker
  handle_exit $? 4 $total_steps "$step_message"

  # Initialize Docker Swarm
  step_message="Docker Swarm initialization"
  step_progress 5 $total_steps "$step_message"

  read -r ip _ <<<$(
    hostname -I | tr ' ' '\n' | grep -v '^127\.0\.0\.1' | tr '\n' ' '
  )
  if is_swarm_active; then
    step_warning 5 $total_steps "Swarm is already active"
  else
    # server_ip=$(curl ipinfo.io/ip)
    docker swarm init --advertise-addr $ip 2>&1

    handle_exit $? 5 $total_steps "$step_message"
  fi

  # Initialize Network
  message="Network initialization"
  step_progress 6 $total_steps "$message"
  create_network_if_not_exists "$network_name"
  handle_exit $? 6 $total_steps "$step_message"

  success "Server initialization complete"

  wait_for_input
}

######################################## END OF SETUP FUNCTIONS ###################################

############################# BEGIN OF STACK DEPLOYMENT UTILITARY FUNCTIONS #######################

# Function to create a PostgreSQL database
create_database_postgres() {
  local db_name="$1"
  local db_user="postgres"

  local container_id
  local db_exists

  # Display a message about the database creation attempt
  info "Creating PostgreSQL database: $db_name in POstgres container"

  # Check if the container is running
  container_id=$(docker ps -q --filter "name=^postgres")
  if [ -z "$container_id" ]; then
    error "Container '${container_name}' is not running. Cannot create database."
    return 1
  fi

  # Check if the database already exists
  db_exists=$(docker exec \
    "$container_id" psql -U "$db_user" -lqt | cut -d \| -f 1 | grep -qw "$db_name")
  if [ "$db_exists" ]; then
    info "Database '$db_name' already exists. Skipping creation."
    return 0
  fi

  # Create the database if it doesn't exist
  info "Creating database '$db_name'..."
  if docker exec "$container_id" \
    psql -U "$db_user" -c "CREATE DATABASE \"$db_name\";" >/dev/null 2>&1; then
    success "Database '$db_name' created successfully."
    return 0
  else
    error "Failed to create database '$db_name'. Please check the logs for details."
    return 1
  fi
}

# Function to create a MySQL database
create_database_mysql() {
  local db_password="$1"
  local db_name="$2"

  container_id=$(docker ps -q --filter "name=^mysql")

  # Check if the database already exists using the correct variable for the database name.
  docker exec -e MYSQL_PWD="$db_password" "$container_id" mysql -u root \
    -e "SHOW DATABASES LIKE '$db_name';" | grep -qw "$db_name"

  if [ $? -eq 0 ]; then
    prompt_message="Database '$db_name' already exists. Do you want to recreate it? (y/n)"
    confirm_var=$(request_confirmation "$prompt_message" "n")

    if [ "$confirm_var" == "Y" ] || [ "$confirm_var" == "y" ]; then
      # Drop the database
      docker exec -e MYSQL_PWD="$db_password" "$container_id" mysql -u root \
        -e "DROP DATABASE IF EXISTS $db_name;" >/dev/null 2>&1
      if [ $? -eq 0 ]; then
        echo "Database dropped successfully."
      else
        echo "Failed to drop database."
      fi
      # Create the database again
      docker exec -e MYSQL_PWD="$db_password" "$container_id" mysql -u root \
        -e "CREATE DATABASE $db_name;" >/dev/null 2>&1
    else
      info "Skipping database creation."
      return 0
    fi
  else
    # Create the database
    docker exec -e MYSQL_PWD="$db_password" "$container_id" mysql -u root \
      -e "CREATE DATABASE $db_name;" >/dev/null 2>&1

    # Verify if the database was created successfully
    docker exec -e MYSQL_PWD="$db_password" "$container_id" mysql -u root \
      -e "SHOW DATABASES LIKE '$db_name';" | grep -qw "$db_name"

    if [ $? -eq 0 ]; then
      success "Database '$db_name' created successfully."
      return 0
    else
      error "Failed to create database '$db_name'. Please check the logs for details."
      return 1
    fi
  fi
}

create_database() {
  local engine="$1"
  local db_name="$2"

  case "$engine" in
  "postgres")
    create_database_postgres "$db_name"
    ;;
  "mysql")
    create_database_mysql "$db_name"
    ;;
  *)
    error "Unsupported database engine: $engine"
    return 1
    ;;
  esac

}

get_network_name() {
  server_info_filename="${TOOL_BASE_DIR}/server_info.json"

  if [[ ! -f "$server_info_filename" ]]; then
    error "File $server_info_filename not found."
    return 1
  fi

  echo "$(cat "$server_info_filename" | jq -r ".network_name")"

  return 0
}

# Function to fetch stack compose file
fetch_stack_compose() {
  local stack_name="$1"
  local filepath="$2"

  download_file "$(stack_url "$stack_name")" "$filepath" "docker-compose.yaml"

  if [[ -f "$filepath/docker-compose.yaml" ]]; then
    return 0
  else
    return 1
  fi
}

# Function to get the database password from a configuration
fetch_database_password() {
  echo "$(fetch_stack_variable "$1" "db_password")"
}

# Function to get the database password from a configuration
fetch_database_username() {
  echo "$(fetch_stack_variable "$1" "db_username")"
}

# Function to create a PostgreSQL database
create_database_postgres() {
  local db_name="$1"
  local db_user="postgres"

  local container_id
  local db_exists

  # Display a message about the database creation attempt
  info "Creating PostgreSQL database: $db_name in Postgres container"

  # Check if the container is running
  container_id=$(docker ps -q --filter "name=^postgres")
  if [ -z "$container_id" ]; then
    error "Container '${container_name}' is not running. Cannot create database."
    return 1
  fi

  # Check if the database already exists
  db_exists=$(docker exec \
    "$container_id" psql -U "$db_user" -lqt | cut -d \| -f 1 | grep -qw "$db_name")
  if [ "$db_exists" ]; then
    info "Database '$db_name' already exists. Skipping creation."
    return 0
  fi

  # Create the database if it doesn't exist
  info "Creating database '$db_name'..."
  if docker exec "$container_id" \
    psql -U "$db_user" -c "CREATE DATABASE \"$db_name\";" >/dev/null 2>&1; then
    success "Database '$db_name' created successfully."
    return 0
  else
    error "Failed to create database '$db_name'. Please check the logs for details."
    return 1
  fi
}

# Function to create a PostgreSQL user
create_user_postgres() {
  local user_name="$1"
  local user_password="$2"
  local db_user="postgres"

  local container_id
  local user_exists

  # Display a message about the user creation attempt
  info "Creating PostgreSQL user: $user_name in Postgres container"

  # Check if the container is running
  container_id=$(docker ps -q --filter "name=^postgres")
  if [ -z "$container_id" ]; then
    error "Container 'postgres' is not running. Cannot create user."
    return 1
  fi

  # Check if the user already exists
  user_exists=$(
    docker exec "$container_id" \
      psql -U "$db_user" -tAc "SELECT 1 FROM pg_roles WHERE rolname='$user_name';"
  )

  if [ "$user_exists" == "1" ]; then
    info "User '$user_name' already exists. Skipping creation."
    return 0
  fi

  # Create the user if it doesn't exist
  info "Creating user '$user_name'..."
  if docker exec "$container_id" \
    psql -U "$db_user" -c "CREATE USER \"$user_name\" WITH PASSWORD '$user_password';" \
    >/dev/null 2>&1; then
    success "User '$user_name' created successfully."
    return 0
  else
    error "Failed to create user '$user_name'. Please check the logs for details."
    return 1
  fi
}

# Function to get the database password from a configuration
fetch_stack_variable() {
  local stack_name="$1"
  local variable_name="$2"

  local config_file="$TOOL_STACKS_DIR/$stack_name/stack_config.json"

  # Read the database password from the config file
  local variable_value
  variable_value=$(jq -r ".variables.$variable_name" "$config_file")

  echo "$variable_value"
}

manage_prometheus_config_file() {
  local prometheus_config_path="$1"
  shift
  local targets=("$@") # New targets passed as arguments

  prometheus_scrape_config="$(create_scrape_config_object --job_name "prometheus" \
    --metrics_path "/metrics" \
    --honor_timestamps "false" \
    --honor_labels "true" \
    --scrape_interval "10s" \
    --targets "$(join_array ',' "${targets[@]}")")"

  add_scrape_config_object "$prometheus_config_path" "$prometheus_scrape_config"

  return 0
}

manage_this_prometheus_config_file() {
  local urls=("$@")

  prometheus_config_path="${TOOL_BASE_DIR}/prometheus/prometheus.yml"
  manage_prometheus_config_file "$prometheus_config_path" \
    "${urls[@]}"
}

create_prometheus_datasource() {
  local prometheus_url="$1"

  mkdir -p "${TOOL_BASE_DIR}/prometheus"

  cat >"${TOOL_BASE_DIR}/prometheus/datasource.yml" <<EOL
apiVersion: 1
datasources:
- name: Prometheus
  type: prometheus
  url: https://$prometheus_url
  isDefault: true
  access: proxy
  editable: true
EOL
}

make_airflow_folders() {
  mkdir -p "$TOOL_STACKS_DIR/airflow/"{config,logs,dags,plugins}
}

make_folder_data_nodered() {
  mkdir -p "$TOOL_STACKS_DIR/nodered/data"
  chown -R 1000:1000 "$TOOL_STACKS_DIR/nodered/data"
}

make_folders_mosquitto() {
  mkdir -p "$TOOL_STACKS_DIR/stacks/mosquitto"
  mkdir -p "$TOOL_STACKS_DIR/stacks/mosquitto/data"
  mkdir -p "$TOOL_STACKS_DIR/stacks/mosquitto/log"
}

# Function to generate a firecrawl string
generate_firecrawl_api_key() {
  echo "fc-$(random_string)"
}

create_traccar_volumes() {
  docker pull traccar/traccar:latest >/dev/null 2>&1

  mkdir -p "$TOOL_STACKS_DIR/traccar"
  mkdir -p "$TOOL_STACKS_DIR/traccar/logs"

  docker run \
    --rm \
    --entrypoint cat \
    traccar/traccar:latest \
    /opt/traccar/conf/traccar.xml >"$TOOL_STACKS_DIR/traccar/traccar.xml"
}

# Function to custom smtp information
custom_smtp_information() {
  local identifier="$1"

  smtp_json="$(get_or_request_smtp_configuration)"

  # Add/update field smtp_secure to smtp_json
  smtp_secure="$(is_smtp_port_secure "$(echo "$smtp_json" | jq -r ".smtp_port")")"
  smtp_json="$(
    add_json_objects "$smtp_json" \
      "$(jq -n --arg smtp_secure "$smtp_secure" '{smtp_secure: $smtp_secure}')"
  )"

  echo "$(custom_json_keys_with_identifier "$identifier" "$smtp_json")"
}

# Function to display prompt items
display_prompt_items() {
  local prompt_items="$1"

  # Display requested variables to the user
  highlight "We will request the following variables:"

  # Iterate along json array
  for item in $(echo "$prompt_items" | jq -r '.[] | @base64'); do
    item=$(echo "$item" | base64 --decode)
    name=$(echo "$item" | jq -r '.name')
    description=$(echo "$item" | jq -r '.description')
    required=$(echo "$item" | jq -r '.required')

    if [[ "$required" == "yes" ]]; then
      required="*"
    else
      required=""
    fi

    highlight "\t$name$required: $description"
  done
}

build_stack_objects() {
  # Initialize an empty JSON array
  json_output="[]"

  # Iterate over each tool
  for name in "${!descriptions[@]}"; do
    desc="${descriptions[$name]}"
    category="Unknown"
    status="${tool_status[$name]:-Unknown}" # Get status from the new tool_status array

    # Find the category for the current tool
    for domain in "${!domains[@]}"; do
      if [[ " ${domains[$domain]} " =~ " $name " ]]; then
        category="$domain"
        break
      fi
    done

    # Append the JSON object to the array
    mask='. + [{"name": $name, "category": $category, "description": $desc, "status": $status}]'
    json_output=$(
      jq -c \
        --arg name "$name" \
        --arg desc "$desc" \
        --arg category "$category" \
        --arg status "$status" \
        "$mask" <<<"$json_output"
    )
  done

  echo "$json_output"
}

############################## END OF STACK DEPLOYMENT UTILITARY FUNCTIONS ########################

#################################### BEGIN OF STACK CONFIGURATION #################################

# Function to generate configuration files for startup
generate_stack_config_traefik() {
  local stack_name="traefik"

  prompt_items='[
      {
          "name": "traefik_url",
          "label": "Traefik Domain Name",
          "description": "Domain name for Traefik",
          "required": "yes",
          "validate_fn": "validate_url_suffix" 
      },
      {
          "name": "traefik_email_ssl",
          "label": "E-mail SSL",
          "description": "E-mail to receive SSL notifications",
          "required": "yes",
          "validate_fn": "validate_email_value" 
      },
      {
          "name": "traefik_username",
          "label": "Traefik Dashboard Username",
          "description": "Username for Traefik dashboard",
          "required": "yes",
          "validate_fn": "validate_username" 
      },
      {
          "name": "traefik_password",
          "label": "Traefik Dashboard Password",
          "description": "Password for Traefik dashboard",
          "required": "yes",
          "validate_fn": "validate_password" 
      }
  ]'

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
        "name": $stack_name,
        "target": "swarm",
        "actions": {
          "prompt": $prompt_items,
          "refresh": [
            {
              "name": "traefik_credentials",
              "description": "Traefik credentials",
              "command": "hash_credentials {{traefik_username}} {{traefik_password}}"
            }
          ]
        }
    }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate configuration files for portainer
generate_stack_config_portainer() {
  local stack_name="portainer"

  # Prompting step
  prompt_items='[
      {
          "name": "portainer_url",
          "label": "Portainer URL",
          "description": "URL to access Portainer remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix" 
      },
      {	
          "name": "portainer_username",
          "label": "Portainer Username",
          "description": "Username to access Portainer remotely",
          "required": "yes",
          "validate_fn": "validate_username" 
      },
      {
          "name": "portainer_password",
          "label": "Portainer Password",
          "description": "Password to access Portainer remotely",
          "required": "yes",
          "validate_fn": "validate_password"
      }
  ]'

  config_instructions=$(\
    jq -n \
    --arg stack_name "$stack_name" \
    --argjson prompt_items "$prompt_items" \
    --arg portainer_url "{{portainer_url}}" \
    --arg portainer_username "{{portainer_username}}" \
    --arg portainer_password "{{portainer_password}}" \
    '{  
        "name": $stack_name,
        "target": "swarm",
        "actions": {
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "portainer_agent_version",
                "description": "Portainer agent version",
                "command": ("get_latest_stable_version \"portainer/agent\"")
              },
              {
                "name": "portainer_ce_version",
                "description": "Portainer ce version", 
                "command": ("get_latest_stable_version \"portainer/portainer-ce\"")
              }
            ],
            "finalize": [
                {
                    "name": "signup_on_portainer",
                    "description": "Signup on portainer",
                    "command": ("signup_on_portainer \"" + $portainer_url + "\" \"" + $portainer_username + "\" \"" + $portainer_password + "\"")
                }
            ]
        }
    }') || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

generate_stack_config_monitor() {
  local stack_name="monitor"

  prompt_items='[
      {
          "name": "grafana_url",
          "label": "Grafana Domain Name",
          "description": "Domain name for Grafana",
          "required": "yes",
          "validate_fn": "validate_url_suffix" 
      },
      {
          "name": "prometheus_url",
          "label": "Prometheus Domain Name",
          "description": "Domain name for logs and metrics",
          "required": "yes",
          "validate_fn": "validate_url_suffix" 
      },
      {
          "name": "jaeger_url",
          "label": "Jaeger Domain Name",
          "description": "Domain for tracing tool",
          "required": "yes",
          "validate_fn": "validate_url_suffix" 
      },
      {
          "name": "node_exporter_url",
          "label": "Node Exporter Domain Name",
          "description": "Domain name for Node Exporter",
          "required": "yes",
          "validate_fn": "validate_url_suffix" 
      },
      {
          "name": "cadvisor_url",
          "label": "cAdvisor Domain Name",
          "description": "Domain name for cAdvisor",
          "required": "yes",
          "validate_fn": "validate_url_suffix" 
      },
      {
        "name": "kibana_url",
        "label": "Kibana Domain Name",
        "description": "Domain name for Kibana",
        "required": "yes",
        "validate_fn": "validate_url_suffix"
      }
  ]'

  # Ensure everything is quoted correctly
  config_instructions=$(jq -n \
    --arg stack_name "$stack_name" \
    --argjson prompt_items "$prompt_items" \
    '{
          "name": $stack_name,
          "target": "portainer",
          "actions": {
              "prompt": $prompt_items,
              "refresh": {
                "name": "elasticsearch_password",
                "description": "Elasticsearch password",
                "command": "random_string"
                
              }"
              "prepare": [
                {
                  "description": "Creating prometheus datasource", 
                  "command": "create_prometheus_datasource {{prometheus_url}}",
                },
                {
                  "description": "Creating prometheus scrape config", 
                  "command": "manage_this_prometheus_config_file {{prometheus_url}} {{jaeger_url}} {{node_exporter_url}} {{cadvisor_url}}",
                }
              ]
          }
      }') || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate Whoami service configuration JSON
generate_stack_config_generic_database() {
  local stack_name="$1"
  local image_version="$2"
  local db_username="$3"
  local db_password="$4"

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --arg image_version "$image_version" \
      --arg db_password "$db_password" \
      --arg db_username "$db_username" \
      --arg image_command "echo $image_version" \
      --arg db_user_command "echo $db_username" \
      --arg db_pass_command "echo $db_password" \
      '{
        "name": $stack_name,
        "target": "portainer",
        "actions": {
          "refresh": [
            {
              "name": "image_version",
              "description": "Image version",
              "command": $image_command
            },
            {
              "name": "db_username",
              "description": "Database username",
              "command": $db_user_command
            },
            {
              "name": "db_password",
              "description": "Database password",
              "command": $db_pass_command
            }
          ]
        }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate configuration files for redis
generate_stack_config_redis() {
  local stack_name='redis'
  local db_username="redis"
  local db_password="$(random_string)"

  highlight "Gathering $stack_name configuration"

  total_steps=1

  step_message="Retrieving $stack_name image version"
  step_info 1 $total_steps "$step_message"
  local image_version="$(get_latest_stable_version "redis")"
  handle_exit "$?" 1 $total_steps "$step_message"

  info "Redis version: $image_version"

  generate_stack_config_generic_database "$stack_name" "$image_version" \
    "$username" "$password"
}

# Function to generate Postgres service configuration JSON
generate_stack_config_postgres() {
  local stack_name='postgres'
  local image_version='15'
  local db_username="postgres"
  local db_password="$(random_string)"

  generate_stack_config_generic_database "$stack_name" "$image_version" \
    "$db_username" "$db_password"
}

# Function to generate PgVector service configuration JSON
generate_stack_config_pgvector() {
  local stack_name='pgvector'
  local image_version='pg16'
  local db_username="pgvector"
  local db_password="$(random_string)"

  generate_stack_config_generic_database "$stack_name" "$image_version" \
    "$db_username" "$db_password"
}

# Function to generate MySQL service configuration JSON
generate_stack_config_mysql() {
  local stack_name='mysql'
  local image_version='8.0'
  local db_username="mysql"
  local db_password="$(random_string)"

  generate_stack_config_generic_database "$stack_name" "$image_version" \
    "$db_username" "$db_password"
}

# Function to generate MariaDB service configuration JSON
generate_stack_config_mariadb() {
  local stack_name='mariadb'
  local image_version='latest'
  local db_username="mariadb"
  local db_password="$(random_string)"

  generate_stack_config_generic_database "$stack_name" "$image_version" \
    "$db_username" "$db_password"
}

# Function to generate MongoDB service configuration JSON
generate_stack_config_mongodb() {
  local stack_name='mongodb'
  local image_version='4.4'
  local db_username="mongodb"
  local db_password="$(random_string)"

  generate_stack_config_generic_database "$stack_name" "$image_version" \
    "$db_username" "$db_password"
}

# Function to generate Whoami service configuration JSON
generate_stack_config_whoami() {
  local stack_name="whoami"

  # Prompting step (escaped properly for Bash)
  local prompt_items='[
      {
          "name": "whoami_url",
          "label": "Whoami domain name",
          "description": "URL to access Whoami remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix" 
      }
  ]'

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
      "name": $stack_name,
      "target": "portainer",
      "actions": {
        "prompt": $prompt_items
      }
    }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate Airflow service configuration JSON
generate_stack_config_airflow() {
  local stack_name="airflow"

  # Prompting step (escaped properly for Bash)
  local prompt_items='[
    {
        "name": "airflow_url",
        "label": "Airflow domain name",
        "description": "URL to access Airflow remotely",
        "required": "yes",
        "validate_fn": "validate_url_suffix" 
    },
    {
        "name": "flower_url",
        "label": "Flower domain name",
        "description": "URL to access Flower remotely",
        "required": "yes",
        "validate_fn": "validate_url_suffix" 
    }
]'

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
      "name": $stack_name,
      "target": "portainer",
      "dependencies": ["postgres", "redis"],
      "actions": {
        "prompt": $prompt_items,
        "refresh": [
          {
            "name": "postgres_password",
            "description": "Fetching postgres password",
            "command": "fetch_database_password postgres",
          }
        ],
        "prepare": [
          {
            "name": "Airflow folders",
            "description": "Creating Airflow folders for storage",
            "command": "make_airflow_folders",
          }
        ]
      }
    }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate Metabase service configuration JSON
generate_stack_config_metabase() {
  local stack_name="metabase"

  # Prompting step (escaped properly for Bash)
  local prompt_items='[
      {
          "name": "metabase_url",
          "label": "Metabase domain name",
          "description": "URL to access Metabase remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix" 
      }
  ]'

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
      "name": $stack_name,
      "target": "portainer",
      "dependencies": ["postgres", "redis"],
      "actions": {
      "prompt": $prompt_items,
        "refresh": [
          {
            "name": "postgres_password",
            "description": "Fetching postgres password",
            "command": "fetch_database_password postgres",
          }
        ],
        "prepare": [
          {
            "name": "create_database_postgres_metabase",
            "description": "Creating Metabase database",
            "command": "create_database_postgres metabase",
          }
        ],
        "finalize": []
      }
    }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate stack configuration for yourls
generate_stack_config_yourls() {
  local stack_name="yourls"

  # Prompting step (escaped properly for Bash)
  prompt_items='[
      {
          "name": "yourls_url",
          "label": "Yourls domain name",
          "description": "URL to access Yourls remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix" 
      },
      {
          "name": "yourls_username",
          "label": "Yourls username",
          "description": "Yourls username",
          "required": "no",
          "validate_fn": "validate_empty_value" 
      },
      {
          "name": "yourls_password",
          "label": "Yourls password",
          "description": "Yourls password",
          "required": "no",
          "validate_fn": "validate_empty_value" 
      }
  ]'

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
      "name": $stack_name,
      "target": "portainer",
      "actions": {
        "prompt": $prompt_items,
        "refresh": [
          {
            "name": "mysql_password",
            "description": "Fetching mysql password",
            "command": "fetch_database_password mysql",
          }
        ],
        "prepare": [
          {
            "name": "create_yourls_database",
            "description": "Create Yourls database",
            "command": "create_database_postgres yourls",
          }
        ]
      }
    }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate stack configuration for appsmith
generate_stack_config_appsmith() {
  local stack_name="appsmith"

  # Prompting step (escaped properly for Bash)
  prompt_items='[
      {
          "name": "appsmith_url",
          "label": "Appsmith domain name",
          "description": "URL to access appsmith remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix" 
      }
  ]'

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
      "name": $stack_name,
      "target": "portainer",
      "actions": {
        "prompt": $prompt_items
      }
    }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate stack configuration for focalboard
generate_stack_config_focalboard() {
  local stack_name="focalboard"

  # Prompting step (escaped properly for Bash)
  prompt_items='[
      {
          "name": "focalboard_url",
          "label": "Focalboard domain name",
          "description": "URL to access focalboard remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix" 
      }
  ]'

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
      "name": $stack_name,
      "target": "portainer",
      "actions": {
        "prompt": $prompt_items
      }
    }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate stack configuration for excalidraw
generate_stack_config_excalidraw() {
  local stack_name="excalidraw"

  # Prompting step (escaped properly for Bash)
  prompt_items='[
      {
          "name": "excalidraw_url",
          "label": "Excalidraw domain name",
          "description": "URL to access excalidraw remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix" 
      }
  ]'

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
      "name": $stack_name,
      "target": "portainer",
      "actions": {
        "prompt": $prompt_items
      }
    }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate stack configuration for glpi
generate_stack_config_glpi() {
  local stack_name="glpi"

  # Prompting step (escaped properly for Bash)
  local prompt_items='[
      {
          "name": "glpi_url",
          "label": "GLPI domain name",
          "description": "URL to access GLPI remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix" 
      }
  ]'

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
      "name": $stack_name,
      "target": "portainer",
      "actions": {
        "prompt": $prompt_items
      }
    }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate stack configuration for qdrant
generate_stack_config_qdrant() {
  local stack_name="qdrant"

  # Prompting step (escaped properly for Bash)
  local prompt_items='[
      {
          "name": "qdrant_url",
          "label": "Qdrant domain name",
          "description": "URL to access Qdrant remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix" 
      }
  ]'

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
      "name": $stack_name,
      "target": "portainer",
      "actions": {
        "prompt": $prompt_items
      }
    }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate stack configuration for n8n
generate_stack_config_n8n() {
  local stack_name="n8n"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "n8n_editor_url",
          "label": "Editor domain name",
          "description": "URL to access Editor remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix" 
      },
      {
          "name": "n8n_webhook_url",
          "label": "Webhook domain name",
          "description": "URL to access Webhook remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix" 
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
        "name": $stack_name,
        "target": "portainer",
        "dependencies": ["postgres", "redis"],
        "actions": {
          "prompt": $prompt_items,
          "refresh": [
            {
              "name": "postgres_password",
              "description": "Fetching postgres password",
              "command": "fetch_database_password postgres",
            },
            {
              "name": "n8n_encryption_key",
              "description": "Generating N8N encryption key",
              "command": "random_string",
            },
            {
              "description": "Custom smtp information with label n8n",
              "command": "custom_smtp_information n8n",
            }
          ],
          "prepare": [
            {
              "name": "create_database_postgres_n8n",
              "description": "Creating N8N database",
              "command": "create_database_postgres n8n_queue",
            }
          ]
        }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate stack configuration for uptimekuma
generate_stack_config_uptimekuma() {
  local stack_name="uptimekuma"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "uptimekuma_url",
          "label": "Uptime kuma domain name",
          "description": "URL to access Uptime kuma remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix" 
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "actions": {
            "prompt": $prompt_items
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate stack configuration for odoo
generate_stack_config_odoo() {
  local stack_name="odoo"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "odoo_url",
          "label": "Odoo domain name",
          "description": "URL to access Odoo remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix" 
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "actions": {
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "postgres_password",
                "description": "Create postgres password",
                "command": "echo odoo",
              }
            ],
            "prepare": [
              {
                "name": "create_user odoo",
                "description": "Creating odoo user",
                "command": "create_user_postgres odoo odoo",
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

generate_stack_config_botpress() {
  local stack_name="botpress"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "botpress_url",
          "label": "Botpress domain name",
          "description": "URL to access Botpress remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "actions": {
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "postgres_password",
                "description": "Fetching postgres password",
                "command": "fetch_database_password postgres"
              }
            ],
            "prepare": [
              {
                "name": "create_database_postgres_botpress",
                "description": "Creating botpress database",
                "command": "create_database_postgres botpress"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

generate_stack_config_pgadmin() {
  local stack_name="pgadmin"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "pgadmin_url",
          "label": "PgAdmin domain name",
          "description": "URL to access PgAdmin remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      },
      {
          "name": "pgadmin_username",
          "label": "PgAdmin username",
          "description": "Username for PgAdmin",
          "required": "yes",
          "validate_fn": "validate_email_value"
      },
      {
          "name": "pgadmin_password",
          "label": "PgAdmin password",
          "description": "Password for PgAdmin",
          "required": "yes",
          "validate_fn": "validate_password"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "actions": {
            "prompt": $prompt_items
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

generate_stack_config_phpadmin() {
  local stack_name="phpadmin"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "phpadmin_url",
          "label": "PHPAdmin domain name",
          "description": "URL to access PHPAdmin remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["mysql"],
          "actions": {
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "mysql_password",
                "description": "Fetching mysql password",
                "command": "fetch_database_password mysql"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate NocoDB service configuration JSON
generate_stack_config_nocodb() {
  local stack_name="nocodb"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "nocodb_url",
          "label": "NocoDB domain name",
          "description": "URL to access NocoDB remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["postgres"],
          "actions": {
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "postgres_password",
                "description": "Fetching postgres password",
                "command": "fetch_database_password postgres"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

generate_stack_config_ntfy() {
  local stack_name="ntfy"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "ntfy_url",
          "label": "Ntfy domain name",
          "description": "URL to access ntfy remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      },
      {
          "name": "ntfy_username",
          "label": "Ntfy username",
          "description": "URL to access username remotely",
          "required": "yes",
          "validate_fn": "validate_username"
      },
      {
          "name": "ntfy_password",
          "label": "Ntfy password",
          "description": "URL to access password remotely",
          "required": "yes",
          "validate_fn": "validate_password"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "actions": {
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "ntfy_credentials",
                "description": "Fetching ntfy password",
                "command": "hash_credentials {{ntfy_username}} {{ntfy_password}}"
              }
            ]
          }

      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate ClickHouse service configuration JSON
generate_stack_config_clickhouse() {
  local stack_name="clickhouse"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "clickhouse_url",
          "label": "Ntfy domain name",
          "description": "URL to access ntfy remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      },
      {
          "name": "clickhouse_username",
          "label": "Ntfy username name",
          "description": "Username to access ntfy remotely",
          "required": "yes",
          "validate_fn": "validate_username"
      },
      {
          "name": "clickhouse_password",
          "label": "Ntfy password name",
          "description": "Password to access ntfy remotely",
          "required": "yes",
          "validate_fn": "validate_password"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "actions": {
            "prompt": $prompt_items
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate RedisInsight service configuration JSON
generate_stack_config_redisinsight() {
  local stack_name="redisinsight"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "redisinsight_url",
          "label": "Redisinsight domain name",
          "description": "URL to access ntfy remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["redis"],
          "actions":{
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "redisinsight_encryption_key",
                "description": "Fetching redisinsight encryption key",
                "command": "random_string"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

generate_stack_config_redis_commander() {
  local stack_name="redis_commander"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "redis_commander_url",
          "label": "Redis Commander domain name",
          "description": "URL to access Redis Commander remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["redis"],
          "actions": {
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "redis_password",
                "description": "Fetching redis password",
                "command": "fetch_database_password redis"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate Weavite service configuration JSON
generate_stack_config_weaviate() {
  local stack_name="weaviate"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "weaviate_url",
          "label": "Weavite domain name",
          "description": "URL to access Weavite remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": [],
          "actions":{
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "weaviate_token",
                "description": "Fetching Weavite API token",
                "command": "random_string"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate RabbtiMQ service configuration JSON
generate_stack_config_rabbitmq() {
  local stack_name="rabbitmq"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "rabbitmq_url",
          "label": "RabbitMQ domain name",
          "description": "URL to access RabbitMQ remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      },
      {
          "name": "rabbitmq_username",
          "label": "RabbitMQ username name",
          "description": "URL to access RabbitMQ remotely",
          "required": "yes",
          "validate_fn": "validate_username"
      },
      {
          "name": "rabbitmq_password",
          "label": "RabbitMQ domain name",
          "description": "URL to access RabbitMQ remotely",
          "required": "yes",
          "validate_fn": "validate_password"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "actions":{
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "rabbitmq_cookie_key",
                "description": "Fetching RabbitMQ cookie key",
                "command": "random_string"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate Langfuse service configuration JSON
generate_stack_config_langfuse() {
  local stack_name="langfuse"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "langfuse_url",
          "label": "Langfuse domain name",
          "description": "URL to access Langfuse remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["clickhouse", "postgres"],
          "actions":{
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "langfuse_encryption_key",
                "description": "Fetching Langfuse encryption key",
                "command": "random_string"
              },
              {
                "name": "langfuse_secret_key",
                "description": "Fetching Langfuse secret key",
                "command": "random_string"
              },
              {
                "name": "langfuse_salt",
                "description": "Fetching Langfuse salt",
                "command": "random_string"
              },
              {
                "name": "postgres_password",
                "description": "Fetching Postgres password",
                "command": "fetch_database_password postgres"
              }
            ],
            "prepare": [
              {
                "name": "create_langfuse_database",
                "description": "Creating Langfuse database",
                "command": "create_database_postgres langfuse",
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate TranscreveZap service configuration JSON
generate_stack_config_transcrevezap() {
  local stack_name="transcrevezap"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "transcrevezap_url",
          "label": "TranscreveZap domain name",
          "description": "URL to access TranscreveZap remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      },
      {
          "name": "transcrevezap_api_url",
          "label": "TranscreveZap API domain name",
          "description": "URL to access TranscreveZap API remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      },
      {
          "name": "transcrevezap_username",
          "label": "TranscreveZap username",
          "description": "Username to access TranscreveZap remotely",
          "required": "yes",
          "validate_fn": "validate_username"
      },
      {
          "name": "transcrevezap_password",
          "label": "Langfuse password",
          "description": "Password to access TranscreveZap remotely",
          "required": "yes",
          "validate_fn": "validate_password"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "actions": {
            "prompt": $prompt_items
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate Langflow service configuration JSON
generate_stack_config_langflow() {
  local stack_name="langflow"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "langflow_url",
          "label": "Langflow domain name",
          "description": "URL to access Langflow remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      },
      {
          "name": "langflow_username",
          "label": "Langflow username",
          "description": "Username to access Langflow remotely",
          "required": "yes",
          "validate_fn": "validate_username"
      },
      {
          "name": "langflow_password",
          "label": "Langfuse password",
          "description": "Password to access Langflow remotely",
          "required": "yes",
          "validate_fn": "validate_password"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["postgres"],
          "actions": {
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "postgres_password",
                "description": "Fetching Postgres password",
                "command": "fetch_database_password postgres"
              },
              {
                "name": "langflow_secret_key",
                "description": "Create Langflow secret key",
                "command": "uuidgen"
              }
            ],
            "prepare": [
              {
                "name": "create_langflow_db",
                "description": "Create Langflow database",
                "command": "create_database_postgres langflow"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate wuzapi service configuration JSON
generate_stack_config_wuzapi() {
  local stack_name="wuzapi"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "wuzapi_url",
          "label": "Wuzapi domain name",
          "description": "URL to access Wuzapi remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["redis", "postgres"],
          "actions":{
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "wuzapi_secret_key",
                "description": "Generate Wuzapi secret key",
                "command": "random_string"
              },
              {
                "name": "wuzapi_api_key",
                "description": "Generate Wuzapi api key",
                "command": "random_string"
              },
              {
                "name": "postgres_password",
                "description": "Fetch postgres password",
                "command": "fetch_database_password postgres"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate OpenProject service configuration JSON
generate_stack_config_openproject() {
  local stack_name="openproject"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "openproject_url",
          "label": "OpenProject domain name",
          "description": "URL to access OpenProject remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["redis", "postgres"],
          "actions":{
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "openproject_key",
                "description": "Generate OpenProject secret key",
                "command": "random_string"
              },
              {
                "name": "postgres_password",
                "description": "Fetching postgres password",
                "command": "fetch_database_password postgres",
              }
            ],
            "prepare": [
              {	
                "name": "create_openproject_db",
                "description": "Create OpenProject database",
                "command": "create_database_postgres openproject"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate Flowise service configuration JSON
generate_stack_config_flowise() {
  local stack_name="flowise"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "flowise_url",
          "label": "OpenProject domain name",
          "description": "URL to access Flowise remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      },
      {
          "name": "flowise_username",
          "label": "OpenProject username",
          "description": "Username to access Flowise remotely",
          "required": "yes",
          "validate_fn": "validate_username"
      },
      {
          "name": "flowise_password",
          "label": "OpenProject password",
          "description": "Password to access Flowise remotely",
          "required": "yes",
          "validate_fn": "validate_password"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["redis", "postgres"],
          "actions":{
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "flowise_encryption_key",
                "description": "Generate Flowise encryption key",
                "command": "random_string"
              },
              {
                "name": "postgres_password",
                "description": "Fetch postgres password",
                "command": "fetch_database_password postgres"
              }
            ],
            "prepare": [
              {
                "name": "create_flowise_database",
                "description": "  ",
                "command": "create_database_postgres flowise"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate Wordpress service configuration JSON
generate_stack_config_wordpress() {
  local stack_name="wordpress"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "wordpress_site_name",
          "label": "Wordpress site name",
          "description": "Name of site on Wordpress",
          "required": "yes",
          "validate_fn": "validate_empty_value"
      },
      {
          "name": "wordpress_url",
          "label": "Wordpress domain name",
          "description": "URL to access Wordpress remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["mysql", "redis"],
          "actions":{
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "mysql_password",
                "description": "Fetch MySQL password",
                "command": "fetch_database_password mysql"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate EasyAppointments service configuration JSON
generate_stack_config_easyappointments() {
  local stack_name="easyappointments"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "easyappointments_url",
          "label": "EasyAppointments URL",
          "description": "URL to access EasyAppointments remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["mysql"],
          "actions":{
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "mysql_password",
                "description": "Fetch mysql password",
                "command": "fetch_database_password mysql"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate Nocobase service configuration JSON
generate_stack_config_nocobase() {
  local stack_name="nocobase"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "nocobase_url",
          "label": "Nocobase URL",
          "description": "URL to access Nocobase remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      },
      {
          "name": "nocobase_email",
          "label": "Nocobase site name",
          "description": "E-mail for Nocobase",
          "required": "yes",
          "validate_fn": "validate_email_value"
      },
      {
          "name": "nocobase_username",
          "label": "Nocobase username",
          "description": "Username to access Nocobase remotely",
          "required": "yes",
          "validate_fn": "validate_username"
      },
      {
          "name": "nocobase_password",
          "label": "Nocobase password",
          "description": "Password to access Nocobase remotely",
          "required": "yes",
          "validate_fn": "validate_password"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["redis", "postgres"],
          "actions":{
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "nocobase_app_key",
                "description": "Generate Nocobase app key",
                "command": "random_string"
              },
              {
                "name": "nocobase_encryption_key",
                "description": "Generate Nocobase app key",
                "command": "random_string"
              },
              {
                "name": "postgres_password",
                "description": "Fetch postgres password",
                "command": "fetch_database_password postgres"
              }
            ],
            "prepare": [
              {
                "name": "create_flowise_database",
                "description": "Create Flowise database",
                "command": "create_database_postgres nocobase"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate MatterMost service configuration JSON
generate_stack_config_mattermost() {
  local stack_name="mattermost"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "mattermost_url",
          "label": "MatterMost URL",
          "description": "URL to access MatterMost remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["postgres"],
          "actions": {
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "postgres_password",
                "description": "Fetch postgres password",
                "command": "fetch_database_password postgres"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate Traccar service configuration JSON
generate_stack_config_traccar() {
  local stack_name="traccar"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "traccar_url",
          "label": "Traccar URL",
          "description": "URL to access Traccar remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "actions": {
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "mysql_password",
                "description": "Fetching mysql password",
                "command": "random_string",
              }
            ],
            "prepare": [
              {
                "name": "startup_traccar_volumes",
                "description": "Creating Traccar volumes",
                "command": "create_traccar_volumes",
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate Evolution service configuration JSON
generate_stack_config_evolution() {
  local stack_name="evolution"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "evolution_url",
          "label": "Evolution URL",
          "description": "URL to access Evolution remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["postgres", "rabbitmq"],
          "actions":{
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "postgres_password",
                "description": "fetch postgres password",
                "command": "fetch_database_password postgres"
              },
              {
                "name": "evolution_api_key",
                "description": "Generate Evolution API key",
                "command": "random_string"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate Evolution Lite service configuration JSON
generate_stack_config_evolution_lite() {
  local stack_name="evolution_lite"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "evolution_url",
          "label": "Evolution URL",
          "description": "URL to access Evolution remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["postgres", "rabbitmq", "redis"],
          "actions":{
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "postgres_password",
                "description": "Fetch postgres password",
                "command": "fetch_database_password postgres"
              },
              {
                "name": "evolution_api_key",
                "description": "Generate Evolution API key",
                "command": "random_string" 
              }
            ],
            "prepare": [
              {
                "name": "create_evolution_lite_db",
                "description": "Create Evolution Lite database",
                "command": "create_database_postgres evolution_lite"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate Firecrawl service configuration JSON
generate_stack_config_firecrawl() {
  local stack_name="firecrawl"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "firecrawl_url",
          "label": "Firecrawl URL",
          "description": "URL to access Firecrawl remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      },
      {
          "name": "firecrawl_openai_api_key",
          "label": "OpenAPI Key",
          "description": "OpenAI API Key",
          "required": "yes",
          "validate_fn": "validate_empty_value"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["redis", "postgres", "rabbitmq"],
          "actions":{
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "postgres_password",
                "description": "fetch postgres password",
                "command": "fetch_database_password postgres"
              },
              {
                "name": "firecrawl_api_key",
                "description": "Generate Firecrawl key",
                "command": "generate_firecrawl_api_key"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate Ollama service configuration JSON
generate_stack_config_ollama() {
  local stack_name="ollama"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "ollama_url",
          "label": "Ollama URL",
          "description": "URL to access Ollama remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      },
      {
          "name": "ollama_api_url",
          "label": "Ollama API URL",
          "description": "URL to access Ollama API remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "actions":{
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "ollama_webui_secret_key",
                "description": "Generate Ollama webui secret key",
                "command": "random_string"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate StirlingPDF service configuration JSON
generate_stack_config_stirlingpdf() {
  local stack_name="stirlingpdf"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "stirlingpdf_name",
          "label": "StirlingPDF Name",
          "description": "Name for StirlingPDF app",
          "required": "yes",
          "validate_fn": "validate_empty_value"
      },
      {
          "name": "stirlingpdf_description",
          "label": "StirlingPDF Description",
          "description": "Description for StirlingPDF app",
          "required": "yes",
          "validate_fn": "validate_empty_value"
      },
      {
          "name": "stirlingpdf_url",
          "label": "StirlingPDF URL",
          "description": "URL to access StirlingPDF remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "actions": {
            "prompt": $prompt_items
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate TwentyCRM service configuration JSON
generate_stack_config_twentycrm() {
  local stack_name="twentycrm"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "twentycrm_url",
          "label": "TwentyCRM URL",
          "description": "URL to access TwentyCRM remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["postgres"],
          "actions": {
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "twentycrm_postgres_password",
                "description": "Generate StirlingPDF database password",
                "command": "random_string"
              },
              {
                "name": "twentycrm_secret_key",
                "description": "Generate TwentyCRM secret key",
                "command": "random_string"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate NextCloud Lite service configuration JSON
generate_stack_config_nextcloud() {
  local stack_name="nextcloud"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "nextcloud_url",
          "label": "NextCloud URL",
          "description": "URL to access NextCloud remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      },
      {
          "name": "nextcloud_username",
          "label": "NextCloud username",
          "description": "Username to access NextCloud remotely",
          "required": "yes",
          "validate_fn": "validate_username"
      },
      {
          "name": "nextcloud_password",
          "label": "NextCloud password",
          "description": "Password to access NextCloud remotely",
          "required": "yes",
          "validate_fn": "validate_password"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["redis", "postgres"],
          "actions": {
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "postgres_password",
                "description": "Fetch postgres database password",
                "command": "fetch_database_password postgres"
              }
            ],
            "prepare": [
              {
                "name": "create_nextcloud_database",
                "description": "Create NextCloud database",
                "command": "create_database postgres nextcloud"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate Quepasa Lite service configuration JSON
generate_stack_config_quepasa() {
  local stack_name="quepasa"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "quepasa_title",
          "label": "Quepasa URL",
          "description": "Title to display on Quepasa site",
          "required": "yes",
          "validate_fn": "validate_empty_value"
      },
      {
          "name": "quepasa_url",
          "label": "Quepasa URL",
          "description": "URL to access Quepasa remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      },
      {
          "name": "quepasa_email_username",
          "label": "Quepasa username",
          "description": "Username to access Quepasa remotely",
          "required": "yes",
          "validate_fn": "validate_email_value"
      },
      {
          "name": "quepasa_email_password",
          "label": "Quepasa password",
          "description": "Password to access Quepasa remotely",
          "required": "yes",
          "validate_fn": "validate_password"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["postgres"],
          "actions": {
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "postgres_password",
                "description": "Fetch postgres database password",
                "command": "fetch_database_password postgres"
              },
              {
                "name": "quepasa_signing_secret",
                "description": "Generate Quepasa signing secret",
                "command": "random_string"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate Strapi service configuration JSON
generate_stack_config_strapi() {
  local stack_name="strapi"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "strapi_url",
          "label": "Quepasa URL",
          "description": "URL to access Quepasa remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["mysql"],
          "actions": {
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "strapi_jwt_secret",
                "description": "Generate Strapi JWT secret",
                "command": "random_string"
              },
              {
                "name": "strapi_admin_jwt_secret",
                "description": "Generate Strapi Admin JWT secret",
                "command": "random_string"
              },
              {
                "name": "strapi_app_keys",
                "description": "Generate Strapi app keys",
                "command": "random_string"
              },
              {
                "name": "mysql_password",
                "description": "Fetch mysql database password",
                "command": "fetch_database_password mysql"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate Outline service configuration JSON
generate_stack_config_outline() {
  local stack_name="outline"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "outline_url",
          "label": "Outline URL",
          "description": "URL to access Outline remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      },
      {
          "name": "outline_google_client_id",
          "label": "Google Client ID",
          "description": "ID of the client on Google Cloud Platform",
          "required": "yes",
          "validate_fn": "validate_empty_value"
      },
      {
          "name": "outline_google_client_secret",
          "label": "Google Client Secret",
          "description": "Secret key of the client on Google Cloud Platform",
          "required": "yes",
          "validate_fn": "validate_empty_value"
      },
      {
          "name": "outline_google_api_key",
          "label": "Google API Key",
          "description": "API key of the client on Google Cloud Platform",
          "required": "yes",
          "validate_fn": "validate_empty_value"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["redis", "postgres"],
          "actions": {
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "outline_secret_key",
                "description": "Generate Strapi JWT secret",
                "command": "random_string"
              },
              {
                "name": "outline_utils_secret",
                "description": "Generate Strapi Admin JWT secret",
                "command": "random_string"
              },
              {
                "name": "postgres_password",
                "description": "Fetch postgres database password",
                "command": "fetch_database_password postgres"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate Mautic service configuration JSON
generate_stack_config_mautic() {
  local stack_name="mautic"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "mautic_url",
          "label": "Mautic URL",
          "description": "URL to access Mautic remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      },
      {
          "name": "mautic_email_username",
          "label": "Mautic username",
          "description": "Username to access Mautic remotely",
          "required": "yes",
          "validate_fn": "validate_username"
      },
      {
          "name": "mautic_email_password",
          "label": "Mautic password",
          "description": "Password to access Mautic remotely",
          "required": "yes",
          "validate_fn": "validate_password"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["mysql"],
          "actions": {
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "mysql_password",
                "description": "Fetch mysql database password",
                "command": "fetch_database_password mysql"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate Woofed service configuration JSON
generate_stack_config_woofed() {
  local stack_name="woofed"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "woofed_url",
          "label": "Woofed URL",
          "description": "URL to access Woofed remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      },
      {
          "name": "woofed_username",
          "label": "Woofed username",
          "description": "Username to access Woofed remotely",
          "required": "yes",
          "validate_fn": "validate_empty_value"
      },
      {
          "name": "woofed_password",
          "label": "Woofed password",
          "description": "Password to access Woofed remotely",
          "required": "yes",
          "validate_fn": "validate_empty_value"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["pgvector", "evolution"],
          "actions": {
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "pgvector_password",
                "description": "Fetch pgvector database password",
                "command": "fetch_database_password pgvector"
              },
              {
                "name": "woofed_encryption_key",
                "description": "Generate Woofed encryption key",
                "command": "random_string"
              },
              {
                "name": "evolution_url",
                "description": "Fetch Evolution URL",
                "command": "fetch_stack_variable evolution evolution_url"
              },
              {
                "name": "evolution_api_key",
                "description": "Fetch Evolution API key",
                "command": "fetch_stack_variable evolution evolution_api_key"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate Iceberg service configuration JSON
generate_stack_config_iceberg() {
  local stack_name="iceberg"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "iceberg_url",
          "label": "Iceberg broker URL",
          "description": "URL to access Iceberg broker remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      },
      {
          "name": "aws_access_key_id",
          "label": "AWS access key ID",
          "description": "access key ID on AWS cloud",
          "required": "yes",
          "validate_fn": "validate_empty_value"
      },
      {
          "name": "aws_secret_access_key",
          "label": "AWS secret access key",
          "description": "Secret access key on AWS cloud",
          "required": "yes",
          "validate_fn": "validate_empty_value"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["minio"],
          "actions": {
            "prompt": $prompt_items
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

generate_stack_config_delta_lake() {
  local stack_name="delta_lake"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "minio_url",
          "label": "Iceberg broker URL",
          "description": "URL to access Iceberg broker remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      },
      {
          "name": "minio_username",
          "label": "Minio username",
          "description": "Username to access Minio remotely",
          "required": "yes",
          "validate_fn": "validate_username"
      },
      {
          "name": "minio_password",
          "label": "Iceberg broker URL",
          "description": "Password to access Iceberg broker remotely",
          "required": "yes",
          "validate_fn": "validate_password"
      },
      {
          "name": "superset_url",
          "label": "URL to access Superset remotely",
          "description": "URL to access Superset remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "actions": {
            "prompt": $prompt_items
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

# Function to generate Moodle service configuration JSON
generate_stack_config_moodle() {
  local stack_name="moodle"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "moodle_project_name",
          "label": "Moodle project name",
          "description": "Project name of Moodle app",
          "required": "yes",
          "validate_fn": "validate_empty_value"
      },
      {
          "name": "moodle_url",
          "label": "Moodle URL",
          "description": "URL to access Moodle rest remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      },
      {
          "name": "moodle_username",
          "label": "Moodle username",
          "description": "Username to access Moodle remotely",
          "required": "yes",
          "validate_fn": "validate_username"
      },
      {
          "name": "moodle_password",
          "label": "Moodle password",
          "description": "Password to access Moodle remotely",
          "required": "yes",
          "validate_fn": "validate_password"
      },
      {
          "name": "moodle_email",
          "label": "Moodle e-mail",
          "description": "E-mail to access Moodle remotely",
          "required": "yes",
          "validate_fn": "validate_email_value"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["mariadb"],
          "actions": {
            "prompt": $prompt_items,
            "refresh": [
              {
                "description": "Fetch mariadb database password",
                "name": "mariadb_password",
                "command": "fetch_database_password mariadb"
              },
              {
                "description": "Custom smtp with identifier moodle",
                "command": "custom_smtp_information moodle",
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

generate_stack_config_mosquitto() {
  local stack_name="mosquitto"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "mosquitto_broker_url",
          "label": "Mosquitto broker URL",
          "description": "URL to access Mosquitto broker remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      },
      {
          "name": "mosquitto_ui_url",
          "label": "Mosquitto UI URL",
          "description": "URL to access Mosquitto UI remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "actions": {
            "prompt": $prompt_items,
            "prepare": [
              {
                "description": "Make folders for Mosquitto volumes",
                "command": "make_folders_mosquitto"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

generate_stack_config_nodered() {
  local stack_name="nodered"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "nodered_url",
          "label": "NodeRed URL",
          "description": "URL to access NodeRed remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "actions":{
            "prompt": $prompt_items,
            "prepare": [
              {
                "name": "make_folder_data_nodered",
                "description": "Make folder data for NodeRed",
                "command": "make_folder_data_nodered",
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

generate_stack_config_lowcoder() {
  local stack_name="lowcoder"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "lowcoder_url",
          "label": "Lowcoder URL",
          "description": "URL to access Lowcoder remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["mongodb"],
          "actions":{
            "prompt": $prompt_items,
            "prepare": [
              {
                "description": "Make folder data for NodeRed",
                "command": "make_folder_data_nodered",
              }
            ],
            "refresh": [
              {
                "name": "lowcoder_api_secret_key",
                "description": "Lowcoder API secret key",
                "command": "random_string"
              }, 
              {
                "name": "lowcoder_encryption_key",
                "description": "Lowcoder API secret key",
                "command": "random_string"
              },
              {
                "name": "lowcoder_encryption_salt",
                "description": "Lowcoder API secret key",
                "command": "random_string"
              },
              {
                "description": "Custom smtp with identifier lowcoder",
                "command": "custom_smtp_information lowcoder",
              },
              {
                "name": "mongodb_username",
                "description": "MongoDB username",
                "command": "fetch_database_username mongodb"
              },
              {
                "name": "mongodb_password",
                "description": "MongoDB password",
                "command": "fetch_database_password mongodb"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

generate_stack_config_baserow() {
  local stack_name="baserow"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "baserow_url",
          "label": "Baserow URL",
          "description": "URL to access Baserow remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "actions":{
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "postgres_password",
                "description": "Fetch postgres password",
                "command": "fetch_database_password postgres"
              },
              {
                "description": "Custom smtp with identifier baserow",
                "command": "custom_smtp_information baserow",
              }
            ],
            "prepare": [
              {
                "name": "create_baserow_database",
                "description": "Create postgres database baserow",
                "command": "create_database_postgres baserow",
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

generate_stack_config_docuseal() {
  local stack_name="docuseal"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "docuseal_url",
          "label": "Docuseal URL",
          "description": "URL to access Docuseal remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["postgres", "redis"],
          "actions":{
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "postgres_password",
                "description": "Fetch postgres password",
                "command": "fetch_database_password postgres"
              },
              {
                "description": "Custom smtp with identifier docuseal",
                "command": "custom_smtp_information docuseal",
              },
              {
                "name": "docuseal_secret_key",
                "description": "Docuseal secret key",
                "command": "random_string"
              }
            ],
            "prepare": [
              {
                "name": "create_docuseal_database",
                "description": "Create postgres database docuseal",
                "command": "create_database_postgres docuseal",
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

generate_stack_config_humhub() {
  local stack_name="humhub"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "humhub_url",
          "label": "Humhub URL",
          "description": "URL to access Humhub remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      },
      {
          "name": "humhub_username",
          "label": "Humhub Username",
          "description": "Username to access Humhub remotely",
          "required": "yes",
          "validate_fn": "validate_username"
      },
      {
          "name": "humhub_password",
          "label": "Humhub Password",
          "description": "Password to access Humhub remotely",
          "required": "yes",
          "validate_fn": "validate_password"
      },
      {
        "name": "humhub_email",
        "label": "Humhub Email",
        "description": "Email to access Humhub remotely",
        "required": "yes",
        "validate_fn": "validate_email_value"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["mysql"],
          "actions":{
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "mysql_password",
                "description": "Fetch mysql password",
                "command": "fetch_database_password mysql"
              },
              {
                "description": "Custom smtp with identifier docuseal",
                "command": "custom_smtp_information humhub",
              }
            ],
            "prepare": [
              {
                "name": "create_humhub_database",
                "description": "Create mysql database humhub",
                "command": "create_database_mysql {{mysql_password}} humhub",
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

generate_stack_config_calcom() {
  local stack_name="calcom"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "calcom_url",
          "label": "Calcom URL",
          "description": "URL to access Calcom remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["postgres"],
          "actions":{
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "calcom_nextauth_secret",
                "description": "Generate calcom nextauth secret",
                "command": "random_string"
              },
              {
                "description": "Custom smtp with identifier docuseal",
                "command": "custom_smtp_information humhub",
              },
              {
                "name": "postgres_password",
                "description": "Fetch postgres password",
                "command": "fetch_database_password postgres",
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

generate_stack_config_vaultwarden() {
  local stack_name="vaultwarden"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "vaultwarden_url",
          "label": "Vaultwarden URL",
          "description": "URL to access Vaultwarden remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["postgres"],
          "actions":{
            "prompt": $prompt_items,
            "refresh": [
              {
                "description": "Custom smtp with identifier vaultwarden",
                "command": "custom_smtp_information vaultwarden",
              },
              {
                "name": "postgres_password",
                "description": "Fetch postgres password",
                "command": "fetch_database_password postgres",
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

generate_stack_config_chatwoot() {
  local stack_name="chatwoot"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
        "name": "chatwoot_url",
        "label": "Chatwoot URL",
        "description": "URL to access Chatwoot remotely",
        "required": "yes",
        "validate_fn": "validate_url_suffix"
      },
      {
        "name": "chatwoot_company_name",
        "label": "Chatwoot app name",
        "description": "Name of app on Chatwoot",
        "required": "yes",
        "validate_fn": "validate_empty_value"
      },
      {
        "name": "chatwoot_admin_email",
        "label": "Chatwoot admin email",
        "description": "Email of admin on Chatwoot",
        "required": "yes",
        "validate_fn": "validate_email_value"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["postgres"],
          "actions":{
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "chatwoot_encryption_key",
                "description": "Generate chatwoot encryption key",
                "command": "random_string"
              },
              {
                "name": "postgres_password",
                "description": "Fetch postgres password",
                "command": "fetch_database_password postgres"
              },
              {
                "description": "Custom smtp with identifier chatwoot",
                "command": "custom_smtp_information chatwoot"
              }
            ],
            "prepare": [
              {
                "name": "chatwoot_database",
                "description": "Create database chatwoot on Postgres",
                "command": "create_database_postgres chatwoot",
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

generate_stack_config_chatwoot_nestor() {
  local stack_name="chatwoot_nestor"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
        "name": "chatwoot_url",
        "label": "Chatwoot URL",
        "description": "URL to access Chatwoot remotely",
        "required": "yes",
        "validate_fn": "validate_url_suffix"
      },
      {
        "name": "chatwoot_company_name",
        "label": "Chatwoot app name",
        "description": "Name of app on Chatwoot",
        "required": "yes",
        "validate_fn": "validate_empty_value"
      },
      {
        "name": "chatwoot_admin_email",
        "label": "Chatwoot admin email",
        "description": "Email of admin on Chatwoot",
        "required": "yes",
        "validate_fn": "validate_email_value"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["postgres"],
          "actions":{
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "chatwoot_encryption_key",
                "description": "Generate chatwoot encryption key",
                "command": "random_string",
              },
              {
                "name": "postgres_password",
                "description": "Fetch postgres password",
                "command": "fetch_database_password postgres",
              },
              {
                "description": "Custom smtp with identifier chatwoot",
                "command": "custom_smtp_information chatwoot",
              }
            ],
            "prepare": [
              {
                "name": "chatwoot_database",
                "description": "Create database chatwoot on Postgres",
                "command": "create_database_postgres chatwoot",
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

generate_stack_config_tooljet() {
  local stack_name="tooljet"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
          "name": "tooljet_url",
          "label": "Tooljet URL",
          "description": "URL to access Tooljet remotely",
          "required": "yes",
          "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "actions":{
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "tooljet_lockbox_secret_key",
                "description": "Generate tooljet lockbox secret key",
                "command": "random_string"
              },
              {
                "name": "tooljet_secret_key",
                "description": "Generate tooljet secret key", 
                "command": "random_string"
              },
              {
                "name": "postgrest_jwt_key",
                "description": "Generate PostgREST JWT key", 
                "command": "random_string"
              },
              {
                "description": "Custom smtp with identifier tooljet",
                "command": "custom_smtp_information tooljet",
              },
              {
                "name": "postgres_password",
                "description": "Fetch postgres password",
                "command": "fetch_database_password postgres"
              }
            ],
            "prepare": [
              {
                "name": "tooljet_database",
                "description": "Create database tooljet on Postgres",
                "command": "create_database_postgres tooljet"
              },
              {
                "name": "tooljet_database",
                "description": "Create database tooljet on Postgres",
                "command": "create_database_postgres tooljet_app"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

generate_stack_config_streaming() {
  local stack_name="streaming"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
        "name": "flink_url",
        "label": "Flink URL",
        "description": "URL to access Flink remotely",
        "required": "yes",
        "validate_fn": "validate_url_suffix"
      },
      {
        "name": "kafka_ui_url",
        "label": "Kafka UI URL",
        "description": "URL to access Kafka UI remotely",
        "required": "yes",
        "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "actions":{
            "prompt": $prompt_items
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

generate_stack_config_krayincrm() {
  local stack_name="krayincrm"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
        "name": "krayincrm_url",
        "label": "KrayinCRM URL",
        "description": "URL to access KrayinCRM remotely",
        "required": "yes",
        "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["mysql", "redis"],
          "actions":{
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "krayincrm_secret_key",
                "description": "Generate KrayinCRM secret key",
                "command": "random_string",
              },
              {
                "name": "mysql_password",
                "description": "Fetch mysql password",
                "command": "fetch_database_password mysql",
              },
              {
                "description": "Custom smtp with identifier krayincrm",
                "command": "custom_smtp_information krayincrm",
              }
            ],
            "prepare": [
              {
                "name": "create_krayincrm_database",
                "description": "Create database krayincrm on MySQL",
                "command": "create_database_mysql krayincrm",
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

generate_stack_config_affine() {
  local stack_name="affine"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
        "name": "affine_url",
        "label": "Affine URL",
        "description": "URL to access Affine remotely",
        "required": "yes",
        "validate_fn": "validate_url_suffix"
      },
      {
        "name": "affine_email",
        "label": "Affine UI email",
        "description": "E-mail to access Affine remotely",
        "required": "yes",
        "validate_fn": "validate_email_value"
      },
      {
        "name": "affine_password",
        "label": "Affine UI password",
        "description": "Password to access Affine remotely",
        "required": "yes",
        "validate_fn": "validate_password"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["postgres", "redis"],
          "actions":{
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "postgres_password",
                "description": "Fetch postgres password",
                "command": "fetch_database_password postgres",
              },
              {
                "description": "Custom smtp with identifier affine",
                "command": "custom_smtp_information affine",
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

generate_stack_config_minio() {
  local stack_name="minio"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
        "name": "minio_url",
        "label": "Minio URL",
        "description": "URL to access Minio remotely",
        "required": "yes",
        "validate_fn": "validate_url_suffix"
      },
      {
        "name": "minio_username",
        "label": "Minio username",
        "description": "E-mail to access Minio remotely",
        "required": "yes",
        "validate_fn": "validate_username"
      },
      {
        "name": "minio_password",
        "label": "Minio password",
        "description": "Password to access Minio remotely",
        "required": "yes",
        "validate_fn": "validate_password"
      },
      {
        "name": "s3_url",
        "label": "S3 URL",
        "description": "URL to access S3 remotely",
        "required": "yes",
        "validate_fn": "validate_url_suffix"
      },
      {
        "name": "s3_access_key_id",
        "label": "S3 access key",
        "description": "Access key to access S3 remotely",
        "required": "yes",
        "validate_fn": "validate_username"
      },
      {
        "name": "s3_access_key_secret",
        "label": "S3 secret key",
        "description": "Secret key to access S3 remotely",
        "required": "yes",
        "validate_fn": "validate_password"
      },
      {
        "name": "s3_region",
        "label": "S3 region",
        "description": "S3 region on AWS",
        "required": "yes",
        "validate_fn": "validate_password"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": [],
          "actions":{
            "prompt": $prompt_items
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

generate_stack_config_dify() {
  local stack_name="dify"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
        "name": "dify_url",
        "label": "Dify URL",
        "description": "URL to access Dify remotely",
        "required": "yes",
        "validate_fn": "validate_url_suffix"
      },
      {
        "name": "dify_api_url",
        "label": "Dify API URL",
        "description": "URL to access Dify API remotely",
        "required": "yes",
        "validate_fn": "validate_url_suffix"
      },
      {
        "name": "s3_url",
        "label": "S3 URL",
        "description": "URL to access S3 remotely",
        "required": "yes",
        "validate_fn": "validate_url_suffix"
      },
      {
        "name": "s3_access_key_id",
        "label": "S3 access key id",
        "description": "Access key id to access S3 remotely",
        "required": "yes",
        "validate_fn": "validate_username"
      },
      {
        "name": "s3_access_key_secret",
        "label": "S3 secret key",
        "description": "Secret key to access S3 remotely",
        "required": "yes",
        "validate_fn": "validate_password"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["redis", "postgres", "weavite"],
          "actions":{
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "postgres_password",
                "description": "Fetch postgres password",
                "command": "fetch_database_password postgres"
              },
              { 
                "name": "dify_sandbox_api_key",
                "description": "Sandbox API key",
                "command": "random_string"
              },
              {
                "name": "dify_secret_key",
                "description": "Secret key",
                "command": "random_string"
              },
              {
                "name": "weavite_token",
                "description": "Fetch weaviate token",
                "command": "fetch_stack_variable weavite weavite_token"
              },
              {
                "description": "Custom smtp with identifier dify",
                "command": "custom_smtp_information dify"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

generate_stack_config_unoapi() {
  local stack_name="unoapi"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
        "name": "unoapi_url",
        "label": "UnoAPI URL",
        "description": "URL to access UnoAPI remotely",
        "required": "yes",
        "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["rabbitmq", "redis", "minio"],
          "actions":{
            "prompt": $prompt_items,
            "refresh": [
              { 
                "name": "unoapi_token",
                "description": "Uno API token",
                "command": "random_string"
              },
              { 
                "name": "rabbitmq_username",
                "description": "RabbitMQ username",
                "command": "fetch_stack_variable rabbitmq rabbitmq_username"
              },
              { 
                "name": "rabbitmq_password",
                "description": "RabbitMQ password",
                "command": "fetch_stack_variable rabbitmq rabbitmq_password"
              },
              { 
                "name": "s3_url",
                "description": "S3 URL on AWS",
                "command": "fetch_stack_variable minio s3_url"
              },
              { 
                "name": "s3_access_key_id",
                "description": "S3 access key id on AWS",
                "command": "fetch_stack_variable minio s3_access_key_id"
              },
              { 
                "name": "s3_access_key_secret",
                "description": "S3 secret key on AWS",
                "command": "fetch_stack_variable minio s3_access_key_secret"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

generate_stack_config_documenso() {
  local stack_name="documenso"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
        "name": "documenso_url",
        "label": "Documenso URL",
        "description": "URL to access Documenso remotely",
        "required": "yes",
        "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["rabbitmq", "redis", "minio"],
          "actions":{
            "prompt": $prompt_items,
            "refresh": [
              { 
                "name": "rabbitmq_username",
                "description": "RabbitMQ username",
                "command": "fetch_stack_variable rabbitmq rabbitmq_username"
              },
              { 
                "name": "rabbitmq_password",
                "description": "RabbitMQ password",
                "command": "fetch_stack_variable rabbitmq rabbitmq_password"
              },
              { 
                "name": "s3_url",
                "description": "S3 URL on AWS",
                "command": "fetch_stack_variable minio s3_url"
              },
              { 
                "name": "s3_access_key_id",
                "description": "S3 access key id on AWS",
                "command": "fetch_stack_variable minio s3_access_key_id"
              },
              { 
                "name": "s3_access_key_secret",
                "description": "S3 secret key on AWS",
                "command": "fetch_stack_variable minio s3_access_key_secret"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

generate_stack_config_directus() {
  local stack_name="directus"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
        "name": "directus_url",
        "label": "Directus URL",
        "description": "URL to access Directus remotely",
        "required": "yes",
        "validate_fn": "validate_url_suffix"
      },
      {
        "name": "directus_email",
        "label": "Directus e-mail",
        "description": "E-mail to access Directus remotely",
        "required": "yes",
        "validate_fn": "validate_email_value"
      },
      {
        "name": "directus_password",
        "label": "Directus password",
        "description": "Password to access Directus remotely",
        "required": "yes",
        "validate_fn": "validate_password"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["minio", "postgres"],
          "actions":{
            "prompt": $prompt_items,
            "refresh": [
              { 
                "name": "s3_url",
                "description": "S3 URL on AWS",
                "command": "fetch_stack_variable minio s3_url"
              },
              { 
                "name": "s3_access_key_id",
                "description": "S3 access key id on AWS",
                "command": "fetch_stack_variable minio s3_access_key_id"
              },
              { 
                "name": "s3_access_key_secret",
                "description": "S3 secret key on AWS",
                "command": "fetch_stack_variable minio s3_access_key_secret"
              },
              {
                "description": "Custom smtp with identifier directus",
                "command": "custom_smtp_information dify"
              },
              {
                "name": "postgres_password",
                "description": "Fetch postgres password",
                "command": "fetch_database_password postgres"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

generate_stack_config_anythingllm() {
  local stack_name="anythingllm"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
        "name": "anythingllm_url",
        "label": "AnythingLLM URL",
        "description": "URL to access AnythingLLM remotely",
        "required": "yes",
        "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "dependencies": ["minio", "postgres"],
          "actions":{
            "prompt": $prompt_items,
            "refresh": [
              {
                "name": "qdrant_api_key",
                "description": "Generate qdrant api key",
                "command": "random_string"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

generate_stack_config_typebot() {
  local stack_name="typebot"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
        "name": "typebot_url",
        "label": "Typebot URL",
        "description": "URL to access Typebot remotely",
        "required": "yes",
        "validate_fn": "validate_url_suffix"
      },
      {
        "name": "typebot_viewer_url",
        "label": "Typebot viewer URL",
        "description": "URL to access Typebot viewer remotely",
        "required": "yes",
        "validate_fn": "validate_url_suffix"
      },
      {
        "name": "s3_url",
        "label": "S3 URL",
        "description": "URL to access S3 remotely",
        "required": "yes",
        "validate_fn": "validate_url_suffix"
      },
      {
        "name": "s3_access_key_id",
        "label": "S3 access key",
        "description": "Access key to access S3 remotely",
        "required": "yes",
        "validate_fn": "validate_username"
      },
      {
        "name": "s3_access_key_secret",
        "label": "S3 secret key",
        "description": "Secret key to access S3 remotely",
        "required": "yes",
        "validate_fn": "validate_password"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "variables": {
            
          },
          "actions":{
            "prompt": $prompt_items,
            "refresh": [
              {
                "description": "Custom smtp with identifier typebot",
                "command": "custom_smtp_information typebot"
              },
              {
                "name": "typebot_secret_key",
                "description": "Generate typebot secret key",
                "command": "random_string"
              },
              {
                "name": "typebot_image_version",
                "description": "Get latest stable version of typebot",
                "command": "get_latest_stable_version baptistearno/typebot-viewer"
              }
            ]
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

generate_stack_config_jupyter_spark() {
  local stack_name="jupyter_spark"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
        "name": "spark_url",
        "label": "PySpark URL",
        "description": "URL to access PySpark remotely",
        "required": "yes",
        "validate_fn": "validate_url_suffix"
      },
      {
        "name": "jupyter_url",
        "label": "JupyterLab viewer URL",
        "description": "URL to access JupyterLab remotely",
        "required": "yes",
        "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "variables": {
            
          },
          "actions":{
            "prompt": $prompt_items
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

generate_stack_config_elk() {
  local stack_name="elk"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
        "name": "kibana_url",
        "label": "Kibana URL",
        "description": "URL to access Kibana remotely",
        "required": "yes",
        "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "variables": {
            
          },
          "actions":{
            "prompt": $prompt_items
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

generate_stack_config_superset() {
  local stack_name="superset"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
        "name": "superset_url",
        "label": "Superset URL",
        "description": "URL to access Superset remotely",
        "required": "yes",
        "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "variables": {
            
          },
          "actions":{
            "prompt": $prompt_items
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

generate_stack_config_boltai() {
  local stack_name="boltai"

  # Prompting step (escaped properly for Bash)
  local prompt_items=$(jq -n '[
      {
        "name": "boltai_url",
        "label": "BoltAI URL",
        "description": "URL to access BoltAI remotely",
        "required": "yes",
        "validate_fn": "validate_url_suffix"
      }
  ]')

  # Correct command substitution without unnecessary piping
  config_instructions=$(
    jq -n \
      --arg stack_name "$stack_name" \
      --argjson prompt_items "$prompt_items" \
      '{
          "name": $stack_name,
          "target": "portainer",
          "variables": {
            
          },
          "actions":{
            "prompt": $prompt_items
          }
      }'
  ) || {
    error "Failed to generate JSON"
    return 1
  }

  # Pass variable correctly
  generate_stack_config_pipeline "$config_instructions"
}

#################################### END OF STACK CONFIGURATION ###################################

################################ BEGIN OF STACK DEPLOYMENT FUNCTIONS ##############################

deploy_stacks_startup() {
  deploy_stack 'traefik'

  if [[ $? -ne 0 ]]; then
    failure "Portainer deployment failed. Rolling back..."

    rollback_stack "traefik"
    return 1
  fi

  deploy_stack 'portainer'

  if [[ $? -ne 0 ]]; then
    failure "Portainer deployment failed. Rolling back..."

    rollback_stack "traefik"
    rollback_stack "portainer"
    return 1
  fi
}

################################# END OF STACK DEPLOYMENT FUNCTIONS ################################

##################################### BEGIN OF MENU DEFINITIONS ####################################

# Function to define menu stacks category
define_menu_stacks_category() {
  local category_stacks_jarray="$1"

  # Extract first element details only once
  stack_category=$(echo "$category_stacks_jarray" | jq -r '.[0].category_name')
  menu_key="main:stacks:$stack_category"
  menu_title=$(echo "$category_stacks_jarray" | jq -r '.[0].category_label')

  # Extract all stack details in a single pass
  local menu_items item_label

  while IFS=$'\t' read -r stack_name stack_label stack_description stack_status; do
    if [ "$stack_status" = "stable" ] || [ "$stack_status" = "beta" ]; then
      if [ "$stack_status" = "beta" ]; then
        item_label="$stack_label ($stack_status)"
      else
        item_label="$stack_label"
      fi

      menu_item="$(
        build_menu_item "$item_label" "$stack_description" "deploy_stack $stack_name"
      )"

      menu_items+=("$menu_item")
    fi
  done < <(echo "$category_stacks_jarray" |
    jq -r '.[] | "\(.stack_name)\t\(.stack_label)\t\(.stack_description)\t\(.stack_status)"')

  # Create menu object
  menu_object="$(
    build_menu "$menu_key" "$menu_title" $DEFAULT_PAGE_SIZE "${menu_items[@]}"
  )"

  define_menu "$menu_object"
}

# Function to define menu stacks
define_menu_stacks_categories() {
  local stacks_json="$1"

  # Extract unique category names (one per category)
  local unique_categories
  unique_categories=$(echo "$stacks_json" | jq -r 'map(.category_name) | unique | .[]')

  for category in $unique_categories; do
    # Build a filter to select only stacks for the current category
    local filter_fn
    filter_fn="map(select(.category_name == \"$category\"))"

    # Use filter_items to get the JSON array of stacks for this category
    local filtered_stacks
    filtered_stacks=$(filter_items "$stacks_json" "$filter_fn")

    # Define the menu for this category
    define_menu_stacks_category "$filtered_stacks"
  done
}

# Function to define menu stacks
define_menu_stacks() {
  local menu_key="main:stacks"
  local menu_title="Stacks"

  # Startup item (Exception to other stacks)
  local startup_item
  startup_item="$(
    build_menu_item "🌱 Startup" \
      "Deploy Traefik & Portainer" "deploy_stacks_startup"
  )"

  # Download stacks.json once
  local stacks_list

  stacks_list=$(curl -s "$TOOL_STACKS_OBJECT_URL")

  declare -A stacks_array
  convert_json_to_array "$stacks_list" stacks_array

  # Iterate over categories in the associative array
  for stack_index in "${!stacks_array[@]}"; do
    stack_json="${stacks_array[$stack_index]}"

    stack_name=$(jq -r '.stack_name' <<<"$stack_json")

    STACKS["$stack_name"]="$stack_json"
  done

  # Extract unique category objects in an array
  local menu_stack_categories=("$startup_item") # Start with startup item

  # Read categories into an array before iterating (avoiding subshell issues)
  local category_list
  category_list=$(echo "$stacks_list" | jq -c '
    group_by(.category_name) | 
    map({
      category_emoji: (.[0].category_emoji // ""),
      category_name: (.[0].category_name // ""),
      category_label: (.[0].category_label // ""),
      category_description: (.[0].category_description // "")
    })')

  # Declare local variables outside the loop
  local category_name category_label category_description category_key category_item

  # Iterate over JSON array
  declare -A categories_array

  # Convert JSON array into an associative array
  convert_json_to_array "$category_list" categories_array

  # Iterate over categories in the associative array
  for category_index in "${!categories_array[@]}"; do    
    category_json="${categories_array[$category_index]}"
    
    # Get the corresponding values
    category_name="$(\
      echo $category_json | jq -r '.category_name'
    )"
    category_label="$(\
      echo $category_json | jq -r '.category_label'
    )"
    category_description="$(\
      echo $category_json | jq -r '.category_description'
    )"
    category_emoji="$(\
      echo $category_json | jq -r '.category_emoji'
    )"

    # Construct the key for navigation
    category_key="main:stacks:$category_name"

    # Build the menu item for this category
    category_item="$(
      build_menu_item "$category_emoji $category_label" "$category_description" "navigate_menu $category_key"
    )"

    # Add the category item to the menu
    menu_stack_categories+=("$category_item")
  done

  # Build and define the main stacks menu
  local menu_object
  menu_object="$(
    build_menu "$menu_key" "$menu_title" $DEFAULT_PAGE_SIZE "${menu_stack_categories[@]}"
  )"

  define_menu "$menu_object"

  # Process stack categories in a single pass
  define_menu_stacks_categories "$stacks_list"
}

# main:utilities:smtp
define_menu_utilities_smtp() {
  menu_key="main:utilities:smtp"
  menu_title="SMTP utilities"

  item_1="$(
    build_menu_item "Test e-mail" \
      "Send" "send_smtp_test_email"
  )"
  item_2="$(
    build_menu_item "Send Machine Specifications" \
      "Send" "send_machine_specs_email"
  )"

  items=(
    "$item_1" "$item_2"
  )

  menu_object="$(
    build_menu "$menu_key" "$menu_title" $DEFAULT_PAGE_SIZE "${items[@]}"
  )"

  define_menu "$menu_object"
}

# main:utilities:docker
define_menu_utilities_docker() {
  menu_key="main:utilities:docker"
  menu_title="Docker utilities"

  item_1="$(
    build_menu_item "CTOP" "Run docker manager ctop on terminal" \
      "ctop"
  )"
  item_2="$(
    build_menu_item "Clean" "Remove unused images, volumes and containers" \
      "sanitize & wait_for_input 5"
  )"

  items=(
    "$item_1" "$item_2"
  )

  menu_object="$(
    build_menu "$menu_key" "$menu_title" $DEFAULT_PAGE_SIZE "${items[@]}"
  )"

  define_menu "$menu_object"
}

# main:utilities:network
define_menu_settings_network() {
  menu_key="main:settings:network"
  menu_title="Network"

  # Define menu items in an array
  menu_items=(
    "Interfaces:describe:show_interface_stats"
    "Security:diagnose:security_diagnostics"
    "Bandwidth:describe:bandwidth_usage"
  )

  items=()
  for item in "${menu_items[@]}"; do
    IFS=":" read -r title action cmd <<<"$item"
    command="run_command '$title' '$cmd'"
    items+=("$(build_menu_item "$title" "$action" "$command")")
  done

  # Build and define menu
  menu_object="$(
    build_menu "$menu_key" "$menu_title" $DEFAULT_PAGE_SIZE "${items[@]}"
  )"
  define_menu "$menu_object"
}

# Function to define the main settings menu
define_menu_settings_system_information() {
  menu_key="main:settings:system_info"
  menu_title="System information"

  # Define menu items in an array
  menu_items=(
    "Machine specifications:describe:generate_machine_specs"
    "Awake Usage:describe:uptime_usage"
    "Memory Usage:describe:memory_usage"
    "Disk Usage:describe:disk_usage"
    "Top Processes:list:top_processes"
    "Load Average:describe:load_average"
  )

  items=()
  for item in "${menu_items[@]}"; do
    IFS=":" read -r title action cmd <<<"$item"
    command="run_command '$title' '$cmd'"
    items+=("$(build_menu_item "$title" "$action" "$command")")
  done

  # Build and define menu
  menu_object="$(
    build_menu "$menu_key" "$menu_title" $DEFAULT_PAGE_SIZE "${items[@]}"
  )"
  define_menu "$menu_object"
}

# main:settings
define_menu_settings() {
  menu_key="main:settings"
  menu_title="Settings"

  item_1="$(
    build_menu_item "💻 System information" "" "navigate_menu 'main:settings:system_info'"
  )"
  item_2="$(
    build_menu_item "🌐 Network information" "" "navigate_menu 'main:settings:network'"
  )"
  item_3="$(
    build_menu_item "✉️ SMTP" "Overwrite SMTP information" "overwrite_or_request_smtp_information"
  )"
  item_4="$(
    build_menu_item "🔄 Update" "Packages" "update_and_check_packages"
  )"

  items=(
    "$item_1" "$item_2" "$item_3" "$item_4"
  )

  menu_object="$(
    build_menu "$menu_key" "$menu_title" $DEFAULT_PAGE_SIZE "${items[@]}"
  )"

  define_menu "$menu_object"

  # Define sub-menus
  define_menu_settings_system_information
  define_menu_settings_network
}

# main:utilities
define_menu_utilities() {
  menu_key="main:utilities"
  menu_title="Utilities"

  item_1="$(
    build_menu_item "✉️ SMTP" "Test and tools" "navigate_menu 'main:utilities:smtp'"
  )"
  item_2="$(
    build_menu_item "📦 Docker" "Tools" "navigate_menu 'main:utilities:docker'"
  )"

  items=(
    "$item_1" "$item_2"
  )

  menu_object="$(
    build_menu "$menu_key" "$menu_title" $DEFAULT_PAGE_SIZE "${items[@]}"
  )"

  define_menu "$menu_object"

  # Define sub-menus
  define_menu_utilities_docker
  define_menu_utilities_smtp
}

# main
define_menu_main() {
  highlight "Building main menu..."

  menu_key="main"
  menu_title="Main"

  item_1="$(build_menu_item "📚 Stacks" "" "navigate_menu 'main:stacks'")"
  item_2="$(build_menu_item "🔧 Utilities" "" "navigate_menu 'main:utilities'")"
  item_3="$(build_menu_item "⚙️ Settings" "" "navigate_menu 'main:settings'")"

  items=(
    "$item_1" "$item_2" "$item_3"
  )

  menu_object="$(
    build_menu "$menu_key" "$menu_title" $DEFAULT_PAGE_SIZE "${items[@]}"
  )"

  define_menu "$menu_object"

  # Define sub-menus
  info "Defining menu Stacks..."
  define_menu_stacks

  info "Defining menu Utilities..."
  define_menu_utilities

  info "Defining menu Settings..."
  define_menu_settings

  wait_for_input
}

start_main_menu() {
  navigate_menu "main"

  cleanup
  clean_screen

  farewell_message
  wait_for_input 5

  clean_screen
}

###################################### END OF MENU DEFINITIONS ####################################

# Display help message
usage() {
  joined_arrows="$(join_array ", " "${!ARROWS[@]}")"

  usage_messages=(
    "Usage: $0 [options]"
    "Options:"
    "  -c, --clean             Clean docker environment."
    "  -a, --arrow             Arrow style: {$joined_arrows}."
    "  -h, --help              Display this help message and exit."
  )

  display_parallel usage_messages

  exit 1
}

startup() {
  # Install required packages
  prepare_environment
  clear

  # Perform initialization
  initialize_server
  clear
}

# Parse command-line arguments
parse_args() {
  # Get options using getopt
  OPTIONS=$(getopt -o a:,c,h --long arrow:,clean,help -- "$@")

  # Check if getopt failed (invalid option)
  if [ $? -ne 0 ]; then
    echo "Invalid option(s) provided."
    usage
    exit 1
  fi

  # Apply the options to positional parameters
  eval set -- "$OPTIONS"

  # Loop through the options
  while true; do
    case "$1" in
    -c | --clean)
      CLEAN=true
      shift
      ;;
    -a | --arrow)
      USER_DEFINED_ARROW="$2"
      shift 2
      ;;
    -h | --help)
      usage
      break
      ;;
    --)
      shift
      break
      ;;
    *)
      # This will be triggered for any unrecognized option
      info "Unknown option: $1" >&2
      usage
      return 1
      ;;
    esac
  done
}

# Main script execution
main() {
  parse_args "$@"

  if [[ $CLEAN == true ]]; then
    clean_docker_environment
    exit 0
  fi

  set_arrow
  clear

  # Check if the script is running as root
  if [ "$EUID" -ne 0 ]; then
    failure "Please run this script as root or use sudo."
    exit 1
  fi

  # Perform startup tasks
  startup

  # Define menus on registry
  define_menu_main

  start_main_menu
}

# # Call the main function
main "$@"