@cognigy/rest-api-client 0.11.0 → 0.13.0

package/build/shared/charts/descriptors/apps/initAppSession.js

@@ -0,0 +1,488 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.INIT_APP_SESSION = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+/**
+ * Node name: 'initAppSession'
+ *
+ * Purpose:
+ * Initializes a new Cognigy App Session.
+ */
+exports.INIT_APP_SESSION = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "initAppSession",
+    defaultLabel: "Init App Session",
+    summary: "Initializes a new App Session.",
+    appearance: {
+        showIcon: false,
+    },
+    fields: [
+        // Style Customization
+        {
+            type: "cognigyText",
+            key: "backgroundColor",
+            label: "Background Color",
+            description: "This color will be displayed in the background of all Shell Page Screens. Supports CSS background-color values (e.g. hex, hsl+a, rgb+a)",
+        },
+        {
+            type: "cognigyText",
+            key: "textColor",
+            label: "Text Color",
+            description: "This color will be used for textual content on all Shell Page Screens. Supports CSS color values (e.g. hex, hsl+a, rgb+a). Make sure to have a high contrast to the background color!",
+        },
+        {
+            type: "select",
+            key: "logo",
+            label: "Logo",
+            description: "Decides whether the default logo, no logo or a custom logo should be used on the Shell Page Screens.",
+            params: {
+                options: [
+                    {
+                        label: "Show Default Logo",
+                        value: "default",
+                    },
+                    {
+                        label: "Don't show a Logo",
+                        value: "none",
+                    },
+                    {
+                        label: "Show custom Logo",
+                        value: "custom",
+                    },
+                ],
+            },
+            defaultValue: "default",
+        },
+        {
+            type: "cognigyText",
+            key: "logoUrl",
+            label: "Custom Logo URL",
+            description: "A valid image URL for the custom logo. Make sure to choose a logo that is distinguishable from the background color, especially when using transparency in the logo!",
+            condition: {
+                key: "logo",
+                value: "custom",
+            },
+        },
+        // PIN Screen
+        {
+            type: "cognigyText",
+            key: "pinEnterPinText",
+            label: "'Enter PIN' Text",
+            description: "This text asks the user to enter the App Session PIN.",
+        },
+        {
+            type: "cognigyText",
+            key: "pinIncorrectText",
+            label: "'Pin Incorrect' Text",
+            description: "This text tells the user that the entered PIN was incorrect.",
+        },
+        {
+            type: "cognigyText",
+            key: "pinUnavailableText",
+            label: "'Unavailable' Text",
+            description: "This text tells the user that the application is not available right now.",
+        },
+        // App Pages
+        {
+            type: "description",
+            key: "appSectionDescription",
+            label: " ",
+            params: {
+                text: "This section is used to customize content related to the 'App Screen' sections (Active App + App Overrides).",
+            },
+        },
+        {
+            type: "cognigyText",
+            key: "appLoadingText",
+            label: "'Loading' Text",
+            description: "This text is shown on the 'Loading Screen' when an App Page is launched.",
+        },
+        {
+            type: "cognigyText",
+            key: "appLaunchErrorText",
+            label: "'Launch Error' Text",
+            description: "This text is shown when an App Page fails to load for any reason.",
+        },
+        // Intermediate Screen
+        {
+            type: "description",
+            key: "intermediateScreenDescription",
+            label: " ",
+            params: {
+                text: "This section is used to customize the 'intermediate screen', which is shown on the apps website while no app is active.",
+            },
+        },
+        {
+            type: "select",
+            key: "intermediateScreenCustomizationType",
+            label: "Customization Type",
+            params: {
+                options: [
+                    {
+                        label: "No customization",
+                        value: "none",
+                    },
+                    {
+                        label: "Customized Texts",
+                        value: "override",
+                    },
+                    {
+                        label: "Replace with App",
+                        value: "app",
+                    },
+                ],
+            },
+            defaultValue: "none",
+        },
+        // Intermediate Screen - Override
+        {
+            type: "cognigyText",
+            key: "intermediateScreenOverrideText",
+            label: "Text Override",
+            description: "Customizes the text that is shown on the 'intermediate' screen",
+            defaultValue: "Nothing to do...",
+            condition: {
+                key: "intermediateScreenCustomizationType",
+                value: "override",
+            },
+        },
+        // Intermediate Screen - Custom App
+        {
+            type: "cognigyText",
+            key: "intermediateScreenAppTemplateId",
+            label: "App Template",
+            description: "Select which App Template should be used to replace the intermediate screen",
+            defaultValue: "",
+            condition: {
+                key: "intermediateScreenCustomizationType",
+                value: "app",
+            },
+            params: {
+                required: true,
+            },
+        },
+        {
+            type: "json",
+            key: "intermediateScreenAppTemplateData",
+            label: "App Template Data",
+            description: "Select which data should be provided to the App Template which replaces the intermediate screen",
+            defaultValue: "{}",
+            condition: {
+                key: "intermediateScreenCustomizationType",
+                value: "app",
+            },
+        },
+        // Connection Screen
+        {
+            type: "description",
+            key: "connectionScreenDescription",
+            label: " ",
+            params: {
+                text: "This section is used to customize the 'connection screen', which is shown on the apps website while the realtime connection to the backend is (re)-established.",
+            },
+        },
+        {
+            type: "select",
+            key: "connectionScreenCustomizationType",
+            label: "Customization Type",
+            params: {
+                options: [
+                    {
+                        label: "No customization",
+                        value: "none",
+                    },
+                    {
+                        label: "Customized Texts",
+                        value: "override",
+                    },
+                    {
+                        label: "Replace with App",
+                        value: "app",
+                    },
+                ],
+            },
+            defaultValue: "none",
+        },
+        // Connection Screen - Override
+        {
+            type: "cognigyText",
+            key: "connectionScreenOverrideConnectingText",
+            label: "Connecting Text Override",
+            description: "This text is shown while a connection to the backend is being established.",
+            defaultValue: "Connecting...",
+            condition: {
+                key: "connectionScreenCustomizationType",
+                value: "override",
+            },
+        },
+        {
+            type: "cognigyText",
+            key: "connectionScreenOverrideInvalidText",
+            label: "'Invalid' Error Message",
+            description: "This Error message is shown if the token is invalid (e.g. the link was opened after the session expired).",
+            defaultValue: "This session does not exist or is no longer active.",
+            condition: {
+                key: "connectionScreenCustomizationType",
+                value: "override",
+            },
+        },
+        {
+            type: "cognigyText",
+            key: "connectionScreenOverrideUnavailableText",
+            label: "'Unavailable' Error Message",
+            description: "This Error message is shown when the backend turns out to be unreachable.",
+            defaultValue: "The application is not available right now.",
+            condition: {
+                key: "connectionScreenCustomizationType",
+                value: "override",
+            },
+        },
+        // Connection Screen - Custom App
+        {
+            type: "cognigyText",
+            key: "connectionScreenAppTemplateId",
+            label: "App Template",
+            description: "Select which App Template should be used to replace the connection screen",
+            defaultValue: "",
+            condition: {
+                key: "connectionScreenCustomizationType",
+                value: "app",
+            },
+            params: {
+                required: true,
+            },
+        },
+        {
+            type: "json",
+            key: "connectionScreenAppTemplateData",
+            label: "App Template Data",
+            description: "Select which data should be provided to the App Template which replaces the connection screen",
+            defaultValue: "{}",
+            condition: {
+                key: "connectionScreenCustomizationType",
+                value: "app",
+            },
+        },
+        // OTHER
+        {
+            type: "cognigyText",
+            label: "App Shell Page Base URL",
+            description: "This field exists during development until this value is automatically assigned",
+            defaultValue: "http://static.test/",
+            key: "shellPageBaseURL",
+        },
+    ],
+    sections: [
+        {
+            label: "Style Customization",
+            key: "styleSection",
+            fields: [
+                "backgroundColor",
+                "textColor",
+                "errorTextColor",
+                "logo",
+                "logoUrl",
+            ],
+            defaultCollapsed: false,
+        },
+        {
+            label: "PIN Screen",
+            key: "pinScreenSection",
+            fields: ["pinEnterPinText", "pinIncorrectText", "pinUnavailableText"],
+            defaultCollapsed: false,
+        },
+        {
+            label: "App Screens",
+            key: "appScreensSection",
+            fields: ["appLoadingText", "appLaunchErrorText"],
+            defaultCollapsed: false,
+        },
+        {
+            label: "Intermediate Screen",
+            key: "intermediateScreenSection",
+            fields: [
+                "intermediateScreenDescription",
+                "intermediateScreenCustomizationType",
+                "intermediateScreenOverrideText",
+                "intermediateScreenAppTemplateId",
+                "intermediateScreenAppTemplateData",
+            ],
+            defaultCollapsed: false,
+        },
+        {
+            label: "Connection Screen",
+            key: "connectionScreenSection",
+            fields: [
+                "connectionScreenDescription",
+                "connectionScreenCustomizationType",
+                "connectionScreenOverrideConnectingText",
+                "connectionScreenOverrideInvalidText",
+                "connectionScreenOverrideUnavailableText",
+                "connectionScreenAppTemplateId",
+                "connectionScreenAppTemplateData",
+            ],
+            defaultCollapsed: false,
+        },
+    ],
+    form: [
+        {
+            type: "section",
+            key: "styleSection",
+        },
+        {
+            type: "section",
+            key: "pinScreenSection",
+        },
+        {
+            type: "section",
+            key: "appScreensSection",
+        },
+        {
+            type: "section",
+            key: "intermediateScreenSection",
+        },
+        {
+            type: "section",
+            key: "connectionScreenSection",
+        },
+        {
+            type: "field",
+            key: "shellPageBaseURL",
+        },
+    ],
+    tags: ["basic", "apps"],
+    tokens: [
+        {
+            type: "input",
+            label: "App Session Token",
+            script: "input.appSessionToken || ''",
+        },
+        {
+            type: "input",
+            label: "App Session URL",
+            script: `
+(() => {
+	if (!input.shellPageBaseURL) return '';
+	if (!input.appSessionToken) return '';
+	const overrides = input.shellPageOverrides ? \`&overrides=\${encodeURIComponent(JSON.stringify(input.shellPageOverrides))}\` : '';
+	return [input.shellPageBaseURL, '?token=', input.appSessionToken, overrides].join('');
+})()`
+                .split("\n")
+                .join(" "),
+        },
+    ],
+    function: async ({ cognigy, config }) => {
+        const { api, input } = cognigy;
+        const { 
+        // general
+        shellPageBaseURL, 
+        // styling
+        backgroundColor, textColor, errorTextColor, logo, logoUrl, 
+        // pin screen
+        pinEnterPinText, pinIncorrectText, pinUnavailableText, 
+        // apps screen
+        appLoadingText, appLaunchErrorText, 
+        // intermediate screen
+        intermediateScreenCustomizationType, intermediateScreenOverrideText, intermediateScreenAppTemplateId, intermediateScreenAppTemplateData, 
+        // status screen
+        connectionScreenCustomizationType, connectionScreenOverrideConnectingText, connectionScreenOverrideInvalidText, connectionScreenOverrideUnavailableText, connectionScreenAppTemplateId, connectionScreenAppTemplateData, } = config;
+        const style = (() => {
+            const ret = {};
+            if (backgroundColor !== "" && backgroundColor !== undefined) {
+                ret.backgroundColor = backgroundColor;
+            }
+            if (textColor !== "" && textColor !== undefined) {
+                ret.textColor = textColor;
+            }
+            if (errorTextColor !== "" && errorTextColor !== undefined) {
+                ret.errorTextColor = errorTextColor;
+            }
+            switch (logo) {
+                case "none":
+                    ret.logoUrl = null;
+                    break;
+                case "custom":
+                    if (logoUrl !== "" && logoUrl !== undefined) {
+                        ret.logoUrl = logoUrl;
+                    }
+                    break;
+                default:
+                case "default":
+                    break;
+            }
+            return ret;
+        })();
+        const pinScreenCustomization = {
+            enterPinText: pinEnterPinText,
+            incorrectText: pinIncorrectText,
+            unavailableText: pinUnavailableText,
+        };
+        const appScreenCustomization = {
+            loadingText: appLoadingText,
+            launchErrorText: appLaunchErrorText,
+        };
+        const intermediateScreenCustomization = (() => {
+            switch (intermediateScreenCustomizationType) {
+                case "override": {
+                    return {
+                        type: "regular",
+                        idleText: intermediateScreenOverrideText || "",
+                        // TODO successText
+                    };
+                }
+                case "app": {
+                    return {
+                        type: "app",
+                        appTemplateUrl: intermediateScreenAppTemplateId,
+                        appTemplateData: intermediateScreenAppTemplateData,
+                    };
+                }
+                case "none":
+                default: {
+                    return undefined;
+                }
+            }
+        })();
+        const statusScreenCustomization = (() => {
+            switch (connectionScreenCustomizationType) {
+                case "override": {
+                    return {
+                        type: "regular",
+                        connectingText: connectionScreenOverrideConnectingText || "",
+                        invalidTokenText: connectionScreenOverrideInvalidText || "",
+                        unavailableText: connectionScreenOverrideUnavailableText || "",
+                        // TODO connectionErrorText
+                    };
+                }
+                case "app": {
+                    return {
+                        type: "app",
+                        appTemplateUrl: connectionScreenAppTemplateId,
+                        appTemplateData: connectionScreenAppTemplateData,
+                    };
+                }
+                case "none":
+                default: {
+                    return undefined;
+                }
+            }
+        })();
+        const customization = (() => {
+            // TODO filter empty values
+            return {
+                style: style,
+                intermediateScreen: intermediateScreenCustomization,
+                statusScreen: statusScreenCustomization,
+                pinScreen: pinScreenCustomization,
+                appScreen: appScreenCustomization,
+            };
+        })();
+        if (!input.appSessionToken) {
+            const appSessionToken = await api.initAppSession({});
+            api.addToInput("appSessionToken", appSessionToken);
+        }
+        api.addToInput("shellPageBaseURL", shellPageBaseURL);
+        api.addToInput("shellPageOverrides", customization || null);
+    },
+});
+//# sourceMappingURL=initAppSession.js.map

package/build/shared/charts/descriptors/apps/setAdaptiveCardAppState.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SET_ADAPTIVE_CARD_APP_STATE = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+/**
+ * Node name: 'setAdaptiveCardAppState'
+ *
+ * Purpose:
+ * Set the state of an AdaptiveCard App
+ */
+exports.SET_ADAPTIVE_CARD_APP_STATE = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "setAdaptiveCardAppState",
+    defaultLabel: "Set AdaptiveCard App State",
+    summary: "Shows an AdaptiveCard via an App",
+    appearance: {
+        showIcon: false,
+    },
+    fields: [
+        {
+            key: "card",
+            type: "json",
+            label: "AdaptiveCard Definition",
+            description: "Insert a definition for an AdaptiveCard here. See https://adaptivecards.io/designer for help",
+            defaultValue: {},
+        },
+        {
+            key: "primaryColor",
+            type: "cognigyText",
+            label: "Primary Color Override",
+            description: "Alters the color of the background and interaction elements. Has to be a CSS-compatible color",
+            defaultValue: "",
+        },
+        {
+            key: "primaryContrastColor",
+            type: "cognigyText",
+            label: "Primary Contrast Color Override",
+            description: "Alters the color of text that is rendered on the 'Primary Color' (e.g. button labels). Has to be a CSS-compatible color",
+            defaultValue: "",
+        },
+        // OTHER
+        {
+            type: "cognigyText",
+            label: "AdaptiveCard Template URL",
+            description: "This field exists during development until this value is automatically assigned",
+            defaultValue: "http://static.test/apps/adaptivecards/",
+            key: "appTemplateURL",
+        },
+    ],
+    sections: [
+        {
+            key: "overrideSection",
+            defaultCollapsed: true,
+            fields: ["primaryColor", "primaryContrastColor"],
+            label: "Style Overrides",
+        },
+    ],
+    form: [
+        { type: "field", key: "card" },
+        { type: "section", key: "overrideSection" },
+        { type: "field", key: "appTemplateURL" },
+    ],
+    tags: ["basic", "apps"],
+    function: async ({ cognigy, config }) => {
+        const { api } = cognigy;
+        const { card, primaryColor, primaryContrastColor, appTemplateURL: _appTemplateURL, } = config;
+        const appTemplateURL = (() => {
+            if (!!_appTemplateURL)
+                return _appTemplateURL;
+            return "http://static.test/apps/adaptivecards/";
+        })();
+        api.setAppState(appTemplateURL, {
+            card,
+            primaryColor: primaryColor || undefined,
+            primaryContrastColor: primaryContrastColor || undefined,
+        });
+    },
+});
+//# sourceMappingURL=setAdaptiveCardAppState.js.map

package/build/shared/charts/descriptors/apps/setAppState.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SET_APP_STATE = void 0;
+/* Custom modules */
+const createNodeDescriptor_1 = require("../../createNodeDescriptor");
+/**
+ * Node name: 'setAppState'
+ *
+ * Purpose:
+ * Set the state of a Cognigy App Template.
+ */
+exports.SET_APP_STATE = (0, createNodeDescriptor_1.createNodeDescriptor)({
+    type: "setAppState",
+    defaultLabel: "Set App State",
+    summary: "Set the state of an App Template.",
+    appearance: {
+        showIcon: false,
+    },
+    fields: [
+        {
+            key: "appTemplateId",
+            type: "cognigyText",
+            label: "App Template",
+            description: "Select which App Template should be used",
+            params: {
+                required: true,
+            },
+        },
+        {
+            key: "appTemplateData",
+            type: "json",
+            label: "App Template Data",
+            description: "Select which data should be provided to the App Template",
+            defaultValue: "{}",
+        },
+    ],
+    tags: ["basic", "apps"],
+    function: async ({ cognigy, config }) => {
+        const { api } = cognigy;
+        const { appTemplateId, appTemplateData } = config;
+        api.setAppState(appTemplateId, appTemplateData);
+    },
+});
+//# sourceMappingURL=setAppState.js.map