Add process audit directive (#2188)

demo-shell-ng2/app/components/activiti/activiti-demo.component.html

@@ -162,6 +162,18 @@
                                 (taskClick)="onProcessDetailsTaskClick($event)">
                             </activiti-process-instance-details>
                             <hr>
+                            <div *ngIf="currentProcessInstanceId">
+                                Process Audit log
+                                <button adf-process-audit
+                                    [process-id]="currentProcessInstanceId"
+                                    [download]="true" md-icon-button
+                                    [format]="'pdf'"
+                                    (clicked)="onAuditClick($event)"
+                                    (error)="onAuditError($event)">
+                                    <md-icon>assignment_ind</md-icon>
+                                </button>
+                                <hr>
+                            </div>
                             <md-card>
                                 <md-card-content>
                                     <activiti-process-attachments

ng2-components/ng2-activiti-processlist/README.md

@@ -35,6 +35,9 @@
 - [Create Process Attachment component](#create-process-attachment-component)
   * [Properties](#properties-8)
   * [Events](#events-7)
+- [Process Audit Directive](#process-audit-directive)
+  * [Properties](#properties-9)
+  * [Events](#events-8)
 - [Build from sources](#build-from-sources)
 - [NPM scripts](#npm-scripts)
 - [Demo](#demo)
@@ -345,6 +348,39 @@ This component displays Upload Component(Drag and Click) to upload the attachmen
 | error | Raised when the error occurred while creating/uploading the attachment by the user from within the component |
 | success | Raised when the attachment created/uploaded successfully from within the component |
 
+## Process Audit Directive
+
+This directive provide a way to fetch the Process Audit information in the pdf or json format.
+
+```html
+<button
+    adf-process-audit
+    [process-id]="processId"
+    [format]="'pdf'"
+    [download]="true"
+    md-icon-button (clicked)="onAuditClick($event)" (error)="onAuditError($event)" >
+    <md-icon>assignment_ind</md-icon>
+</button>
+```
+
+![adf-process-audit-directive](docs/assets/adf-process-audit-directive.png)
+
+### Properties
+
+| Name | Type | Default | Description |
+| --- | --- | --- | --- |
+| taskId | string | | (**required**) The id of the task. |
+| format | string | pdf | In whitch format you want the task audit information (pdf or json). |
+| download | boolean | false | True If you want download the file on the click event. |
+| fileName | string | Audit | Represent the name of the file to download in case the format is pdf. |
+
+#### Events
+
+| Name | Description |
+| --- | --- |
+| clicked | Raised when the task audit info is ready |
+| error | Raised if there is an error during fetching task information |
+
 ## Build from sources
 
 You can build component from sources with the following commands:

ng2-components/ng2-activiti-processlist/index.ts

@@ -32,6 +32,7 @@ import { ProcessAttachmentListComponent } from './src/components/process-attachm
 import { ProcessCommentsComponent } from './src/components/process-comments.component';
 import { ProcessFiltersComponent } from './src/components/process-filters.component';
 import { ProcessInstanceDetailsComponent } from './src/components/process-instance-details.component';
+import { ProcessAuditDirective } from './src/components/process-audit.directive';
 import { ProcessInstanceHeaderComponent } from './src/components/process-instance-header.component';
 import { ProcessInstanceTasksComponent } from './src/components/process-instance-tasks.component';
 import { ProcessInstanceVariablesComponent } from './src/components/process-instance-variables.component';
@@ -41,6 +42,7 @@ export {ProcessAttachmentListComponent} from './src/components/process-attachmen
 export {ProcessCommentsComponent} from './src/components/process-comments.component';
 export {ProcessFiltersComponent} from './src/components/process-filters.component';
 export {ProcessInstanceDetailsComponent} from './src/components/process-instance-details.component';
+export {ProcessAuditDirective} from './src/components/process-audit.directive';
 export {ProcessInstanceHeaderComponent} from './src/components/process-instance-header.component';
 export {ProcessInstanceTasksComponent} from './src/components/process-instance-tasks.component';
 export {ProcessInstanceVariablesComponent} from './src/components/process-instance-variables.component';
@@ -87,6 +89,7 @@ export const ACTIVITI_PROCESSLIST_DIRECTIVES: [any] = [
     ProcessInstanceListComponent,
     ProcessFiltersComponent,
     ProcessInstanceDetailsComponent,
+    ProcessAuditDirective,
     ProcessInstanceHeaderComponent,
     ProcessInstanceTasksComponent,
     ProcessInstanceVariablesComponent,

ng2-components/ng2-activiti-processlist/src/components/process-audit.directive.spec.ts

@@ -0,0 +1,178 @@
+/*!
+ * @license
+ * Copyright 2016 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 { Component } from '@angular/core';
+import {
+    async,
+    ComponentFixture,
+    fakeAsync,
+    TestBed
+} from '@angular/core/testing';
+import { CoreModule } from 'ng2-alfresco-core';
+import { Observable } from 'rxjs/Rx';
+import { ProcessService } from './../services/process.service';
+import { ProcessAuditDirective } from './process-audit.directive';
+
+declare let jasmine: any;
+
+describe('ProcessAuditDirective', () => {
+
+    let fixture: ComponentFixture<BasicButtonComponent>;
+    let component: BasicButtonComponent;
+    let service: ProcessService;
+
+    function createFakePdfBlob(): Blob {
+        let pdfData = atob(
+            'JVBERi0xLjcKCjEgMCBvYmogICUgZW50cnkgcG9pbnQKPDwKICAvVHlwZSAvQ2F0YWxvZwog' +
+            'IC9QYWdlcyAyIDAgUgo+PgplbmRvYmoKCjIgMCBvYmoKPDwKICAvVHlwZSAvUGFnZXMKICAv' +
+            'TWVkaWFCb3ggWyAwIDAgMjAwIDIwMCBdCiAgL0NvdW50IDEKICAvS2lkcyBbIDMgMCBSIF0K' +
+            'Pj4KZW5kb2JqCgozIDAgb2JqCjw8CiAgL1R5cGUgL1BhZ2UKICAvUGFyZW50IDIgMCBSCiAg' +
+            'L1Jlc291cmNlcyA8PAogICAgL0ZvbnQgPDwKICAgICAgL0YxIDQgMCBSIAogICAgPj4KICA+' +
+            'PgogIC9Db250ZW50cyA1IDAgUgo+PgplbmRvYmoKCjQgMCBvYmoKPDwKICAvVHlwZSAvRm9u' +
+            'dAogIC9TdWJ0eXBlIC9UeXBlMQogIC9CYXNlRm9udCAvVGltZXMtUm9tYW4KPj4KZW5kb2Jq' +
+            'Cgo1IDAgb2JqICAlIHBhZ2UgY29udGVudAo8PAogIC9MZW5ndGggNDQKPj4Kc3RyZWFtCkJU' +
+            'CjcwIDUwIFRECi9GMSAxMiBUZgooSGVsbG8sIHdvcmxkISkgVGoKRVQKZW5kc3RyZWFtCmVu' +
+            'ZG9iagoKeHJlZgowIDYKMDAwMDAwMDAwMCA2NTUzNSBmIAowMDAwMDAwMDEwIDAwMDAwIG4g' +
+            'CjAwMDAwMDAwNzkgMDAwMDAgbiAKMDAwMDAwMDE3MyAwMDAwMCBuIAowMDAwMDAwMzAxIDAw' +
+            'MDAwIG4gCjAwMDAwMDAzODAgMDAwMDAgbiAKdHJhaWxlcgo8PAogIC9TaXplIDYKICAvUm9v' +
+            'dCAxIDAgUgo+PgpzdGFydHhyZWYKNDkyCiUlRU9G');
+        return new Blob([pdfData], {type: 'application/pdf'});
+    }
+
+    beforeEach(async(() => {
+        TestBed.configureTestingModule({
+            imports: [CoreModule.forRoot()],
+            declarations: [BasicButtonComponent, ProcessAuditDirective],
+            providers: [ProcessService]
+        });
+
+        TestBed.compileComponents();
+
+        fixture = TestBed.createComponent(BasicButtonComponent);
+        component = fixture.componentInstance;
+        service = TestBed.get(ProcessService);
+
+        jasmine.Ajax.install();
+    }));
+
+    afterEach(() => {
+        jasmine.Ajax.uninstall();
+    });
+
+    it('should fetch the pdf Blob when the format is pdf', fakeAsync(() => {
+        component.fileName = 'FakeAuditName';
+        component.format = 'pdf';
+        let blob = createFakePdfBlob();
+        spyOn(service, 'fetchProcessAuditPdfById').and.returnValue(Observable.of(blob));
+        spyOn(component, 'onAuditClick').and.callThrough();
+
+        fixture.detectChanges();
+
+        let button = fixture.nativeElement.querySelector('#auditButton');
+
+        fixture.whenStable().then(() => {
+            fixture.detectChanges();
+            expect(component.onAuditClick).toHaveBeenCalledWith({ format: 'pdf', value: blob, fileName: 'FakeAuditName' });
+        });
+
+        button.click();
+
+    }));
+
+    it('should fetch the json info when the format is json', fakeAsync(() => {
+        component.fileName = 'FakeAuditName';
+        component.format = 'json';
+        component.download = true;
+        const auditJson = {
+            processInstanceId: 42516, processInstanceName: 'Fake Process - August 3rd 2017',
+            processDefinitionName: 'Claim Approval Process', processDefinitionVersion: 1, processInstanceStartTime: 'Thu Aug 03 15:32:47 UTC 2017', processInstanceEndTime: null,
+            processInstanceDurationInMillis: null,
+            processInstanceInitiator: 'MyName MyLastname',
+            entries: [{
+                index: 1, type: 'startForm',
+                selectedOutcome: null, formData: [{
+                    fieldName: 'User Name',
+                    fieldId: 'username', value: 'dsassd'
+                },
+                { fieldName: 'Claim Amount', fieldId: 'claimamount', value: '22' }], taskName: null, taskAssignee: null, activityId: null,
+                activityName: null, activityType: null, startTime: null, endTime: null, durationInMillis: null
+            }
+            ], decisionInfo: { calculatedValues: [], appliedRules: [] }
+        };
+        spyOn(service, 'fetchProcessAuditJsonById').and.returnValue(Observable.of(auditJson));
+        spyOn(component, 'onAuditClick').and.callThrough();
+
+        fixture.detectChanges();
+
+        let button = fixture.nativeElement.querySelector('#auditButton');
+
+        fixture.whenStable().then(() => {
+            fixture.detectChanges();
+            expect(component.onAuditClick).toHaveBeenCalledWith({ format: 'json', value: auditJson, fileName: 'FakeAuditName' });
+        });
+
+        button.click();
+
+    }));
+
+    it('should fetch the pdf Blob as default when the format is UNKNOW', fakeAsync(() => {
+        component.fileName = 'FakeAuditName';
+        component.format = 'fakeFormat';
+        let blob = createFakePdfBlob();
+        spyOn(service, 'fetchProcessAuditPdfById').and.returnValue(Observable.of(blob));
+        spyOn(component, 'onAuditClick').and.callThrough();
+
+        fixture.detectChanges();
+
+        let button = fixture.nativeElement.querySelector('#auditButton');
+
+        fixture.whenStable().then(() => {
+            fixture.detectChanges();
+            expect(component.onAuditClick).toHaveBeenCalledWith({ format: 'pdf', value: blob, fileName: 'FakeAuditName' });
+        });
+
+        button.click();
+
+    }));
+
+});
+
+@Component({
+    selector: 'adf-basic-button',
+    template: `
+    <button id="auditButton"
+        adf-process-audit
+        [process-id]="currentProcessId"
+        [download]="download"
+        [fileName]="fileName"
+        [format]="format"
+        (clicked)="onAuditClick($event)">My button
+    </button>`
+})
+class BasicButtonComponent {
+
+    download: boolean = false;
+    fileName: string;
+    format: string;
+    constructor() {
+
+    }
+
+    onAuditClick(event: any) {
+        console.log(event);
+    }
+}

ng2-components/ng2-activiti-processlist/src/components/process-audit.directive.ts

@@ -0,0 +1,123 @@
+/*!
+ * @license
+ * Copyright 2016 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 { Directive, EventEmitter, Input, OnChanges, OnInit, Output, SimpleChanges } from '@angular/core';
+import { ContentService } from 'ng2-alfresco-core';
+import { ProcessService } from './../services/process.service';
+
+const JSON_FORMAT: string = 'json';
+const PDF_FORMAT: string = 'pdf';
+
+@Directive({
+    selector: 'button[adf-process-audit]',
+    host: {
+        'role': 'button',
+        '(click)': 'onClickAudit()'
+    }
+})
+export class ProcessAuditDirective implements OnInit, OnChanges {
+
+    @Input('process-id')
+    processId: string;
+
+    @Input()
+    fileName: string = 'Audit';
+
+    @Input()
+    format: string = 'pdf';
+
+    @Input()
+    download: boolean = true;
+
+    @Output()
+    clicked: EventEmitter<any> = new EventEmitter<any>();
+
+    @Output()
+    error: EventEmitter<any> = new EventEmitter<any>();
+
+    public audit: any;
+
+    /**
+     *
+     * @param translateService
+     * @param processListService
+     */
+    constructor(private contentService: ContentService,
+                private processListService: ProcessService) {
+    }
+
+    ngOnInit() {
+        console.log('OnInit');
+    }
+    ngOnChanges(changes: SimpleChanges): void {
+        if (!this.isValidType()) {
+            this.setDefaultFormatType();
+        }
+    }
+
+    isValidType() {
+        if (this.format && (this.isJsonFormat() || this.isPdfFormat())) {
+            return true;
+        }
+        return false;
+    }
+
+    setDefaultFormatType(): void {
+        this.format = PDF_FORMAT;
+    }
+
+    /**
+     * fetch the audit information in the requested format
+     */
+    fetchAuditInfo(): void {
+        if (this.isPdfFormat()) {
+            this.processListService.fetchProcessAuditPdfById(this.processId).subscribe(
+                (blob: Blob) => {
+                    this.audit = blob;
+                    if (this.download) {
+                        this.contentService.downloadBlob(this.audit, this.fileName + '.pdf');
+                    }
+                    this.clicked.emit({ format: this.format, value: this.audit, fileName: this.fileName });
+                },
+                (err) => {
+                    this.error.emit(err);
+                });
+        } else {
+            this.processListService.fetchProcessAuditJsonById(this.processId).subscribe(
+                (res) => {
+                    this.audit = res;
+                    this.clicked.emit({ format: this.format, value: this.audit, fileName: this.fileName });
+                },
+                (err) => {
+                    this.error.emit(err);
+                });
+        }
+    }
+
+    onClickAudit() {
+        this.fetchAuditInfo();
+    }
+
+    isJsonFormat() {
+        return this.format === JSON_FORMAT;
+    }
+
+    isPdfFormat() {
+        return this.format === PDF_FORMAT;
+    }
+
+}

ng2-components/ng2-activiti-processlist/src/services/process.service.ts

@@ -90,6 +90,24 @@ export class ProcessService extends TaskListService {
             }).catch(err => this.handleProcessError(err));
     }
 
+    /**
+     * fetch the Process Audit information as a pdf
+     * @param processId - the process id
+     */
+    fetchProcessAuditPdfById(processId: string): Observable<Blob> {
+        return Observable.fromPromise(this.alfrescoApiService.getInstance().activiti.processApi.getProcessAuditPdf(processId))
+            .catch(err => this.handleProcessError(err));
+    }
+
+    /**
+     * fetch the Process Audit information in a json format
+     * @param processId - the process id
+     */
+    fetchProcessAuditJsonById(processId: string): Observable<any> {
+        return Observable.fromPromise(this.alfrescoApiService.getInstance().activiti.processApi.getProcessAuditJson(processId))
+            .catch(err => this.handleProcessError(err));
+    }
+
     /**
      * Create and return the default filters
      * @param appId