@telia-ace/knowledge-widget-bot-provider 0.0.1-alpha.3 → 0.0.1-alpha.32

package/lib/interface/_mocked-contact-method.json

@@ -0,0 +1,375 @@
+{
+    "ContactMethod": {
+        "Form": {
+            "Groups": [
+                {
+                    "Components": [
+                        {
+                            "$type": "Humany.KnowledgeBase.ContactMethods.FormTextComponent, Humany.KnowledgeBase",
+                            "Name": "customer-id",
+                            "HasCustomName": false,
+                            "Type": "text/number",
+                            "Value": "",
+                            "Constraints": {
+                                "Required": true,
+                                "Regex": null,
+                                "VerifyValue": false
+                            },
+                            "HasDependencies": false,
+                            "Title": "Customer ID",
+                            "Description": null,
+                            "Hints": [],
+                            "Visible": true,
+                            "VisibilityCriteria": {
+                                "Value": true,
+                                "Negated": true,
+                                "Description": null,
+                                "Criteria": [],
+                                "Operator": "And"
+                            },
+                            "HasDependants": false
+                        },
+                        {
+                            "$type": "Humany.KnowledgeBase.ContactMethods.FormGroupComponent, Humany.KnowledgeBase",
+                            "Children": [
+                                {
+                                    "$type": "Humany.KnowledgeBase.ContactMethods.FormTextComponent, Humany.KnowledgeBase",
+                                    "Name": "first-name",
+                                    "HasCustomName": false,
+                                    "Type": "text/sentence",
+                                    "Value": "",
+                                    "Constraints": {
+                                        "Required": false,
+                                        "Regex": null,
+                                        "VerifyValue": false
+                                    },
+                                    "HasDependencies": false,
+                                    "Title": "First name",
+                                    "Description": null,
+                                    "Hints": ["firstname", "verifyLabel=Confirm First name"],
+                                    "Visible": true,
+                                    "VisibilityCriteria": {
+                                        "Value": true,
+                                        "Negated": true,
+                                        "Description": null,
+                                        "Criteria": [],
+                                        "Operator": "And"
+                                    },
+                                    "HasDependants": false
+                                },
+                                {
+                                    "$type": "Humany.KnowledgeBase.ContactMethods.FormTextComponent, Humany.KnowledgeBase",
+                                    "Name": "last-name",
+                                    "HasCustomName": false,
+                                    "Type": "text/sentence",
+                                    "Value": "",
+                                    "Constraints": {
+                                        "Required": false,
+                                        "Regex": null,
+                                        "VerifyValue": false
+                                    },
+                                    "HasDependencies": false,
+                                    "Title": "Last name",
+                                    "Description": null,
+                                    "Hints": ["lastname"],
+                                    "Visible": true,
+                                    "VisibilityCriteria": {
+                                        "Value": true,
+                                        "Negated": true,
+                                        "Description": null,
+                                        "Criteria": [],
+                                        "Operator": "And"
+                                    },
+                                    "HasDependants": false
+                                }
+                            ],
+                            "Title": "Name",
+                            "Description": null,
+                            "Hints": ["fullname"],
+                            "Visible": true,
+                            "VisibilityCriteria": {
+                                "Value": true,
+                                "Negated": true,
+                                "Description": null,
+                                "Criteria": [],
+                                "Operator": "And"
+                            },
+                            "HasDependants": false
+                        },
+                        {
+                            "$type": "Humany.KnowledgeBase.ContactMethods.FormChoiceComponent, Humany.KnowledgeBase",
+                            "UseCustomValues": false,
+                            "Options": [
+                                {
+                                    "Title": "CheckBox 1",
+                                    "Value": "CheckBox 1",
+                                    "Selected": false
+                                },
+                                {
+                                    "Title": "CheckBox 2",
+                                    "Value": "CheckBox 2",
+                                    "Selected": false
+                                }
+                            ],
+                            "Name": "checkboxes",
+                            "HasCustomName": false,
+                            "Type": "choice",
+                            "Value": "",
+                            "Constraints": {
+                                "Required": true,
+                                "Regex": null,
+                                "VerifyValue": false
+                            },
+                            "HasDependencies": true,
+                            "Title": "Checkboxes",
+                            "Description": null,
+                            "Hints": ["checkbox", "multiple"],
+                            "Visible": true,
+                            "VisibilityCriteria": {
+                                "Value": true,
+                                "Negated": true,
+                                "Description": null,
+                                "Criteria": [],
+                                "Operator": "And"
+                            },
+                            "HasDependants": false
+                        },
+                        {
+                            "$type": "Humany.KnowledgeBase.ContactMethods.FormChoiceComponent, Humany.KnowledgeBase",
+                            "UseCustomValues": false,
+                            "Options": [
+                                {
+                                    "Title": "Test 1",
+                                    "Value": "Test 1",
+                                    "Selected": false
+                                },
+                                {
+                                    "Title": "Test 2",
+                                    "Value": "Test 2",
+                                    "Selected": false
+                                }
+                            ],
+                            "Name": "select-one",
+                            "HasCustomName": false,
+                            "Type": "choice",
+                            "Value": "",
+                            "Constraints": {
+                                "Required": true,
+                                "Regex": null,
+                                "VerifyValue": false
+                            },
+                            "HasDependencies": true,
+                            "Title": "Select one",
+                            "Description": null,
+                            "Hints": ["dropdown"],
+                            "Visible": true,
+                            "VisibilityCriteria": {
+                                "Value": true,
+                                "Negated": true,
+                                "Description": null,
+                                "Criteria": [],
+                                "Operator": "And"
+                            },
+                            "HasDependants": false
+                        },
+                        {
+                            "$type": "Humany.KnowledgeBase.ContactMethods.FormTextComponent, Humany.KnowledgeBase",
+                            "Name": "e-mail",
+                            "HasCustomName": false,
+                            "Type": "text/sentence",
+                            "Value": "",
+                            "Constraints": {
+                                "Required": true,
+                                "Regex": "^[a-zA-Z0-9._-]+@[a-zA-Z0-9.-]+.[a-zA-Z]{2,4}$",
+                                "VerifyValue": false
+                            },
+                            "HasDependencies": false,
+                            "Title": "E-mail",
+                            "Description": null,
+                            "Hints": ["email"],
+                            "Visible": true,
+                            "VisibilityCriteria": {
+                                "Value": true,
+                                "Negated": true,
+                                "Description": null,
+                                "Criteria": [],
+                                "Operator": "And"
+                            },
+                            "HasDependants": false
+                        },
+                        {
+                            "$type": "Humany.KnowledgeBase.ContactMethods.FormGroupComponent, Humany.KnowledgeBase",
+                            "Children": [
+                                {
+                                    "$type": "Humany.KnowledgeBase.ContactMethods.FormTextComponent, Humany.KnowledgeBase",
+                                    "Name": "street",
+                                    "HasCustomName": false,
+                                    "Type": "text/sentence",
+                                    "Value": "",
+                                    "Constraints": {
+                                        "Required": false,
+                                        "Regex": null,
+                                        "VerifyValue": false
+                                    },
+                                    "HasDependencies": false,
+                                    "Title": "Street",
+                                    "Description": null,
+                                    "Hints": ["street"],
+                                    "Visible": true,
+                                    "VisibilityCriteria": {
+                                        "Value": true,
+                                        "Negated": true,
+                                        "Description": null,
+                                        "Criteria": [],
+                                        "Operator": "And"
+                                    },
+                                    "HasDependants": false
+                                },
+                                {
+                                    "$type": "Humany.KnowledgeBase.ContactMethods.FormTextComponent, Humany.KnowledgeBase",
+                                    "Name": "number",
+                                    "HasCustomName": false,
+                                    "Type": "text/word",
+                                    "Value": "",
+                                    "Constraints": {
+                                        "Required": false,
+                                        "Regex": null,
+                                        "VerifyValue": false
+                                    },
+                                    "HasDependencies": false,
+                                    "Title": "Number",
+                                    "Description": null,
+                                    "Hints": ["number"],
+                                    "Visible": true,
+                                    "VisibilityCriteria": {
+                                        "Value": true,
+                                        "Negated": true,
+                                        "Description": null,
+                                        "Criteria": [],
+                                        "Operator": "And"
+                                    },
+                                    "HasDependants": false
+                                },
+                                {
+                                    "$type": "Humany.KnowledgeBase.ContactMethods.FormTextComponent, Humany.KnowledgeBase",
+                                    "Name": "postcode",
+                                    "HasCustomName": false,
+                                    "Type": "text/word",
+                                    "Value": "",
+                                    "Constraints": {
+                                        "Required": false,
+                                        "Regex": null,
+                                        "VerifyValue": false
+                                    },
+                                    "HasDependencies": false,
+                                    "Title": "Postcode",
+                                    "Description": null,
+                                    "Hints": ["zipcode"],
+                                    "Visible": true,
+                                    "VisibilityCriteria": {
+                                        "Value": true,
+                                        "Negated": true,
+                                        "Description": null,
+                                        "Criteria": [],
+                                        "Operator": "And"
+                                    },
+                                    "HasDependants": false
+                                },
+                                {
+                                    "$type": "Humany.KnowledgeBase.ContactMethods.FormTextComponent, Humany.KnowledgeBase",
+                                    "Name": "city",
+                                    "HasCustomName": false,
+                                    "Type": "text/sentence",
+                                    "Value": "",
+                                    "Constraints": {
+                                        "Required": false,
+                                        "Regex": null,
+                                        "VerifyValue": false
+                                    },
+                                    "HasDependencies": false,
+                                    "Title": "City",
+                                    "Description": null,
+                                    "Hints": ["city"],
+                                    "Visible": true,
+                                    "VisibilityCriteria": {
+                                        "Value": true,
+                                        "Negated": true,
+                                        "Description": null,
+                                        "Criteria": [],
+                                        "Operator": "And"
+                                    },
+                                    "HasDependants": false
+                                }
+                            ],
+                            "Title": "Address",
+                            "Description": null,
+                            "Hints": ["address"],
+                            "Visible": true,
+                            "VisibilityCriteria": {
+                                "Value": true,
+                                "Negated": true,
+                                "Description": null,
+                                "Criteria": [],
+                                "Operator": "And"
+                            },
+                            "HasDependants": false
+                        }
+                    ],
+                    "Title": "",
+                    "Description": null,
+                    "Hints": null,
+                    "Visible": true,
+                    "VisibilityCriteria": {
+                        "Value": true,
+                        "Negated": true,
+                        "Description": null,
+                        "Criteria": [],
+                        "Operator": "And"
+                    },
+                    "HasDependants": false
+                }
+            ],
+            "HasValueComponents": true,
+            "Extra": {}
+        },
+        "Exits": [
+            {
+                "Name": "email1",
+                "Type": "email",
+                "Adapter": {
+                    "Id": "6973ff0a-b1a9-4f01-cd87-e7547f1384c0",
+                    "ClientName": "email.form",
+                    "CustomClientName": null,
+                    "Uri": "/interfaces/widgets/adapters/email.form.js",
+                    "Settings": {}
+                }
+            }
+        ],
+        "ConfirmationText": "<h1>Thank you!</h1><p>Your message has been sent.</p>",
+        "Id": 942,
+        "Title": "Report a problem",
+        "Description": "<p>Use this contact form to send us the relevant information.</p>\n",
+        "UriName": "report-a-problem",
+        "Attributes": [],
+        "Translations": {
+            "en": 942
+        },
+        "MatchQuestion": false,
+        "ExitType": "email",
+        "ExitConfiguration": "email.form",
+        "Highlighted": false,
+        "HighlightedInStart": false,
+        "ExecuteImmediately": false,
+        "ExpandFormAutomatically": false,
+        "DefaultIcon": {
+            "Type": "FontAwesome",
+            "Content": "envelope"
+        },
+        "ActiveIcon": {
+            "Type": null,
+            "Content": null
+        },
+        "LastModified": "2022-04-07T11:14:20.5582864Z",
+        "Parents": [808]
+    }
+}

package/lib/interface/convert.d.ts

@@ -0,0 +1 @@
+export declare const toContactMethod: ({ Id, Title, DefaultIcon, Exits: [Exit], ExitType, ConfirmationText, ExpandFormAutomatically, Form, Description, }: any, Validation?: any) => any;

package/lib/interface/convert.js

@@ -0,0 +1,68 @@
+// TODO: remove this file
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+import { FormBuilder } from '@humany/widget-forms';
+export var toContactMethod = function (_a, Validation) {
+    var Id = _a.Id, Title = _a.Title, DefaultIcon = _a.DefaultIcon, _b = __read(_a.Exits, 1), Exit = _b[0], ExitType = _a.ExitType, ConfirmationText = _a.ConfirmationText, ExpandFormAutomatically = _a.ExpandFormAutomatically, Form = _a.Form, Description = _a.Description;
+    var Adapter = (Exit || { Adapter: {} }).Adapter;
+    var _c = Adapter.ClientName, ClientName = _c === void 0 ? '' : _c, _d = Adapter.Settings, Settings = _d === void 0 ? {} : _d, _e = Adapter.CustomClientName, CustomClientName = _e === void 0 ? '' : _e;
+    var settings = {
+        id: Id.toString(),
+        title: Title,
+        description: Description,
+        // symbol: convertLegacySymbol(DefaultIcon), // TODO:
+        symbol: null,
+        clientName: ClientName === 'custom.adapter' ? CustomClientName : ClientName,
+        expanded: true,
+        inline: true,
+        body: {},
+    };
+    if (ClientName.indexOf('phone') > -1 || ClientName.indexOf('freetext') > -1) {
+        var displayTextBeforeClick = Settings.displayTextBeforeClick, textBeforeClick = Settings.textBeforeClick;
+        if (displayTextBeforeClick === 'true') {
+            settings.expanded = false;
+            settings.title = textBeforeClick;
+        }
+        if (ClientName.indexOf('phone.text') > -1) {
+            settings.body.phoneNumber = Settings.phoneNumber;
+        }
+        else {
+            settings.body.freetext = Settings.freetext;
+        }
+    }
+    if (ClientName.indexOf('chat.popup') > -1 ||
+        ClientName.indexOf('link') > -1 ||
+        (ClientName === 'custom.adapter' && ExitType === 'custom')) {
+        settings.body = Settings;
+        settings.body.confirmationFallback = ConfirmationText;
+    }
+    if (ClientName.indexOf('ace') > -1) {
+        settings.body = Settings;
+    }
+    if (Form && Form.HasValueComponents) {
+        if (Validation) {
+            settings.body.form = FormBuilder.fromLegacyForm(Id.toString(), Form, Validation).get();
+        }
+        else {
+            settings.body.form = FormBuilder.fromLegacyForm(Id.toString(), Form).get();
+        }
+        if (!ExpandFormAutomatically) {
+            settings.expanded = settings.inline = false;
+        }
+    }
+    return settings;
+};

package/lib/interface/entry.interface.d.ts

@@ -1,17 +1,20 @@
-import { Message } from '../contract/model/conversation-api-model/message.model';
-import { ServerEntry } from '../contract/model/http/server-entry.model';
-export default class EntryInterface {
-    private helpActionKey;
-    private nextActionKey;
-    constructor();
-    transform(entry: ServerEntry): Message | undefined;
-    transformArray(entryArray: ServerEntry[]): Message[];
-    getUserMessage(action: string): string | undefined;
-    private listTransform;
-    private getContentText;
-    private textTransform;
-    private getListActions;
-    private getListType;
-    private getTitleFromEntry;
-    private getTitleFromList;
-}
+import { Container } from '@webprovisions/platform';
+import { Message } from '../contract/model/conversation-api-model/message.model';
+import { ServerEntry } from '../contract/model/http/server-entry.model';
+export default class EntryInterface {
+    private container;
+    private helpActionKey;
+    private nextActionKey;
+    constructor(container: Container);
+    transform(entry: ServerEntry): Promise<Message | undefined>;
+    transformContactMethod(entry: ServerEntry): Promise<any>;
+    transformArray(entryArray: ServerEntry[]): Promise<Message[]>;
+    getUserMessage(action: string): string | undefined;
+    private listTransform;
+    private getContentText;
+    private textTransform;
+    private getListActions;
+    private getListType;
+    private getTitleFromEntry;
+    private getTitleFromList;
+}