zulip/static/js/zform.js

import render_widgets_zform_choices from "../templates/widgets/zform_choices.hbs";

import * as schema from "./schema";
import * as transmit from "./transmit";

export function validate_extra_data(data) {
    function check(data) {
        function check_choice_data(data) {
            function check_choice_item(field_name, val) {
                return schema.check_record(field_name, val, {
                    short_name: schema.check_string,
                    long_name: schema.check_string,
                    reply: schema.check_string,
                });
            }

            function check_choices(field_name, val) {
                return schema.check_array(field_name, val, check_choice_item);
            }

            return schema.check_record("zform data", data, {
                heading: schema.check_string,
                choices: check_choices,
            });
        }

        if (data.type === "choices") {
            return check_choice_data(data);
        }

        return "unknown zform type: " + data.type;
    }

    const msg = check(data);

    if (msg) {
        blueslip.warn(msg);
        return false;
    }

    return true;
}

export function activate(opts) {
    const self = {};

    const outer_elem = opts.elem;
    const data = opts.extra_data;

    if (!validate_extra_data(data)) {
        // callee will log reason we fail
        return undefined;
    }

    function make_choices(data) {
        // Assign idx values to each of our choices so that
        // our template can create data-idx values for our
        // JS code to use later.
        for (const [idx, choice] of data.choices.entries()) {
            choice.idx = idx;
        }

        const html = render_widgets_zform_choices(data);
        const elem = $(html);

        elem.find("button").on("click", (e) => {
            e.stopPropagation();

            // Grab our index from the markup.
            const idx = $(e.target).attr("data-idx");

            // Use the index from the markup to dereference our
            // data structure.
            const reply_content = data.choices[idx].reply;

            transmit.reply_message({
                message: opts.message,
                content: reply_content,
            });
        });

        return elem;
    }

    function render() {
        let rendered_widget;

        if (data.type === "choices") {
            rendered_widget = make_choices(data);
            outer_elem.html(rendered_widget);
        }
    }

    self.handle_events = function (events) {
        if (events) {
            blueslip.info("unexpected");
        }
        render();
    };

    render();

    return self;
}