mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
437 lines
15 KiB
TypeScript
437 lines
15 KiB
TypeScript
/*!
|
|
* @license
|
|
* Copyright 2019 Alfresco Software, Ltd.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
import { AlfrescoApiService, LogService } from '@alfresco/adf-core';
|
|
import { Injectable } from '@angular/core';
|
|
import { Observable, from, forkJoin, throwError, of } from 'rxjs';
|
|
import { map, catchError, switchMap, flatMap, filter } from 'rxjs/operators';
|
|
import { FilterRepresentationModel, TaskQueryRequestRepresentationModel } from '../models/filter.model';
|
|
import { Form } from '../models/form.model';
|
|
import { TaskDetailsModel } from '../models/task-details.model';
|
|
import { TaskListModel } from '../models/task-list.model';
|
|
import {
|
|
TaskQueryRepresentation,
|
|
AssigneeIdentifierRepresentation
|
|
} from '@alfresco/js-api';
|
|
|
|
@Injectable({
|
|
providedIn: 'root'
|
|
})
|
|
export class TaskListService {
|
|
|
|
constructor(private apiService: AlfrescoApiService,
|
|
private logService: LogService) {
|
|
}
|
|
|
|
/**
|
|
* Gets all the filters in the list that belong to a task.
|
|
* @param taskId ID of the target task
|
|
* @param filterList List of filters to search through
|
|
* @returns Filters belonging to the task
|
|
*/
|
|
getFilterForTaskById(taskId: string, filterList: FilterRepresentationModel[]): Observable<FilterRepresentationModel> {
|
|
return from(filterList)
|
|
.pipe(
|
|
flatMap((data: FilterRepresentationModel) => this.isTaskRelatedToFilter(taskId, data)),
|
|
filter((data: FilterRepresentationModel) => data != null)
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Gets the search query for a task based on the supplied filter.
|
|
* @param filter The filter to use
|
|
* @returns The search query
|
|
*/
|
|
private generateTaskRequestNodeFromFilter(filterModel: FilterRepresentationModel): TaskQueryRequestRepresentationModel {
|
|
let requestNode = {
|
|
appDefinitionId: filterModel.appId,
|
|
assignment: filterModel.filter.assignment,
|
|
state: filterModel.filter.state,
|
|
sort: filterModel.filter.sort
|
|
};
|
|
return new TaskQueryRequestRepresentationModel(requestNode);
|
|
}
|
|
|
|
/**
|
|
* Checks if a taskId is filtered with the given filter.
|
|
* @param taskId ID of the target task
|
|
* @param filterModel The filter you want to check
|
|
* @returns The filter if it is related or null otherwise
|
|
*/
|
|
isTaskRelatedToFilter(taskId: string, filterModel: FilterRepresentationModel): Observable<FilterRepresentationModel> {
|
|
let requestNodeForFilter = this.generateTaskRequestNodeFromFilter(filterModel);
|
|
return from(this.callApiTasksFiltered(requestNodeForFilter))
|
|
.pipe(
|
|
map((res: any) => {
|
|
return res.data.find((element) => element.id === taskId) ? filterModel : null;
|
|
}),
|
|
catchError((err) => this.handleError(err))
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Gets all the tasks matching the supplied query.
|
|
* @param requestNode Query to search for tasks
|
|
* @returns List of tasks
|
|
*/
|
|
getTasks(requestNode: TaskQueryRequestRepresentationModel): Observable<TaskListModel> {
|
|
return from(this.callApiTasksFiltered(requestNode))
|
|
.pipe(
|
|
catchError((err) => this.handleError(err))
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Gets tasks matching a query and state value.
|
|
* @param requestNode Query to search for tasks
|
|
* @param state Task state. Can be "open" or "completed".
|
|
* @returns List of tasks
|
|
*/
|
|
findTasksByState(requestNode: TaskQueryRequestRepresentationModel, state?: string): Observable<TaskListModel> {
|
|
if (state) {
|
|
requestNode.state = state;
|
|
}
|
|
return this.getTasks(requestNode)
|
|
.pipe(catchError(() => of(new TaskListModel())));
|
|
}
|
|
|
|
/**
|
|
* Gets all tasks matching a query and state value.
|
|
* @param requestNode Query to search for tasks.
|
|
* @param state Task state. Can be "open" or "completed".
|
|
* @returns List of tasks
|
|
*/
|
|
findAllTaskByState(requestNode: TaskQueryRequestRepresentationModel, state?: string): Observable<TaskListModel> {
|
|
if (state) {
|
|
requestNode.state = state;
|
|
}
|
|
return this.getTotalTasks(requestNode)
|
|
.pipe(
|
|
switchMap((res: any) => {
|
|
requestNode.size = res.total;
|
|
return this.getTasks(requestNode);
|
|
})
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Gets all tasks matching the supplied query but ignoring the task state.
|
|
* @param requestNode Query to search for tasks
|
|
* @returns List of tasks
|
|
*/
|
|
findAllTasksWithoutState(requestNode: TaskQueryRequestRepresentationModel): Observable<TaskListModel> {
|
|
return forkJoin(
|
|
this.findTasksByState(requestNode, 'open'),
|
|
this.findAllTaskByState(requestNode, 'completed'),
|
|
(activeTasks: TaskListModel, completedTasks: TaskListModel) => {
|
|
const tasks = Object.assign({}, activeTasks);
|
|
tasks.total += completedTasks.total;
|
|
tasks.data = tasks.data.concat(completedTasks.data);
|
|
return tasks;
|
|
}
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Gets details for a task.
|
|
* @param taskId ID of the target task.
|
|
* @returns Task details
|
|
*/
|
|
getTaskDetails(taskId: string): Observable<TaskDetailsModel> {
|
|
return from(this.callApiTaskDetails(taskId))
|
|
.pipe(
|
|
map((details: any) => {
|
|
return new TaskDetailsModel(details);
|
|
}),
|
|
catchError((err) => this.handleError(err))
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Gets the checklist for a task.
|
|
* @param id ID of the target task
|
|
* @returns Array of checklist task details
|
|
*/
|
|
getTaskChecklist(id: string): Observable<TaskDetailsModel[]> {
|
|
return from(this.callApiTaskChecklist(id))
|
|
.pipe(
|
|
map((response: any) => {
|
|
const checklists: TaskDetailsModel[] = [];
|
|
response.data.forEach((checklist) => {
|
|
checklists.push(new TaskDetailsModel(checklist));
|
|
});
|
|
return checklists;
|
|
}),
|
|
catchError((err) => this.handleError(err))
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Gets all available reusable forms.
|
|
* @returns Array of form details
|
|
*/
|
|
getFormList(): Observable<Form[]> {
|
|
let opts = {
|
|
'filter': 'myReusableForms', // String | filter
|
|
'sort': 'modifiedDesc', // String | sort
|
|
'modelType': 2 // Integer | modelType
|
|
};
|
|
|
|
return from(this.apiService.getInstance().activiti.modelsApi.getModels(opts))
|
|
.pipe(
|
|
map((response: any) => {
|
|
let forms: Form[] = [];
|
|
response.data.forEach((form) => {
|
|
forms.push(new Form(form.id, form.name));
|
|
});
|
|
return forms;
|
|
}),
|
|
catchError((err) => this.handleError(err))
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Attaches a form to a task.
|
|
* @param taskId ID of the target task
|
|
* @param formId ID of the form to add
|
|
* @returns Null response notifying when the operation is complete
|
|
*/
|
|
attachFormToATask(taskId: string, formId: number): Observable<any> {
|
|
return from(this.apiService.taskApi.attachForm(taskId, { 'formId': formId }))
|
|
.pipe(
|
|
catchError((err) => this.handleError(err))
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Adds a subtask (ie, a checklist task) to a parent task.
|
|
* @param task The task to add
|
|
* @returns The subtask that was added
|
|
*/
|
|
addTask(task: TaskDetailsModel): Observable<TaskDetailsModel> {
|
|
return from(this.callApiAddTask(task))
|
|
.pipe(
|
|
map((response: TaskDetailsModel) => {
|
|
return new TaskDetailsModel(response);
|
|
}),
|
|
catchError((err) => this.handleError(err))
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Deletes a subtask (ie, a checklist task) from a parent task.
|
|
* @param taskId The task to delete
|
|
* @returns Null response notifying when the operation is complete
|
|
*/
|
|
deleteTask(taskId: string): Observable<TaskDetailsModel> {
|
|
return from<TaskDetailsModel>(this.callApiDeleteTask(taskId))
|
|
.pipe(
|
|
catchError((err) => this.handleError(err))
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Deletes a form from a task.
|
|
* @param taskId Task id related to form
|
|
* @returns Null response notifying when the operation is complete
|
|
*/
|
|
deleteForm(taskId: string): Observable<TaskDetailsModel> {
|
|
return from<TaskDetailsModel>(this.callApiDeleteForm(taskId))
|
|
.pipe(
|
|
catchError((err) => this.handleError(err))
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Gives completed status to a task.
|
|
* @param taskId ID of the target task
|
|
* @returns Null response notifying when the operation is complete
|
|
*/
|
|
completeTask(taskId: string) {
|
|
return from(this.apiService.taskApi.completeTask(taskId))
|
|
.pipe(
|
|
catchError((err) => this.handleError(err))
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Gets the total number of the tasks found by a query.
|
|
* @param requestNode Query to search for tasks
|
|
* @returns Number of tasks
|
|
*/
|
|
public getTotalTasks(requestNode: TaskQueryRequestRepresentationModel): Observable<any> {
|
|
requestNode.size = 0;
|
|
return from(this.callApiTasksFiltered(requestNode))
|
|
.pipe(
|
|
map((res: any) => {
|
|
return res;
|
|
}),
|
|
catchError((err) => this.handleError(err))
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Creates a new standalone task.
|
|
* @param task Details of the new task
|
|
* @returns Details of the newly created task
|
|
*/
|
|
createNewTask(task: TaskDetailsModel): Observable<TaskDetailsModel> {
|
|
return from(this.callApiCreateTask(task))
|
|
.pipe(
|
|
map((response: TaskDetailsModel) => {
|
|
return new TaskDetailsModel(response);
|
|
}),
|
|
catchError((err) => this.handleError(err))
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Assigns a task to a user or group.
|
|
* @param taskId The task to assign
|
|
* @param requestNode User or group to assign the task to
|
|
* @returns Details of the assigned task
|
|
*/
|
|
assignTask(taskId: string, requestNode: any): Observable<TaskDetailsModel> {
|
|
let assignee = { assignee: requestNode.id };
|
|
return from(this.callApiAssignTask(taskId, assignee))
|
|
.pipe(
|
|
map((response: TaskDetailsModel) => {
|
|
return new TaskDetailsModel(response);
|
|
}),
|
|
catchError((err) => this.handleError(err))
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Assigns a task to a user.
|
|
* @param taskId ID of the task to assign
|
|
* @param userId ID of the user to assign the task to
|
|
* @returns Details of the assigned task
|
|
*/
|
|
assignTaskByUserId(taskId: string, userId: string): Observable<TaskDetailsModel> {
|
|
const assignee = <AssigneeIdentifierRepresentation> { assignee: userId };
|
|
return from(this.callApiAssignTask(taskId, assignee))
|
|
.pipe(
|
|
map((response: TaskDetailsModel) => {
|
|
return new TaskDetailsModel(response);
|
|
}),
|
|
catchError((err) => this.handleError(err))
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Claims a task for the current user.
|
|
* @param taskId ID of the task to claim
|
|
* @returns Details of the claimed task
|
|
*/
|
|
claimTask(taskId: string): Observable<TaskDetailsModel> {
|
|
return from<TaskDetailsModel>(this.apiService.taskApi.claimTask(taskId))
|
|
.pipe(
|
|
catchError((err) => this.handleError(err))
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Un-claims a task for the current user.
|
|
* @param taskId ID of the task to unclaim
|
|
* @returns Null response notifying when the operation is complete
|
|
*/
|
|
unclaimTask(taskId: string): Observable<TaskDetailsModel> {
|
|
return from<TaskDetailsModel>(this.apiService.taskApi.unclaimTask(taskId))
|
|
.pipe(
|
|
catchError((err) => this.handleError(err))
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Updates the details (name, description, due date) for a task.
|
|
* @param taskId ID of the task to update
|
|
* @param updated Data to update the task (as a `TaskUpdateRepresentation` instance).
|
|
* @returns Updated task details
|
|
*/
|
|
updateTask(taskId: any, updated): Observable<TaskDetailsModel> {
|
|
return from(this.apiService.taskApi.updateTask(taskId, updated))
|
|
.pipe(
|
|
map((result) => <TaskDetailsModel> result),
|
|
catchError((err) => this.handleError(err))
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Fetches the Task Audit information in PDF format.
|
|
* @param taskId ID of the target task
|
|
* @returns Binary PDF data
|
|
*/
|
|
fetchTaskAuditPdfById(taskId: string): Observable<Blob> {
|
|
return from(this.apiService.taskApi.getTaskAuditPdf(taskId))
|
|
.pipe(
|
|
map((data) => <Blob> data),
|
|
catchError((err) => this.handleError(err))
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Fetch the Task Audit information in JSON format
|
|
* @param taskId ID of the target task
|
|
* @returns JSON data
|
|
*/
|
|
fetchTaskAuditJsonById(taskId: string): Observable<any> {
|
|
return from(this.apiService.taskApi.getTaskAuditJson(taskId))
|
|
.pipe(
|
|
catchError((err) => this.handleError(err))
|
|
);
|
|
}
|
|
|
|
private callApiTasksFiltered(requestNode: TaskQueryRepresentation): Promise<TaskListModel> {
|
|
return this.apiService.taskApi.listTasks(requestNode);
|
|
}
|
|
|
|
private callApiTaskDetails(taskId: string): Promise<TaskDetailsModel> {
|
|
return this.apiService.taskApi.getTask(taskId);
|
|
}
|
|
|
|
private callApiAddTask(task: TaskDetailsModel): Promise<TaskDetailsModel> {
|
|
return this.apiService.taskApi.addSubtask(task.parentTaskId, task);
|
|
}
|
|
|
|
private callApiDeleteTask(taskId: string): Promise<any> {
|
|
return this.apiService.taskApi.deleteTask(taskId);
|
|
}
|
|
|
|
private callApiDeleteForm(taskId: string): Promise<any> {
|
|
return this.apiService.taskApi.removeForm(taskId);
|
|
}
|
|
|
|
private callApiTaskChecklist(taskId: string): Promise<TaskListModel> {
|
|
return this.apiService.taskApi.getChecklist(taskId);
|
|
}
|
|
|
|
private callApiCreateTask(task: TaskDetailsModel): Promise<TaskDetailsModel> {
|
|
return this.apiService.taskApi.createNewTask(task);
|
|
}
|
|
|
|
private callApiAssignTask(taskId: string, requestNode: AssigneeIdentifierRepresentation): Promise<TaskDetailsModel> {
|
|
return this.apiService.taskApi.assignTask(taskId, requestNode);
|
|
}
|
|
|
|
private handleError(error: any) {
|
|
this.logService.error(error);
|
|
return throwError(error || 'Server error');
|
|
}
|
|
|
|
}
|