process-content.service.ts

/*!
 * @license
 * Copyright © 2005-2024 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 {
    ActivitiContentApi,
    RelatedContentRepresentation,
    ResultListDataRepresentationRelatedProcessTask,
    ResultListDataRepresentationRelatedContentRepresentation
} from '@alfresco/js-api';
import { Observable, from, throwError } from 'rxjs';
import { catchError } from 'rxjs/operators';

@Injectable({
    providedIn: 'root'
})
export class ProcessContentService {
    static UNKNOWN_ERROR_MESSAGE: string = 'Unknown error';
    static GENERIC_ERROR_MESSAGE: string = 'Server error';

    private _contentApi: ActivitiContentApi;
    get contentApi(): ActivitiContentApi {
        this._contentApi = this._contentApi ?? new ActivitiContentApi(this.apiService.getInstance());
        return this._contentApi;
    }

    constructor(private apiService: AlfrescoApiService) {}

    /**
     * Create temporary related content from an uploaded file.
     *
     * @param file File to use for content
     * @returns The created content data
     */
    createTemporaryRawRelatedContent(file: any): Observable<RelatedContentRepresentation> {
        return from(this.contentApi.createTemporaryRawRelatedContent(file)).pipe(catchError((err) => this.handleError(err)));
    }

    /**
     * Gets the metadata for a related content item.
     *
     * @param contentId ID of the content item
     * @returns Metadata for the content
     */
    getFileContent(contentId: number): Observable<RelatedContentRepresentation> {
        return from(this.contentApi.getContent(contentId)).pipe(catchError((err) => this.handleError(err)));
    }

    /**
     * Gets raw binary content data for a related content file.
     *
     * @param contentId ID of the related content
     * @returns Binary data of the related content
     */
    getFileRawContent(contentId: number): Observable<Blob> {
        return from(this.contentApi.getRawContent(contentId)).pipe(catchError((err) => this.handleError(err)));
    }

    /**
     * Gets the preview for a related content file.
     *
     * @param contentId ID of the related content
     * @returns Binary data of the content preview
     */
    getContentPreview(contentId: number): Observable<Blob> {
        return new Observable((observer) => {
            this.contentApi.getRawContent(contentId).then(
                (result) => {
                    observer.next(result);
                    observer.complete();
                },
                () => {
                    this.contentApi.getRawContent(contentId).then(
                        (data) => {
                            observer.next(data);
                            observer.complete();
                        },
                        (err) => {
                            observer.error(err);
                            observer.complete();
                        }
                    );
                }
            );
        });
    }

    /**
     * Gets a URL for direct access to a related content file.
     *
     * @param contentId ID of the related content
     * @returns URL to access the content
     */
    getFileRawContentUrl(contentId: number): string {
        return this.contentApi.getRawContentUrl(contentId);
    }

    /**
     * Gets the thumbnail for a related content file.
     *
     * @param contentId ID of the related content
     * @returns Binary data of the thumbnail image
     */
    getContentThumbnail(contentId: number): Observable<Blob> {
        return from(this.contentApi.getRawContent(contentId, 'thumbnail')).pipe(catchError((err) => this.handleError(err)));
    }

    /**
     * Gets related content items for a task instance.
     *
     * @param taskId ID of the target task
     * @param opts Options supported by JS-API
     * @returns Metadata for the content
     */
    getTaskRelatedContent(taskId: string, opts?: any): Observable<ResultListDataRepresentationRelatedContentRepresentation> {
        return from(this.contentApi.getRelatedContentForTask(taskId, opts)).pipe(catchError((err) => this.handleError(err)));
    }

    /**
     * Gets related content items for a process instance.
     *
     * @param processId ID of the target process
     * @param opts Options supported by JS-API
     * @returns Metadata for the content
     */
    getProcessRelatedContent(processId: string, opts?: any): Observable<ResultListDataRepresentationRelatedContentRepresentation> {
        return from(this.contentApi.getRelatedContentForProcessInstance(processId, opts)).pipe(catchError((err) => this.handleError(err)));
    }

    /**
     * Deletes related content.
     *
     * @param contentId Identifier of the content to delete
     * @returns Null response that notifies when the deletion is complete
     */
    deleteRelatedContent(contentId: number): Observable<any> {
        return from(this.contentApi.deleteContent(contentId)).pipe(catchError((err) => this.handleError(err)));
    }

    /**
     * Associates an uploaded file with a process instance.
     *
     * @param processInstanceId ID of the target process instance
     * @param content File to associate
     * @param opts Options supported by JS-API
     * @returns Details of created content
     */
    createProcessRelatedContent(processInstanceId: string, content: any, opts?: any): Observable<RelatedContentRepresentation> {
        return from(this.contentApi.createRelatedContentOnProcessInstance(processInstanceId, content, opts)).pipe(
            catchError((err) => this.handleError(err))
        );
    }

    /**
     * Associates an uploaded file with a task instance.
     *
     * @param taskId ID of the target task
     * @param file File to associate
     * @param opts Options supported by JS-API
     * @returns Details of created content
     */
    createTaskRelatedContent(taskId: string, file: any, opts?: any): Observable<RelatedContentRepresentation> {
        return from(this.contentApi.createRelatedContentOnTask(taskId, file, opts)).pipe(catchError((err) => this.handleError(err)));
    }

    /**
     * Lists processes and tasks on workflow started with provided document
     *
     * @param sourceId - id of the document that workflow or task has been started with
     * @param source - source of the document that workflow or task has been started with
     * @param size - size of the entries to get
     * @param page - page number
     * @returns Promise<ResultListDataRepresentationRelatedProcessTask>
     */
    getProcessesAndTasksOnContent(
        sourceId: string,
        source: string,
        size?: number,
        page?: number
    ): Observable<ResultListDataRepresentationRelatedProcessTask> {
        return from(this.contentApi.getProcessesAndTasksOnContent(sourceId, source, size, page)).pipe(catchError((err) => this.handleError(err)));
    }

    /**
     * Creates a JSON representation of data.
     *
     * @param res Object representing data
     * @returns JSON object
     */
    toJson(res: any) {
        if (res) {
            return res || {};
        }
        return {};
    }

    /**
     * Creates a JSON array representation of data.
     *
     * @param res Object representing data
     * @returns JSON array object
     */
    toJsonArray(res: any) {
        if (res) {
            return res.data || [];
        }
        return [];
    }

    /**
     * Reports an error message.
     *
     * @param error Data object with optional `message` and `status` fields for the error
     * @returns Callback when an error occurs
     */
    handleError(error: any): Observable<any> {
        let errMsg = ProcessContentService.UNKNOWN_ERROR_MESSAGE;
        if (error) {
            errMsg = error.message
                ? error.message
                : error.status
                ? `${error.status} - ${error.statusText}`
                : ProcessContentService.GENERIC_ERROR_MESSAGE;
        }
        return throwError(errMsg);
    }
}