AI-Studio/app/MindWork AI Studio/Assistants/BeyondFactsLab/BflStepExtensions.cs

namespace AIStudio.Assistants.BeyondFactsLab;

public static class BflStepExtensions
{
    private static string TB(string fallbackEN) => Tools.PluginSystem.I18N.I.T(fallbackEN, typeof(BflStepExtensions).Namespace, nameof(BflStepExtensions));

    /// <param name="step">The step.</param>
    extension(BflStep step)
    {
        /// <summary>
        /// Gets the title of the step. It names the topic, never a number.
        /// </summary>
        public string Title => step switch
        {
            BflStep.FRAMEWORK => TB("Event details"),
            BflStep.KNOWLEDGE => TB("Knowledge and uncertainty"),
            BflStep.GOALS_AND_ROLE => TB("Goals and role"),
            BflStep.VALUES_AND_PERSPECTIVES => TB("Values and perspectives"),
            BflStep.STRATEGY => TB("Strategy"),
            BflStep.TEST_SITUATION => TB("Test situation"),
            BflStep.RESULTS => TB("Results and materials"),

            _ => string.Empty,
        };

        /// <summary>
        /// Gets one sentence about what the step is for.
        /// </summary>
        public string Description => step switch
        {
            BflStep.FRAMEWORK => TB("What the event is about, for whom, and what you were asked to contribute."),
            BflStep.KNOWLEDGE => TB("What you know for sure, what is uncertain, and where your expertise ends."),
            BflStep.GOALS_AND_ROLE => TB("What you want to achieve, and in which role you speak."),
            BflStep.VALUES_AND_PERSPECTIVES => TB("What matters to you, what touches you, and what moves others."),
            BflStep.STRATEGY => TB("How you convey evidence, trade-offs between values, and open questions."),
            BflStep.TEST_SITUATION => TB("Play through critical questions and opposing positions."),
            BflStep.RESULTS => TB("What you take away from your preparation."),

            _ => string.Empty,
        };

        /// <summary>
        /// Gets a hint for the form of the step, or an empty string when the step needs none.
        /// </summary>
        public string FormHint => step switch
        {
            BflStep.VALUES_AND_PERSPECTIVES => TB("You can fill in single fields or start right away in the chat."),

            _ => string.Empty,
        };

        /// <summary>
        /// Gets the name of the folder in which a preparation keeps the files of the step.
        /// </summary>
        /// <remarks>
        /// The number keeps the folders in the order of the steps for people who look into the data folder.
        /// These names are stored on disk, so they never change.
        /// </remarks>
        public string FolderName => step switch
        {
            BflStep.FRAMEWORK => "01-framework",
            BflStep.KNOWLEDGE => "02-knowledge",
            BflStep.GOALS_AND_ROLE => "03-goals",
            BflStep.VALUES_AND_PERSPECTIVES => "04-values",
            BflStep.STRATEGY => "05-strategy",
            BflStep.TEST_SITUATION => "06-test",
            BflStep.RESULTS => "07-results",

            _ => throw new ArgumentOutOfRangeException(nameof(step), step, "The step has no folder."),
        };

        /// <summary>
        /// Gets every step, in the order the lab suggests.
        /// </summary>
        public static IReadOnlyList<BflStep> All => Enum.GetValues<BflStep>();
    }
}