@telia-ace/conversational-hub-bot-provider 0.0.2 → 0.0.4

package/.eslintrc.json

@@ -0,0 +1,23 @@
+{
+  "extends": ["plugin:@nx/react", "../../../.eslintrc.json"],
+  "ignorePatterns": ["!**/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {
+        "@typescript-eslint/ban-types": "off",
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/no-unused-vars": "off",
+        "@typescript-eslint/no-empty-function": "off"
+      }
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    }
+  ]
+}

package/README.md

@@ -0,0 +1,7 @@
+# @telia-ace/conversational-hub-bot-provider
+
+This library was generated with [Nx](https://nx.dev).
+
+## Running unit tests
+
+Run `nx test @telia-ace/conversational-hub-bot-provider` to execute the unit tests via [Vitest](https://vitest.dev/).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@telia-ace/conversational-hub-bot-provider",
-  "version": "0.0.2",
+  "version": "0.0.4",
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {

package/project.json

@@ -0,0 +1,57 @@
+{
+  "name": "@telia-ace/conversational-hub-bot-provider",
+  "$schema": "../../../node_modules/nx/schemas/project-schema.json",
+  "sourceRoot": "libs/conversational-hub/bot-provider/src",
+  "projectType": "library",
+  "tags": [],
+  "targets": {
+    "lint": {
+      "executor": "@nx/linter:eslint",
+      "outputs": ["{options.outputFile}"],
+      "options": {
+        "lintFilePatterns": [
+          "libs/conversational-hub/bot-provider/**/*.{ts,tsx,js,jsx}",
+          "libs/conversational-hub/bot-provider/package.json"
+        ]
+      }
+    },
+    "build": {
+      "executor": "@nx/vite:build",
+      "outputs": ["{options.outputPath}"],
+      "defaultConfiguration": "production",
+      "options": {
+        "outputPath": "dist/libs/conversational-hub/bot-provider"
+      },
+      "configurations": {
+        "development": {
+          "mode": "development"
+        },
+        "production": {
+          "mode": "production"
+        }
+      }
+    },
+    "publish": {
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "npm publish",
+        "cwd": "dist/libs/conversational-hub/bot-provider"
+      }
+    },
+    "prerelease": {
+      "executor": "nx:run-commands",
+      "options": {
+        "command": "npm publish --tag=rc",
+        "cwd": "dist/libs/conversational-hub/bot-provider"
+      }
+    },
+    "test": {
+      "executor": "@nx/vite:test",
+      "outputs": ["{options.reportsDirectory}"],
+      "options": {
+        "passWithNoTests": true,
+        "reportsDirectory": "../../../coverage/libs/conversational-hub/bot-provider"
+      }
+    }
+  }
+}

package/src/declaration.d.ts

@@ -0,0 +1,2 @@
+declare type Optional<T> = T | undefined;
+declare type Merge<M, N> = Omit<M, Extract<keyof M, keyof N>> & N;

package/src/emotion.d.ts

@@ -0,0 +1,7 @@
+import '@emotion/react';
+import { Theme as ITheme } from '@telia-ace/knowledge-widget-core';
+
+declare module '@emotion/react' {
+  // eslint-disable-next-line @typescript-eslint/no-empty-interface
+  export interface Theme extends Partial<ITheme> {}
+}

package/src/plugin.ts

@@ -0,0 +1,198 @@
+import {
+  ConversationPlatform,
+  ConversationProvider,
+  Agent,
+} from '@telia-ace/widget-conversation';
+import { Container, Widget } from '@webprovisions/platform';
+import { AgentResponse, AgentPrompt, Action } from './types';
+import { Logger } from '@telia-ace/widget-utilities';
+
+/**
+ * Plugin for communicating with Webconnector API in Conversational Hub.
+ */
+export const ConversationalHubPlugin = async (container: Container) => {
+  const widget: Widget = container.get('$widget');
+
+  // Get extension from widget configuration.
+  const settings =
+    widget?.container?.get('$settings')?.components?.conversation?.properties
+      ?.conversationalHubPluginSettings;
+
+  // Get Conversation Platform from widget.
+  const conversationPlatform = await ConversationPlatform.getInstance(
+    container
+  );
+
+  let conversation: ConversationProvider;
+  let agent: Agent;
+  let connectionAttempts = settings?.connectionAttempts
+    ? settings.connectionAttempts
+    : 5;
+
+  // Register a provider for plugin.
+  conversationPlatform.registerProvider(
+    'chub-plugin',
+    (conversationProvider, component) => {
+      conversation = conversationProvider;
+
+      // Create an agent.
+      agent = conversation.createAgent({
+        name: settings?.botName,
+        avatar: settings?.avatar,
+      }) as Agent;
+
+      initialize();
+
+      // Watch for actions (button click).
+      component.actions.watch('conversation.action', (action, next) => {
+        sendAction(action);
+        return next(action);
+      });
+
+      // Watch for user input.
+      component.actions.watch('conversation.user-submit', (input, next) => {
+        sendInput(input.text);
+        return next(input);
+      });
+    }
+  );
+
+  /**
+   * Initialize session with Conversational Hub.
+   */
+  async function initialize(print = true) {
+    await fetchFromApi(
+      settings.baseUrl + '/initialize',
+      `{"extension": "${settings.extension}"}`,
+      print
+    );
+  }
+
+  /**
+   * Send action to Webconnector API.
+   * @param action - User interaction.
+   */
+  async function sendAction(action: Action) {
+    await fetchFromApi(
+      `${settings.baseUrl}/input/${settings.sessionId}`,
+      `{"type":"button_click","language":"${settings.language}","content":{"button_text":"${action.label}","value":"${action.actionKey}"}}`
+    );
+  }
+
+  /**
+   * Send user text message to Webconnector API.
+   * @param text - Text message.
+   */
+  async function sendInput(text: string) {
+    await fetchFromApi(
+      `${settings.baseUrl}/input/${settings.sessionId}`,
+      `{"type":"text","language":"${settings.language}","content":{"text":"${text}"}}`
+    );
+  }
+
+  /**
+   * Fetch data from endpoint in Webconnector API.
+   * @param url - API endpoint.
+   * @param body - Request payload.
+   */
+  async function fetchFromApi(url: string, body: string, print = true) {
+    // Activate loader animation.
+    const loader = conversation.loading();
+
+    let response;
+    let result;
+
+    try {
+      response = await fetch(url, {
+        method: 'POST',
+        body: body,
+      });
+      result = await response?.json();
+    } catch (error) {
+      if (error instanceof SyntaxError) {
+        Logger.error('Incorrect JSON format.', error);
+      } else {
+        Logger.error('Network error: check connection or baseUrl.', error);
+      }
+
+      loader();
+      agent.print(settings.errorMessage);
+      return;
+    }
+
+    if (!response?.ok) {
+      Logger.error(`HTTP ${response?.status}.`, JSON.stringify(result));
+
+      loader();
+
+      // Check if the session has expired.
+      const sessionExpired = !!result?.errors?.filter(
+        (error: any) => error.code === '1003'
+      ).length;
+
+      // Initialize again and fetch data depening on payload content.
+      if (sessionExpired && connectionAttempts > 0) {
+        connectionAttempts--;
+        await new Promise((resolve) => setTimeout(resolve, 500));
+        await initialize(false);
+
+        const payload = JSON.parse(body);
+        if (payload?.content?.text) {
+          await sendInput(payload.content.text);
+        } else if (payload?.content?.action) {
+          await sendAction(payload?.content?.action);
+        }
+      } else {
+        agent.print(settings.errorMessage);
+      }
+      return;
+    }
+
+    // Remove loader animation.
+    loader();
+
+    connectionAttempts = 5;
+    settings.sessionId = result?.session_id;
+
+    if (print) {
+      printResult(result);
+    }
+  }
+
+  /**
+   * Print text results and prompts.
+   * @param result - Data to print.
+   */
+  function printResult(result: any) {
+    // Print every message in result.
+    result?.agent_response.forEach((response: AgentResponse) => {
+      agent.print(response.payload.text);
+    });
+
+    // Print every prompt in result.
+    if (result?.prompt?.items) {
+      agent.print([
+        'button-list',
+        {
+          actions: result.prompt.items.map((prompt: AgentPrompt) => {
+            let result;
+            if (prompt.type === 'button')
+              result = { actionKey: prompt.value, label: prompt.text };
+            if (prompt.type === 'link')
+              result = {
+                actionKey: prompt.value,
+                label: prompt.text,
+                data: {
+                  href: prompt.url,
+                  target: settings?.linkTarget ? settings.linkTarget : '_blank',
+                },
+              };
+            return result;
+          }),
+        },
+      ]);
+    }
+  }
+};
+
+export default ConversationalHubPlugin;

package/src/types.ts

@@ -0,0 +1,20 @@
+export type AgentResponse = {
+  language: string;
+  type: string;
+  payload: {
+    text: string;
+  };
+};
+
+export type AgentPrompt = {
+  value: string;
+  text: string;
+  url?: string;
+  type: 'button' | 'link';
+};
+
+export type Action = {
+  actionKey: string;
+  label: string;
+  url?: string;
+};

package/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "jsx": "react-jsx",
+    "allowJs": false,
+    "esModuleInterop": false,
+    "allowSyntheticDefaultImports": true,
+    "strict": true,
+    "types": ["vite/client", "vitest"]
+  },
+  "files": [],
+  "include": [],
+  "references": [
+    {
+      "path": "./tsconfig.lib.json"
+    },
+    {
+      "path": "./tsconfig.spec.json"
+    }
+  ],
+  "extends": "../../../tsconfig.base.json"
+}

package/tsconfig.lib.json

@@ -0,0 +1,23 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../../dist/out-tsc",
+    "types": [
+      "node",
+      "@nx/react/typings/cssmodule.d.ts",
+      "@nx/react/typings/image.d.ts",
+      "vite/client"
+    ]
+  },
+  "exclude": [
+    "**/*.spec.ts",
+    "**/*.test.ts",
+    "**/*.spec.tsx",
+    "**/*.test.tsx",
+    "**/*.spec.js",
+    "**/*.test.js",
+    "**/*.spec.jsx",
+    "**/*.test.jsx"
+  ],
+  "include": ["src/**/*.js", "src/**/*.jsx", "src/**/*.ts", "src/**/*.tsx"]
+}

package/tsconfig.spec.json

@@ -0,0 +1,19 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "types": ["vitest/globals", "vitest/importMeta", "vite/client", "node"]
+  },
+  "include": [
+    "vite.config.ts",
+    "src/**/*.test.ts",
+    "src/**/*.spec.ts",
+    "src/**/*.test.tsx",
+    "src/**/*.spec.tsx",
+    "src/**/*.test.js",
+    "src/**/*.spec.js",
+    "src/**/*.test.jsx",
+    "src/**/*.spec.jsx",
+    "src/**/*.d.ts"
+  ]
+}

package/vite.config.ts

@@ -0,0 +1,53 @@
+/// <reference types="vitest" />
+import { defineConfig } from 'vite';
+import react from '@vitejs/plugin-react-swc';
+import { nxViteTsPaths } from '@nx/vite/plugins/nx-tsconfig-paths.plugin';
+import dts from 'vite-plugin-dts';
+import * as path from 'path';
+
+export default defineConfig({
+  cacheDir:
+    '../../../node_modules/.vite/@telia-ace/conversational-hub-bot-provider',
+
+  plugins: [
+    dts({
+      entryRoot: 'src',
+      tsConfigFilePath: path.join(__dirname, 'tsconfig.lib.json'),
+      skipDiagnostics: true,
+    }),
+    react(),
+    nxViteTsPaths(),
+  ],
+
+  // Uncomment this if you are using workers.
+  // worker: {
+  //  plugins: [ nxViteTsPaths() ],
+  // },
+
+  // Configuration for building your library.
+  // See: https://vitejs.dev/guide/build.html#library-mode
+  build: {
+    lib: {
+      // Could also be a dictionary or array of multiple entry points.
+      entry: 'src/index.ts',
+      name: '@telia-ace/conversational-hub-bot-provider',
+      fileName: 'index',
+      // Change this to the formats you want to support.
+      // Don't forget to update your package.json as well.
+      formats: ['es', 'cjs'],
+    },
+    rollupOptions: {
+      // External packages that should not be bundled into your library.
+      external: ['react', 'react-dom', 'react/jsx-runtime'],
+    },
+  },
+
+  test: {
+    globals: true,
+    cache: {
+      dir: '../../../node_modules/.vitest',
+    },
+    environment: 'jsdom',
+    include: ['src/**/*.{test,spec}.{js,mjs,cjs,ts,mts,cts,jsx,tsx}'],
+  },
+});