feat(ai-assistant): add ai-assistant library

add ai-assistant-library

RPMS-37315

Author: Abhinav Verma

packages/ai-assistant/.editorconfig

@@ -0,0 +1,16 @@
+# Editor configuration, see https://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.ts]
+quote_type = single
+
+[*.md]
+max_line_length = off
+trim_trailing_whitespace = false

packages/ai-assistant/.gitignore

@@ -0,0 +1,49 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+
+# compiled output
+dist
+/tmp
+/out-tsc
+elements
+# Only exists if Bazel was run
+/bazel-out
+
+# dependencies
+/node_modules
+
+# profiling files
+chrome-profiler-events*.json
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+.history/*
+
+# misc
+/.angular/cache
+/.sass-cache
+/connect.lock
+/coverage
+/libpeerconnection.log
+npm-debug.log
+yarn-error.log
+testem.log
+/typings
+
+# System Files
+.DS_Store
+Thumbs.db
+
+.angular

packages/ai-assistant/.prettierignore

@@ -0,0 +1,4 @@
+dist
+*.json
+coverage
+src/assets

packages/ai-assistant/README.md

@@ -0,0 +1,156 @@
+# ai-assistant
+
+The ai-assistant library is a versatile and intelligent solution designed to seamlessly integrate AI-powered question-answering capabilities into Angular applications. This modular component allows developers to connect with configured AI models, enabling users to submit queries and receive AI-generated responses effortlessly.
+
+##  Structure
+
+The Structure of the ai-assistant is as follows
+```
+├── ai-assistant
+│      └──projects
+|         └──ai-assistant-lib
+│                         ├── src
+│                           ├── assets
+|                               ├── icons
+|                               ├── images
+|                               ├── styles
+│                           ├── lib
+│                               |── components
+|                               |── constants
+|                               |── enums
+|                               |── interfaces
+|                               |── models
+|                               |── pipes
+|                               |── services
+|                               |── types
+|────(...other files)
+```
+
+- The AI Assistant library offers a comprehensive set of features and components designed to help developers seamlessly integrate various elements into their AI assistant models with efficiency and ease.Here are some of components that it provides:
+
+## Components
+
+### co-pilot-message-actions
+
+- The co-pilot-message-actions component enables users to provide feedback on AI-generated responses by voting up or down. This feature helps improve the AI assistant’s performance by gathering user preferences and enhancing response quality over time. The component is designed for seamless integration and can be customized to align with specific user experience requirements.
+
+### co-pilot-image
+
+- The co-pilot-image component allows the display of images within AI-generated responses. This component enhances user interaction by providing visual context alongside text-based outputs.
+
+### co-pilot-video
+
+- The co-pilot-video component enables the integration of video content within AI-generated responses. This feature enhances user engagement by providing dynamic visual information alongside textual interactions.
+
+### co-pilot-related-topics
+
+- The co-pilot-related-topics component enhances user engagement by suggesting additional subjects pertinent to the current conversation. This feature encourages deeper exploration and understanding by presenting users with a curated list of related topics, fostering a more comprehensive and interactive experience.
+
+## Intsallation
+
+```bash
+npm install @sourceloop/ai-assistant
+```
+
+### Pre-Install
+
+#### Building the Library
+
+- To build the library, run:
+
+```bash
+npm run build-library
+```
+
+- Upon successful completion, the build output will be available at:
+
+```bash
+dist/ai-assistant
+```
+#### Packaging the Library
+
+- To package the library as a .tgz file, execute:
+
+```bash
+npm run pack-lib
+```
+
+- Once completed, the packaged file will be generated at:
+
+```bash
+npm dist/ai-assistant/ai-assistant-0.0.1.tgz
+```
+
+#### Demo Application: demo-sandbox
+
+The repository includes a sample application named demo-sandbox, designed to demonstrate the integration of the ai-assistant library.
+
+  - The app.component.ts and app.component.html files contain the necessary integration code for utilizing the ai-assistant library.
+
+
+## Run the sandbox
+
+from root of project reach to `demo-sandbox` and then `npm run start`. <br/> By default `http://localhost:4200` will be active
+
+## How to use targz in completely new project/repo?
+
+In your `package.json` do,
+
+```
+"dependencies": {
+    ...exisitng dependencies,
+    "ai-assistant": "file:ai-assistant-0.0.1.tgz"
+    
+  },
+```
+This includes pre-requisite that `tgz` is packed from `library` and exists in your project/repo
+
+Make sure the name of `tgz` file in `package.json` matches the `tgz` file in your repository
+
+Then do `npm install` it will install the library in your new project
+
+## Configuration
+
+To utilize the AI Assistant component, it is essential to configure specific parameters, such as the Server-Sent Events (SSE) URL. These configurations should be defined within your environment settings to ensure proper integration and functionality.
+
+Example configuration in your environment.ts:
+
+ts
+```
+export const environment = {
+  sseUrl: 'https://your-api-url.com/ai',  // URL for the AI service
+};
+```
+
+## Structure of SSE API
+
+It is expected your structure of SSE API to be <br/>
+
+```
+{
+    "chunk": "{{anytype here}}",
+    "type": "{{ChunkTypes}}"
+}
+```
+
+You can get more info on ChunkTypes from `ai-assistant/projects/ai-assistant/src/lib/types/chunk-response.types.ts`
+
+
+## Event Handling
+
+Upon successful configuration, the AI Assistant component will commence receiving events via Server-Sent Events (SSE). These events are transmitted in discrete segments, each potentially encompassing various data types, including but not limited to:
+
+- Image: An image provided by the AI service.
+- Video: A video provided by the AI service.
+- Related Topics: Suggestions for topics pertinent to the user's current context.
+- Feature: Notifications regarding unsupported features or limitations specific to certain tenants.
+Each event type is associated with a specific component responsible for rendering the appropriate content:
+
+- Image Events: Activate the ImageComponent to display the received image.
+- Video Events: Activate the VideoComponent to display the received video.
+This event-driven architecture ensures that each event is processed according to its type, thereby delivering accurate information or media to the user in a timely manner.
+Once your configuration is in place, the component will begin receiving events in chunks. These events may contain various types of data, including but not limited to:
+
+You can get more info on ChunkTypes from `/ai-assistant/projects/ai-assistant-lib/src/lib/components`
+
+For more details about Components ,refer [Here](/packages/ai-assistant/projects/ai-assistant-lib/README.md)

packages/ai-assistant/angular.json

@@ -0,0 +1,50 @@
+{
+  "$schema": "./node_modules/@angular/cli/lib/config/schema.json",
+  "cli": {
+    "analytics": false
+  },
+  "version": 1,
+  "newProjectRoot": "projects",
+  "projects": {
+    "ai-assistant": {
+      "projectType": "library",
+      "root": "projects/ai-assistant-lib",
+      "sourceRoot": "projects/ai-assistant-lib/src",
+      "prefix": "lib",
+      "architect": {
+        "build": {
+          "builder": "@angular-devkit/build-angular:ng-packagr",
+          "options": {
+            "project": "projects/ai-assistant-lib/ng-package.json"
+          },
+          "configurations": {
+            "production": {
+              "tsConfig": "projects/ai-assistant-lib/tsconfig.lib.prod.json"
+            },
+            "development": {
+              "tsConfig": "projects/ai-assistant-lib/tsconfig.lib.json"
+            }
+          },
+          "defaultConfiguration": "production"
+        },
+        "test": {
+          "builder": "@angular-devkit/build-angular:karma",
+          "options": {
+            "main": "projects/ai-assistant-lib/src/test.ts",
+            "tsConfig": "projects/ai-assistant-lib/tsconfig.spec.json",
+            "karmaConfig": "projects/ai-assistant-lib/karma.conf.js"
+          }
+        },
+        "lint": {
+          "builder": "@angular-eslint/builder:lint",
+          "options": {
+            "lintFilePatterns": [
+              "projects/ai-assistant-lib/**/*.ts",
+              "projects/ai-assistant-lib/**/*.html"
+            ]
+          }
+        }
+      }
+    }
+  }
+}