@cognigy/rest-api-client/build/shared/charts/descriptors/analytics/requestRating.js

Cognigy REST-Client

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.REQUEST_RATING = void 0;
/* Custom modules */
const createNodeDescriptor_1 = require("../../createNodeDescriptor");
/**
 * Node name: 'requestRating'
 *
 * Purpose:
 * Send a rating request message to a webchat endpoint
 */
exports.REQUEST_RATING = (0, createNodeDescriptor_1.createNodeDescriptor)({
    type: "requestRating",
    defaultLabel: "Request Rating",
    summary: "UI__NODE_EDITOR__REQUEST_RATING__SUMMARY",
    appearance: {
        showIcon: false,
    },
    preview: {
        key: "ratingTitleText",
        type: "text",
    },
    fields: [
        {
            key: "ratingScreenTitleText",
            type: "cognigyText",
            label: "UI__NODE_EDITOR__REQUEST_RATING__RATING_SCREEN_TITLE_TEXT__LABEL",
            description: "UI__NODE_EDITOR__REQUEST_RATING__RATING_SCREEN_TITLE_TEXT__DESCRIPTION",
            params: {
                placeholder: "UI__NODE_EDITOR__REQUEST_RATING__RATING_SCREEN_TITLE_TEXT__PLACEHOLDER",
            },
        },
        {
            key: "ratingTitleText",
            type: "cognigyText",
            label: "UI__NODE_EDITOR__REQUEST_RATING__RATING_TITLE_TEXT__LABEL",
            description: "UI__NODE_EDITOR__REQUEST_RATING__RATING_TITLE_TEXT__DESCRIPTION",
            params: {
                placeholder: "UI__NODE_EDITOR__REQUEST_RATING__RATING_TITLE_TEXT__PLACEHOLDER",
            },
        },
        {
            key: "ratingCommentText",
            type: "cognigyText",
            label: "UI__NODE_EDITOR__REQUEST_RATING__RATING_COMMENT_TEXT__LABEL",
            description: "UI__NODE_EDITOR__REQUEST_RATING__RATING_COMMENT_TEXT__DESCRIPTION",
            params: {
                placeholder: "UI__NODE_EDITOR__REQUEST_RATING__RATING_COMMENT_TEXT__PLACEHOLDER",
            },
        },
        {
            key: "ratingSubmitButtonText",
            type: "cognigyText",
            label: "UI__NODE_EDITOR__REQUEST_RATING__RATING_SUBMIT_BUTTON_TEXT__LABEL",
            description: "UI__NODE_EDITOR__REQUEST_RATING__RATING_SUBMIT_BUTTON_TEXT__DESCRIPTION",
            params: {
                placeholder: "UI__NODE_EDITOR__REQUEST_RATING__RATING_SUBMIT_BUTTON_TEXT__PLACEHOLDER",
            },
        },
        {
            key: "ratingEventBannerText",
            type: "cognigyText",
            label: "UI__NODE_EDITOR__REQUEST_RATING__RATING_EVENT_BANNER_TEXT__LABEL",
            description: "UI__NODE_EDITOR__REQUEST_RATING__RATING_EVENT_BANNER_TEXT__DESCRIPTION",
            params: {
                placeholder: "UI__NODE_EDITOR__REQUEST_RATING__RATING_EVENT_BANNER_TEXT__PLACEHOLDER",
            },
        },
        {
            key: "ratingChatStatusMessage",
            type: "cognigyText",
            label: "UI__NODE_EDITOR__REQUEST_RATING__RATING_STATUS_MESSAGE__LABEL",
            description: "UI__NODE_EDITOR__REQUEST_RATING__RATING_STATUS_MESSAGE__DESCRIPTION",
            params: {
                placeholder: "UI__NODE_EDITOR__REQUEST_RATING__RATING_STATUS_MESSAGE__PLACEHOLDER",
            },
        },
    ],
    form: [
        { type: "field", key: "ratingScreenTitleText" },
        { type: "field", key: "ratingTitleText" },
        { type: "field", key: "ratingCommentText" },
        { type: "field", key: "ratingSubmitButtonText" },
        { type: "field", key: "ratingEventBannerText" },
        { type: "field", key: "ratingChatStatusMessage" },
    ],
    tags: ["analytics", "rating"],
    function: async ({ cognigy, config }) => {
        const { api } = cognigy;
        const ratingScreenTitleText = config.ratingScreenTitleText;
        const ratingTitleText = config.ratingTitleText;
        const ratingCommentText = config.ratingCommentText;
        const ratingSubmitButtonText = config.ratingSubmitButtonText;
        const ratingEventBannerText = config.ratingEventBannerText;
        const ratingChatStatusMessage = config.ratingChatStatusMessage;
        await api.say("", {
            _plugin: {
                type: "request-rating",
                data: {
                    ratingScreenTitleText,
                    ratingTitleText,
                    ratingCommentText,
                    ratingSubmitButtonText,
                    ratingEventBannerText,
                    ratingChatStatusMessage,
                },
            },
        });
    },
});
//# sourceMappingURL=requestRating.js.map