jacekpluta edcc6f8047
[ACS-8201] Knowledge Retrieval - getting AI response for one or more selected files (#4127)
* [ACS-8202] basic flow getting ai response for one or more selected files (#3936)

* ACS-8202 Added animated icon

* ACS-8202 Added search ai input

* ACS-8202 Added AI search results page

* ACS-8202 Allow to run knowledge retrieval on files inside library, shared, favourites and recent files

* ACS-8202 Hide icon when selected more than 100 files or non text files

* ACS-8202 Display notification when too many files are selected

* ACS-8202 Added agents dropdown

* ACS-8202 Styles for AI response

* ACS-8202 Applied design changes

* ACS-8202 Added query card to Knowledge retrieval page results

* ACS-8202 Fixed search collapsing when opened results page

* ACS-8202 Changed placeholder in input for results page, wrapping text and scrolling for results page

* ACS-8202 Display snackbar with messages when conditions are not met

* ACS-8202 Disallow run knowledge retrieval for libraries, leave input when click on x button

* ACS-8202 Renaming files

* ACS-8202 Trigger ai input by selecting agent instead of clicking on button

* ACS-8202 Reverted triggering showing input by selecting option from select

* ACS-8202 Display dropdown with agents by clicking on button

* ACS-8202 Structural changes - services and agents button component

* ACS-8202 Removed part for examples from search page

* ACS-8202 Simplified html for search page

* ACS-8202 Refactored html and styles for search page, translations for search page

* ACS-8202 More html and styles refactoring

* ACS-8202 Formatting html

* ACS-8202 Removed references to angular material classes

* ACS-8202 Added data automation id attributes

* ACS-8202 Load agents from backend, formatting html for agents button component and adding data automation ids to that component

* ACS-8202 Correction after rebase

* ACS-8202 Set agent for input based on selected agent from dropdown for agents button

* ACS-8202 Hide agent button for libraries pages and use translations for warnings when clicked on agents button

* ACS-8202 Pass agent id to search results page

* ACS-8202 Used form control instead of ngmodel for search query

* ACS-8202 Moved search ai service and search ai input state to ADF

* ACS-8202 Results page ts clean up

* ACS-8202 Used ask and getAnswer functions from search ai service

* ACS-8202 Cleaning of search ai navigation service

* ACS-8202 Small clean ups

* ACS-8202 Renamed sources to references

* ACS-8202 Fixed asking next question from results page

* ACS-8202 Added possibility to use knowledge retrieval from search results page

* ACS-8202 Fixed issue with selecting the same agent after previously closing input on search results page

* ACS-8202 Disallowed using knowledge retrieval on trash page

* ACS-8202 Hide toggling knowledge retrieval for tasks and processes, fixed displaying ask button for favorites page

* ACS-8202 Removed redundant image and function

* ACS-8202 Renamed breadcrumbTemplate to header

* ACS-8202 Removed redundant code, added some comments, made some fields as private

* ACS-8202 Display error message on search page

* ACS-8202 Accessibility changes

* ACS-8202 Small correction

* ACS-8202 Addressed comments

* ACS-8202 Displayed correct initials

* ACS-8202 Removed redundant imports

* ACS-8202 Change css value

* ACS-8202 Removed icon animation

* ACS-8202 Removed icon animation

* ACS-8201 Small correction after rebasing with Angular 15

* [ACS-8398] unit tests (#3973)

* ACS-8398 Unit tests for agents button and part for agents menu

* ACS-8398 Unit tests for search ai input component

* [ACS-8210] Agent basic details popup (#3942)

* [ACS-8210] Agent basic details popup

* [ACS-8210] Agent basic details popup - review fixes

---------

Co-authored-by: Aleksander Sklorz <aleksander.sklorz@hyland.com>

* [ACS-8382] Blurring the AI answer section before getting response from backend (#3948)

* [ACS-8398] Unit tests part 2 (#3989)

* ACS-8398 Unit tests for search ai input container

* ACS-8398 Unit tests for search ai navigation service and rest tests for search ai input container component

* ACS-8398 Added missing type

* [ACS-8484] Add feature flag to knowledge retrieval (#4003)

* [ACS-8562] "Ask Agent" button name is changed to "Ask Discovery"

* [ACS-8573] Allow user to ask question without file selection

* [ACS-8312] Display warning about losing response (#4012)

* ACS-8201 Fixed issues after rebase

* [ACS-8588] Navigation is triggered twice when leaving Knowledge Retrieval page (#4030)

[ACS-8588] Navigation is triggered twice when leaving Knowledge Retrieval page

* [ACS-8399] Integrate all changes with backend (#4076)

* [ACS-8399] Integrate all changes with backend

* [ACS-8399] Integrate all changes with backend - review fixes

* Answers endpoint fix

* Answers endpoint fix (#4107)

* [ACS-8664] generic question redirection to hx insight page (#4102)

* ACS-8664 Open page in new tab

* ACS-8664 Loading HX insight url

* ACS-8664 Unit tests

* ACS-8664 Fix after rebasing

* ACS-8664 Fixed unit tests

* ACS-8664 Added type

* ACS-8664 Removed duplicated lines

* ACS-8664 Removed duplicated lines

* ACS-8664 Addressed comments

* [ACS-8695] Getting Agent avatar (#4110)

* [ACS-8695] Getting Agent avatar

* [ACS-8695] Getting Agent avatar - fixes

* [ACS-8695] Getting Agent avatar - fixes 2

* Adding mocked agent avatars (#4117)

* [ACS-8201] review fixes

* [ACS-8201] review fixes

* [E2E] excluded failing tests to fix later pt.1

* [ACS-8767] allow to open referenced files (#4129)

* ACS-8767 Opening referenced files

* ACS-8767 Reverted one line

* ACS-8767 Removed unwanted code

* ACS-8767

* ACS-8767 Unit tests for allowing clicking on references

* ACS-8767 Unit tests

* ACS-8767 Moved duplicated code to function

* ACS-8767 Resolved sonar issue

* ACS-8767 Resolved sonar issue

* [ACS-8201] knowledge retrieval feature flag - false

* [E2E] excluded failing tests to fix later pt.2

* ACS-8201 Fixed tests

---------

Co-authored-by: AleksanderSklorz <115619721+AleksanderSklorz@users.noreply.github.com>
Co-authored-by: Aleksander Sklorz <Aleksander.Sklorz@hyland.com>
Co-authored-by: datguychen <adam.swiderski@hyland.com>
2024-09-20 14:47:41 +02:00

399 lines
13 KiB
TypeScript

/*!
* Copyright © 2005-2024 Hyland Software, Inc. and its affiliates. All rights reserved.
*
* Alfresco Example Content Application
*
* This file is part of the Alfresco Example Content Application.
* If the software was purchased under a paid Alfresco license, the terms of
* the paid license agreement will prevail. Otherwise, the software is
* provided under the following open source license terms:
*
* The Alfresco Example Content Application is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* The Alfresco Example Content Application is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* from Hyland Software. If not, see <http://www.gnu.org/licenses/>.
*/
import {
CustomEmptyContentTemplateDirective,
DataColumnComponent,
DataColumnListComponent,
PaginationComponent,
ShowHeaderMode
} from '@alfresco/adf-core';
import { Component, OnDestroy, OnInit, ViewEncapsulation } from '@angular/core';
import { ActivatedRoute, Params } from '@angular/router';
import { NodeEntry, Node, PathElement } from '@alfresco/js-api';
import { NodeActionsService } from '../../services/node-actions.service';
import {
ContentApiService,
ContextActionsDirective,
GenericErrorComponent,
InfoDrawerComponent,
PageComponent,
PageLayoutComponent,
PaginationDirective,
ToolbarComponent
} from '@alfresco/aca-shared';
import { SetCurrentFolderAction, isAdmin, UploadFileVersionAction, showLoaderSelector } from '@alfresco/aca-shared/store';
import { debounceTime, takeUntil } from 'rxjs/operators';
import {
BreadcrumbComponent,
DocumentListComponent,
FileUploadEvent,
FilterSearch,
ShareDataRow,
UploadDragAreaComponent
} from '@alfresco/adf-content-services';
import { DocumentListPresetRef, DynamicColumnComponent } from '@alfresco/adf-extensions';
import { CommonModule } from '@angular/common';
import { TranslateModule } from '@ngx-translate/core';
import { DocumentListDirective } from '../../directives/document-list.directive';
import { MatProgressSpinnerModule } from '@angular/material/progress-spinner';
import { SearchAiInputContainerComponent } from '../knowledge-retrieval/search-ai/search-ai-input-container/search-ai-input-container.component';
@Component({
standalone: true,
imports: [
CommonModule,
TranslateModule,
GenericErrorComponent,
DocumentListDirective,
ContextActionsDirective,
PaginationComponent,
MatProgressSpinnerModule,
InfoDrawerComponent,
PaginationDirective,
PageLayoutComponent,
ToolbarComponent,
SearchAiInputContainerComponent,
DynamicColumnComponent,
BreadcrumbComponent,
UploadDragAreaComponent,
DocumentListComponent,
DataColumnListComponent,
DataColumnComponent,
CustomEmptyContentTemplateDirective
],
templateUrl: './files.component.html',
encapsulation: ViewEncapsulation.None,
selector: 'aca-files'
})
export class FilesComponent extends PageComponent implements OnInit, OnDestroy {
isValidPath = true;
isAdmin = false;
selectedNode: NodeEntry;
queryParams = null;
showLoader$ = this.store.select(showLoaderSelector);
private nodePath: PathElement[];
columns: DocumentListPresetRef[] = [];
isFilterHeaderActive = false;
constructor(private contentApi: ContentApiService, private nodeActionsService: NodeActionsService, private route: ActivatedRoute) {
super();
}
ngOnInit() {
super.ngOnInit();
const { data } = this.route.snapshot;
this.title = data.title;
this.route.queryParamMap.pipe(takeUntil(this.onDestroy$)).subscribe((queryMap: Params) => {
this.queryParams = queryMap.params;
});
this.route.params.pipe(takeUntil(this.onDestroy$)).subscribe(({ folderId }: Params) => {
const nodeId = folderId || data.defaultNodeId;
this.contentApi
.getNode(nodeId)
.pipe(takeUntil(this.onDestroy$))
.subscribe(
(node) => {
this.isValidPath = true;
if (node?.entry?.isFolder) {
void this.updateCurrentNode(node.entry);
} else {
void this.router.navigate(['/personal-files', node.entry.parentId], {
replaceUrl: true
});
}
},
() => (this.isValidPath = false)
);
});
this.subscriptions = this.subscriptions.concat([
this.nodeActionsService.contentCopied.subscribe((nodes) => this.onContentCopied(nodes)),
this.uploadService.fileUploadComplete.pipe(debounceTime(300)).subscribe((file) => this.onFileUploadedEvent(file)),
this.uploadService.fileUploadDeleted.pipe(debounceTime(300)).subscribe((file) => this.onFileUploadedEvent(file))
]);
this.store
.select(isAdmin)
.pipe(takeUntil(this.onDestroy$))
.subscribe((value) => {
this.isAdmin = value;
});
this.extensions.filesDocumentListPreset$.pipe(takeUntil(this.onDestroy$)).subscribe((preset) => {
this.columns = preset;
});
if (this.queryParams && Object.keys(this.queryParams).length > 0) {
this.isFilterHeaderActive = true;
}
}
ngOnDestroy() {
this.store.dispatch(new SetCurrentFolderAction(null));
super.ngOnDestroy();
}
navigate(nodeId: string = null) {
const currentNodeId = this.route.snapshot.paramMap.get('folderId');
const urlWithoutParams = decodeURIComponent(this.router.url).split('?')[0];
const urlToNavigate: string[] = this.getUrlToNavigate(urlWithoutParams, currentNodeId, nodeId);
void this.router.navigate(urlToNavigate);
}
private getUrlToNavigate(currentURL: string, currentNodeId: string, nextNodeId: string): string[] {
return currentNodeId ? this.getNextNodeUrlToNavigate(currentURL, currentNodeId, nextNodeId) : this.appendNextNodeIdToUrl(currentURL, nextNodeId);
}
private getNextNodeUrlToNavigate(currentURL: string, currentNodeId: string, nextNodeId: string): string[] {
const urlToNavigate: string[] =
nextNodeId && !this.isRootNode(nextNodeId)
? this.replaceCurrentNodeIdWithNextNodeId(currentURL, currentNodeId, nextNodeId)
: this.removeNodeIdFromUrl(currentURL, currentNodeId);
urlToNavigate.shift();
return urlToNavigate;
}
private replaceCurrentNodeIdWithNextNodeId(currentURL: string, currentNodeId: string, nextNodeId: string): string[] {
const nextNodeUrlToNavigate = currentURL.split('/');
const index = nextNodeUrlToNavigate.indexOf(currentNodeId);
if (index > 0) {
nextNodeUrlToNavigate[index] = nextNodeId;
}
return nextNodeUrlToNavigate;
}
private removeNodeIdFromUrl(currentURL: string, currentNodeId: string): string[] {
const rootUrl: string[] = currentURL.replace(currentNodeId, '').split('/');
rootUrl.pop();
return rootUrl;
}
private appendNextNodeIdToUrl(currentURL: string, nodeId: string): string[] {
const navigateToNodeUrl = currentURL.split('/');
if (nodeId && !this.isRootNode(nodeId)) {
navigateToNodeUrl.push(nodeId);
}
navigateToNodeUrl.shift();
return navigateToNodeUrl;
}
onUploadNewVersion(ev: CustomEvent) {
this.store.dispatch(new UploadFileVersionAction(ev));
}
navigateTo(node: NodeEntry) {
if (node?.entry) {
this.selectedNode = node;
const { isFolder } = node.entry;
if (isFolder) {
let id: string;
if (node.entry.nodeType === 'app:folderlink') {
id = node.entry.properties['cm:destination'];
} else {
id = node.entry.id;
}
this.documentList.resetNewFolderPagination();
this.navigate(id);
return;
}
this.showPreview(node, { location: this.router.url });
}
}
handleNodeClick(event: Event) {
this.navigateTo((event as CustomEvent).detail?.node);
}
onBreadcrumbNavigate(route: PathElement) {
this.documentList.resetNewFolderPagination();
// todo: review this approach once 5.2.3 is out
if (this.nodePath && this.nodePath?.length > 2) {
if (this.nodePath[1].name === 'Sites' && this.nodePath[2].id === route.id) {
return this.navigate(this.nodePath[3].id);
}
}
this.navigate(route.id);
}
onFileUploadedEvent(event: FileUploadEvent) {
const node: NodeEntry = event.file.data;
// check root and child nodes
if (node?.entry?.parentId === this.getParentNodeId()) {
this.reload(this.selectedNode);
return;
}
// check the child nodes to show dropped folder
if (event && event.file.options.parentId === this.getParentNodeId()) {
this.displayFolderParent(0, event.file.options.path);
return;
}
if (event?.file.options.parentId) {
if (this.nodePath) {
const correspondingNodePath = this.nodePath.find((pathItem) => pathItem.id === event.file.options.parentId);
// check if the current folder has the 'trigger-upload-folder' as one of its parents
if (correspondingNodePath) {
const correspondingIndex = this.nodePath.length - this.nodePath.indexOf(correspondingNodePath);
this.displayFolderParent(correspondingIndex, event.file.options.path);
}
}
}
}
displayFolderParent(index: number, filePath = '') {
const parentName = filePath.split('/').filter((el) => el)[index];
const currentFoldersDisplayed = (this.documentList.data.getRows() as ShareDataRow[]) || [];
const alreadyDisplayedParentFolder = currentFoldersDisplayed.find((row) => row.node.entry.isFolder && row.node.entry.name === parentName);
if (alreadyDisplayedParentFolder) {
return;
}
this.reload(this.selectedNode);
}
onContentCopied(nodes: NodeEntry[]) {
const newNode = nodes.find((node) => node?.entry?.parentId === this.getParentNodeId());
if (newNode) {
this.reload(this.selectedNode);
}
}
// todo: review this approach once 5.2.3 is out
private async updateCurrentNode(node: Node) {
this.nodePath = null;
if (node?.path?.elements) {
const elements = node.path.elements;
this.nodePath = elements.map((pathElement) => {
return { ...pathElement };
});
if (elements.length > 1) {
if (elements[1].name === 'User Homes') {
if (!this.isAdmin) {
elements.splice(0, 2);
}
} else if (elements[1].name === 'Sites') {
await this.normalizeSitePath(node);
}
}
}
this.node = node;
this.store.dispatch(new SetCurrentFolderAction(node));
}
// todo: review this approach once 5.2.3 is out
private async normalizeSitePath(node: Node) {
const elements = node.path.elements;
// remove 'Sites'
elements.splice(1, 1);
if (this.isSiteContainer(node)) {
// rename 'documentLibrary' entry to the target site display name
// clicking on the breadcrumb entry loads the site content
const parentNode = await this.contentApi.getNodeInfo(node.parentId).toPromise();
node.name = parentNode.properties['cm:title'] || parentNode.name;
// remove the site entry
elements.splice(1, 1);
} else {
// remove 'documentLibrary' in the middle of the path
const docLib = elements.findIndex((el) => el.name === 'documentLibrary');
if (docLib > -1) {
const siteFragment = elements[docLib - 1];
const siteNode = await this.contentApi.getNodeInfo(siteFragment.id).toPromise();
// apply Site Name to the parent fragment
siteFragment.name = siteNode.properties['cm:title'] || siteNode.name;
elements.splice(docLib, 1);
}
}
}
isSiteContainer(node: Node): boolean {
if (node?.aspectNames?.length > 0) {
return node.aspectNames.indexOf('st:siteContainer') >= 0;
}
return false;
}
isRootNode(nodeId: string): boolean {
if (this.node?.path?.elements?.length > 0) {
return this.node.path.elements[0].id === nodeId;
}
return false;
}
onFilterSelected(activeFilters: FilterSearch[]) {
if (activeFilters.length) {
this.showHeader = ShowHeaderMode.Always;
this.isFilterHeaderActive = true;
this.navigateToFilter(activeFilters);
} else {
void this.router.navigate(['.'], { relativeTo: this.route });
this.isFilterHeaderActive = false;
this.showHeader = ShowHeaderMode.Data;
this.onAllFilterCleared();
}
}
navigateToFilter(activeFilters: FilterSearch[]) {
const objectFromMap = {};
activeFilters.forEach((filter: FilterSearch) => {
let paramValue;
if (filter?.value?.from && filter?.value?.to) {
paramValue = `${filter.value.from}||${filter.value.to}`;
} else {
paramValue = filter.value;
}
objectFromMap[filter.key] = paramValue;
});
void this.router.navigate([], { relativeTo: this.route, queryParams: objectFromMap });
}
onError() {
this.isValidPath = false;
}
}