alfresco-ng2-components/lib/process-services/src/lib/task-list/services/tasklist.service.ts

/*!
 * @license
 * Copyright © 2005-2023 Hyland Software, Inc. and its affiliates. All rights reserved.
 *
 * 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 } from '@alfresco/adf-core';
import { Injectable } from '@angular/core';
import { Observable, from, 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,
    TaskUpdateRepresentation, ModelsApi, TaskActionsApi, TasksApi,
    ChecklistsApi
} from '@alfresco/js-api';

@Injectable({
    providedIn: 'root'
})
export class TaskListService {
    private _modelsApi: ModelsApi;
    get modelsApi(): ModelsApi {
        this._modelsApi = this._modelsApi ?? new ModelsApi(this.apiService.getInstance());
        return this._modelsApi;
    }

    private _tasksApi: TasksApi;
    get tasksApi(): TasksApi {
        this._tasksApi = this._tasksApi ?? new TasksApi(this.apiService.getInstance());
        return this._tasksApi;
    }

    private _taskActionsApi: TaskActionsApi;
    get taskActionsApi(): TaskActionsApi {
        this._taskActionsApi = this._taskActionsApi ?? new TaskActionsApi(this.apiService.getInstance());
        return this._taskActionsApi;
    }

    private _checklistsApi: ChecklistsApi;
    get checklistsApi(): ChecklistsApi {
        this._checklistsApi = this._checklistsApi ?? new ChecklistsApi(this.apiService.getInstance());
        return this._checklistsApi;
    }

    constructor(private apiService: AlfrescoApiService) {
    }

    /**
     * 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)
            );
    }

    /**
     * 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> {
        const requestNodeForFilter = this.generateTaskRequestNodeFromFilter(filterModel);
        return from(this.callApiTasksFiltered(requestNodeForFilter))
            .pipe(
                map(res => res.data.find((element) => element.id === taskId) ? filterModel : null)
            );
    }

    /**
     * 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));
    }

    /**
     * Gets tasks matching a query and state value.
     *
     * @param requestNode Query to search for tasks
     * @param state Task state. Can be "open" or "completed". State "all" applies to both "open" and "completed" tasks.
     * @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". State "all" applies to both "open" and "completed" tasks.
     * @returns List of tasks
     */
    findAllTasksByState(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 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 => new TaskDetailsModel(details))
            );
    }

    /**
     * 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 => {
                    const checklists: TaskDetailsModel[] = [];
                    response.data.forEach((checklist) => {
                        checklists.push(new TaskDetailsModel(checklist));
                    });
                    return checklists;
                })
            );
    }

    /**
     * Gets all available reusable forms.
     *
     * @returns Array of form details
     */
    getFormList(): Observable<Form[]> {
        const opts = {
            filter: 'myReusableForms', // String | filter
            sort: 'modifiedDesc', // String | sort
            modelType: 2 // Integer | modelType
        };

        return from(this.modelsApi.getModels(opts))
            .pipe(
                map(response => {
                    const forms: Form[] = [];
                    response.data.forEach((form) => {
                        forms.push(new Form(form.id, form.name));
                    });
                    return forms;
                })
            );
    }

    /**
     * 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.taskActionsApi.attachForm(taskId, { formId }));
    }

    /**
     * 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) => new TaskDetailsModel(response))
            );
    }

    /**
     * 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(this.callApiDeleteTask(taskId));
    }

    /**
     * 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(this.callApiDeleteForm(taskId));
    }

    /**
     * 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.taskActionsApi.completeTask(taskId));
    }

    /**
     * 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<TaskListModel> {
        requestNode.size = 0;
        return from(this.callApiTasksFiltered(requestNode));
    }

    /**
     * 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) => new TaskDetailsModel(response))
            );
    }

    /**
     * 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> {
        const assignee = { assignee: requestNode.id };
        return from(this.callApiAssignTask(taskId, assignee))
            .pipe(
                map((response) => new TaskDetailsModel(response))
            );
    }

    /**
     * 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 = { assignee: userId };

        return from(this.callApiAssignTask(taskId, assignee))
            .pipe(
                map((response) => new TaskDetailsModel(response))
            );
    }

    /**
     * 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(this.taskActionsApi.claimTask(taskId));
    }

    /**
     * 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(this.taskActionsApi.unclaimTask(taskId));
    }

    /**
     * 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: string, updated: TaskUpdateRepresentation): Observable<TaskDetailsModel> {
        return from(this.tasksApi.updateTask(taskId, updated))
            .pipe(
                map((result) => result as TaskDetailsModel)
            );
    }

    /**
     * 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.tasksApi.getTaskAuditPdf(taskId));
    }

    /**
     * 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.tasksApi.getTaskAuditLog(taskId));
    }

    /**
     * Gets the search query for a task based on the supplied filter.
     *
     * @param filterModel The filter to use
     * @returns The search query
     */
     private generateTaskRequestNodeFromFilter(filterModel: FilterRepresentationModel): TaskQueryRequestRepresentationModel {
        const requestNode = {
            appDefinitionId: filterModel.appId,
            assignment: filterModel.filter.assignment,
            state: filterModel.filter.state,
            sort: filterModel.filter.sort
        };
        return new TaskQueryRequestRepresentationModel(requestNode);
    }

    private callApiTasksFiltered(requestNode: TaskQueryRepresentation): Promise<TaskListModel> {
        return this.tasksApi.listTasks(requestNode);
    }

    private callApiTaskDetails(taskId: string): Promise<TaskDetailsModel> {
        return this.tasksApi.getTask(taskId);
    }

    private callApiAddTask(task: TaskDetailsModel): Promise<TaskDetailsModel> {
        return this.checklistsApi.addSubtask(task.parentTaskId, task);
    }

    private callApiDeleteTask(taskId: string): Promise<any> {
        return this.tasksApi.deleteTask(taskId);
    }

    private callApiDeleteForm(taskId: string): Promise<any> {
        return this.taskActionsApi.removeForm(taskId);
    }

    private callApiTaskChecklist(taskId: string): Promise<TaskListModel> {
        return this.checklistsApi.getChecklist(taskId);
    }

    private callApiCreateTask(task: TaskDetailsModel): Promise<TaskDetailsModel> {
        return this.tasksApi.createNewTask(task);
    }

    private callApiAssignTask(taskId: string, requestNode: AssigneeIdentifierRepresentation): Promise<TaskDetailsModel> {
        return this.taskActionsApi.assignTask(taskId, requestNode);
    }
}