Skip to content

Beautiful Open-Source Form Builder

10.3 KB
Raw Blame
<?php

namespace App\Service\AI\Prompts\Form;

use App\Service\AI\Prompts\Prompt;
use App\Service\Forms\AgentFormAuthoringGuide;

class GenerateFormPrompt extends Prompt
{
    protected ?float $temperature = null;

    protected ?int $maxTokens = null;

    protected string $model = 'gpt-5.4-mini';

    /**
     * The prompt template for generating forms
     */
    public const PROMPT_TEMPLATE = <<<'EOD'
        Help me build the json structure for the form described below, be as accurate as possible.

        <form_description>
            {formPrompt}
        </form_description>
        
        Forms are represented as Json objects. There are several input types and layout block types (type start with nf-).
        You can use for instance nf-text to add a title or text to the form using some basic html (h1, p, b, i, u etc).
        Order of blocks matters.

        Presentation mode and constraints:
        {modeConstraints}

        Available field types (mode-aware):
        {allowedFieldTypesList}
        
        HTML formatting for nf-text:
        - Headers: <h1>, <h2> for section titles and subtitles
        - Text formatting: <b> or <strong> for bold, <i> or <em> for italic, <u> for underline, <s> for strikethrough
        - Links: <a href="url">link text</a> for hyperlinks
        - Lists: <ul><li>item</li></ul> for bullet lists, <ol><li>item</li></ol> for numbered lists
        - Colors: <span style="color: #hexcode">colored text</span> for colored text
        - Paragraphs: <p>paragraph text</p> for text blocks with spacing
        Use these HTML tags to create well-structured and visually appealing form content.
        
        {widthGuidance}
        
        If the form is too long, you can paginate it by adding one or multiple page breaks (nf-page-break).
        
        Create a complete form with a clear internal title and follow this shared quality baseline:
        {authoringGuidelines}
    EOD;

    /**
     * JSON schema for form output
     */
    protected ?array $jsonSchema = [
        'type' => 'object',
        'required' => ['title', 'properties', 're_fillable', 'use_captcha', 'redirect_url', 'submitted_text', 'uppercase_labels', 'submit_button_text', 're_fill_button_text', 'color'],
        'additionalProperties' => false,
        'properties' => [
            'title' => [
                'type' => 'string',
                'description' => 'The title of the form (default: "New Form")'
            ],
            're_fillable' => [
                'type' => 'boolean',
                'description' => 'Whether the form can be refilled after submission (default: false)'
            ],
            'use_captcha' => [
                'type' => 'boolean',
                'description' => 'Whether to use CAPTCHA for spam protection (default: false)'
            ],
            'redirect_url' => [
                'type' => ['string', 'null'],
                'description' => 'URL to redirect to after submission (default: null)'
            ],
            'submitted_text' => [
                'type' => 'string',
                'description' => 'Specific text that confirms what happened after submission and, when known, what comes next.'
            ],
            'uppercase_labels' => [
                'type' => 'boolean',
                'description' => 'Whether to display field labels in uppercase (default: false)'
            ],
            'submit_button_text' => [
                'type' => 'string',
                'description' => 'Contextual action label such as "Send message", "Request a quote", or "Join the waitlist".'
            ],
            're_fill_button_text' => [
                'type' => 'string',
                'description' => 'Text for the refill button (default: "Fill Again")'
            ],
            'color' => [
                'type' => 'string',
                'description' => 'Primary color for the form (default: "#64748b")'
            ],
            'properties' => [
                'type' => 'array',
                'description' => 'Array of form fields and elements',
                'items' => [
                    'anyOf' => [
                        ['$ref' => '#/definitions/textProperty'],
                        ['$ref' => '#/definitions/richTextProperty'],
                        ['$ref' => '#/definitions/dateProperty'],
                        ['$ref' => '#/definitions/urlProperty'],
                        ['$ref' => '#/definitions/phoneNumberProperty'],
                        ['$ref' => '#/definitions/emailProperty'],
                        ['$ref' => '#/definitions/checkboxProperty'],
                        ['$ref' => '#/definitions/selectProperty'],
                        ['$ref' => '#/definitions/multiSelectProperty'],
                        ['$ref' => '#/definitions/matrixProperty'],
                        ['$ref' => '#/definitions/numberProperty'],
                        ['$ref' => '#/definitions/ratingProperty'],
                        ['$ref' => '#/definitions/scaleProperty'],
                        ['$ref' => '#/definitions/sliderProperty'],
                        ['$ref' => '#/definitions/filesProperty'],
                        ['$ref' => '#/definitions/signatureProperty'],
                        ['$ref' => '#/definitions/barcodeProperty'],
                        ['$ref' => '#/definitions/nfTextProperty'],
                        ['$ref' => '#/definitions/nfPageBreakProperty'],
                        ['$ref' => '#/definitions/nfDividerProperty'],
                        ['$ref' => '#/definitions/nfImageProperty'],
                        ['$ref' => '#/definitions/nfVideoProperty'],
                        ['$ref' => '#/definitions/nfAudioProperty'],
                        ['$ref' => '#/definitions/nfCodeProperty']
                    ]
                ]
            ]
        ],
        'definitions' => FormFieldSchemas::FIELD_TYPE_DEFINITIONS
    ];

    public function __construct(
        public string $formPrompt,
        public array $params = []
    ) {
        parent::__construct();
    }

    protected function getSystemMessage(): ?string
    {
        return 'You are an AI assistant specialized in creating form structures. Design intuitive, user-friendly forms that capture all necessary information based on the provided description.';
    }

    protected function getPromptTemplate(): string
    {
        return self::PROMPT_TEMPLATE;
    }

    /**
     * Override the execute method to automatically process the output
     */
    public function execute(): array
    {
        $formData = parent::execute();
        return $this->processOutput($formData);
    }

    /**
     * Process the AI output to ensure it meets our requirements
     */
    public function processOutput(array $formData): array
    {
        if (isset($formData['properties']) && is_array($formData['properties'])) {
            $formData['properties'] = FormFieldSchemas::processFields($formData['properties']);
        }

        // Clean title data
        if (isset($formData['title'])) {
            // Remove quotes if the title is enclosed in them
            $formData['title'] = preg_replace('/^["\'](.*)["\']$/', '$1', $formData['title']);
        }

        // Optimize fields for focused mode
        $mode = $this->params['presentation_style'] ?? PresentationRules::MODE_CLASSIC;
        $formData = FocusedFormOptimizer::optimizeFormProperties($formData, $mode);

        return $formData;
    }

    protected function getPromptVariables(): array
    {
        $vars = parent::getPromptVariables();
        $rules = PresentationRules::buildContext($this->params);

        $modeConstraints = $rules['constraintsText'];

        $widthGuidance = $rules['mode'] === PresentationRules::MODE_FOCUSED
            ? 'In focused mode, do not use width options. Each step contains a single full-width question.'
            : 'Field width options:\n- width: "full" (default, takes entire width)\n- width: "1/2" (takes half width)\n- width: "1/3" (takes a third of the width)\n- width: "2/3" (takes two thirds of the width)\n- width: "1/4" (takes a quarter of the width)\n- width: "3/4" (takes three quarters of the width)\nFields with width less than "full" may share a row when room allows.';

        $vars['{modeConstraints}'] = $modeConstraints;
        $vars['{widthGuidance}'] = $widthGuidance;
        $vars['{allowedFieldTypesList}'] = $this->formatAllowedTypes($rules['allowedFieldTypes']);
        $vars['{authoringGuidelines}'] = AgentFormAuthoringGuide::completeFormPrompt();
        return $vars;
    }

    private function formatAllowedTypes(array $types): string
    {
        $map = [
            'text' => 'text: Text input (use multi_lines: true for multi-line text)',
            'rich_text' => 'rich_text: Rich text input',
            'date' => 'date: Date picker (use with_time: true to include time selection)',
            'url' => 'url: URL input with validation',
            'phone_number' => 'phone_number: Phone number input',
            'email' => 'email: Email input with validation',
            'checkbox' => 'checkbox: Single checkbox for yes/no (use use_toggle_switch: true for toggle switch)',
            'select' => 'select: Dropdown selection (use without_dropdown: true for radio buttons, recommended for <5 options)',
            'multi_select' => 'multi_select: Multiple selection (use without_dropdown: true for checkboxes, recommended for <5 options)',
            'matrix' => 'matrix: Matrix input with rows and columns',
            'number' => 'number: Numeric input',
            'rating' => 'rating: Star rating',
            'scale' => 'scale: Numeric scale',
            'slider' => 'slider: Slider selection',
            'files' => 'files: File upload',
            'signature' => 'signature: Signature pad',
            'barcode' => 'barcode: Barcode scanner',
            'nf-text' => 'nf-text: Rich text content (not an input field)',
            'nf-page-break' => 'nf-page-break: Page break for multi-page forms',
            'nf-divider' => 'nf-divider: Visual divider (not an input field)',
            'nf-image' => 'nf-image: Image element',
            'nf-video' => 'nf-video: Video element',
            'nf-audio' => 'nf-audio: Audio element',
            'nf-code' => 'nf-code: Code block',
        ];

        $lines = array_map(function ($t) use ($map) {
            return '- ' . ($map[$t] ?? $t);
        }, $types);

        return implode("\n", $lines);
    }
}