[ADF-2149] Update ng-packagr to 2.0.0 (#2935)

* ng-packagr version 2.0.0 core fixes * fix content services jsdoc * fix process service jsdoc * last update new build 2.0.0 * fix comment jsdoc
2025-07-31 17:38:48 +00:00 · 2018-02-13 10:37:03 +00:00
parent 71a1ca1787
commit a863631f0d
53 changed files with 178 additions and 274 deletions
--- a/lib/process-services/task-list/components/task-details.component.ts
+++ b/lib/process-services/task-list/components/task-details.component.ts
@@ -16,8 +16,16 @@
 */

 import { PeopleProcessService, UserProcessModel } from '@alfresco/adf-core';
-import { AuthenticationService, CardViewUpdateService, ClickNotification, LogService, UpdateNotification, FormRenderingService } from '@alfresco/adf-core';
-import { Component,
+import {
+    AuthenticationService,
+    CardViewUpdateService,
+    ClickNotification,
+    LogService,
+    UpdateNotification,
+    FormRenderingService
+} from '@alfresco/adf-core';
+import {
+    Component,
    EventEmitter,
    Input,
    OnChanges,
@@ -209,12 +217,11 @@ export class TaskDetailsComponent implements OnInit, OnChanges {

    /**
     * Check if the task has a form
-     * @returns {TaskDetailsModel|string|boolean}
     */
-    hasFormKey() {
+    hasFormKey(): TaskDetailsModel | string | boolean {
        return (this.taskDetails
-        && this.taskDetails.formKey
-        && this.taskDetails.formKey !== 'null');
+            && this.taskDetails.formKey
+            && this.taskDetails.formKey !== 'null');
    }

    isTaskActive() {
@@ -339,7 +346,7 @@ export class TaskDetailsComponent implements OnInit, OnChanges {
    }

    onFormError(error: any): void {
-        this.errorDialogRef = this.dialog.open(this.errorDialog, {width: '500px'});
+        this.errorDialogRef = this.dialog.open(this.errorDialog, { width: '500px' });
        this.error.emit(error);
    }

--- a/lib/process-services/task-list/components/task-filters.component.ts
+++ b/lib/process-services/task-list/components/task-filters.component.ts
@@ -216,7 +216,6 @@ export class TaskFiltersComponent implements OnInit, OnChanges {

    /**
     * Return the current task
-     * @returns {FilterRepresentationModel}
     */
    getCurrentFilter(): FilterRepresentationModel {
        return this.currentFilter;
@@ -224,7 +223,6 @@ export class TaskFiltersComponent implements OnInit, OnChanges {

    /**
     * Check if the filter list is empty
-     * @returns {boolean}
     */
    isFilterListEmpty(): boolean {
        return this.filters === undefined || (this.filters && this.filters.length === 0);
--- a/lib/process-services/task-list/components/task-list.component.ts
+++ b/lib/process-services/task-list/components/task-list.component.ts
@@ -15,9 +15,26 @@
 * limitations under the License.
 */

-import { DataColumn, DataRowEvent, DataTableAdapter, ObjectDataColumn, ObjectDataRow, ObjectDataTableAdapter } from '@alfresco/adf-core';
+import {
+    DataColumn,
+    DataRowEvent,
+    DataTableAdapter,
+    ObjectDataColumn,
+    ObjectDataRow,
+    ObjectDataTableAdapter
+} from '@alfresco/adf-core';
 import { AppConfigService, DataColumnListComponent, PaginationComponent } from '@alfresco/adf-core';
-import { AfterContentInit, Component, ContentChild, EventEmitter, Input, OnChanges, OnInit, Output, SimpleChanges } from '@angular/core';
+import {
+    AfterContentInit,
+    Component,
+    ContentChild,
+    EventEmitter,
+    Input,
+    OnChanges,
+    OnInit,
+    Output,
+    SimpleChanges
+} from '@angular/core';
 import { Observable } from 'rxjs/Observable';
 import { TaskQueryRequestRepresentationModel } from '../models/filter.model';
 import { TaskListModel } from '../models/task-list.model';
@@ -128,7 +145,6 @@ export class TaskListComponent implements OnChanges, OnInit, AfterContentInit {
     * When enabled the component reloads data from it's current source instead of the server side.
     * This allows generating and displaying custom data sets (i.e. filtered out content).
     *
-     * @type {boolean}
     * @memberOf TaskListComponent
     */
    hasCustomDataSource: boolean = false;
@@ -218,14 +234,13 @@ export class TaskListComponent implements OnChanges, OnInit, AfterContentInit {

    private loadTasksByState(): Observable<TaskListModel> {
        return this.requestNode.state === 'all'
-               ? this.taskListService.findAllTasksWithoutState(this.requestNode)
-               : this.taskListService.findTasksByState(this.requestNode);
+            ? this.taskListService.findAllTasksWithoutState(this.requestNode)
+            : this.taskListService.findTasksByState(this.requestNode);
    }

    /**
     * Create an array of ObjectDataRow
     * @param instances
-     * @returns {ObjectDataRow[]}
     */
    private createDataRow(instances: any[]): ObjectDataRow[] {
        let instancesRows: ObjectDataRow[] = [];
@@ -280,7 +295,6 @@ export class TaskListComponent implements OnChanges, OnInit, AfterContentInit {

    /**
     * Return the current id
-     * @returns {string}
     */
    getCurrentId(): string {
        return this.currentInstanceId;
@@ -289,15 +303,13 @@ export class TaskListComponent implements OnChanges, OnInit, AfterContentInit {
    /**
     * Check if the taskId is the same of the selected task
     * @param taskId
-     * @returns {boolean}
     */
-    isEqualToCurrentId(taskId: string) {
+    isEqualToCurrentId(taskId: string): boolean {
        return this.currentInstanceId === taskId ? true : false;
    }

    /**
     * Check if the list is empty
-     * @returns {ObjectDataTableAdapter|boolean}
     */
    isListEmpty(): boolean {
        return this.data === undefined ||
@@ -330,9 +342,8 @@ export class TaskListComponent implements OnChanges, OnInit, AfterContentInit {
    /**
     * Optimize name field
     * @param istances
-     * @returns {any[]}
     */
-    private optimizeNames(istances: any[]) {
+    private optimizeNames(istances: any[]): any[] {
        istances = istances.map(t => {
            t.obj.name = t.obj.name || 'No name';
            return t;
--- a/lib/process-services/task-list/models/form.model.ts
+++ b/lib/process-services/task-list/models/form.model.ts
@@ -16,11 +16,7 @@
 */

 /**
- *
 * This object represent of the Form.
- *
- *
- * @returns {Form} .
 */
 export class Form {

--- a/lib/process-services/task-list/models/start-task.model.ts
+++ b/lib/process-services/task-list/models/start-task.model.ts
@@ -16,11 +16,7 @@
 */

 /**
- *
 * This object represent of the StartTaskModel.
- *
- *
- * @returns {StartTaskModel} .
 */
 import { UserProcessModel } from '@alfresco/adf-core';

--- a/lib/process-services/task-list/models/task-details.model.ts
+++ b/lib/process-services/task-list/models/task-details.model.ts
@@ -16,11 +16,7 @@
 */

 /**
- *
 * This object represent the details of a task.
- *
- *
- * @returns {TaskDetailsModel} .
 */
 import { UserProcessModel } from '@alfresco/adf-core';
 import { TaskRepresentation } from 'alfresco-js-api';
--- a/lib/process-services/task-list/models/user-event.model.ts
+++ b/lib/process-services/task-list/models/user-event.model.ts
@@ -16,11 +16,7 @@
 */

 /**
- *
 * This object represent the User Event.
- *
- *
- * @returns {UserEventModel} .
 */
 export class UserEventModel {
    type: string = '';
--- a/lib/process-services/task-list/services/task-filter.service.ts
+++ b/lib/process-services/task-list/services/task-filter.service.ts
@@ -37,7 +37,6 @@ export class TaskFilterService {
    /**
     * Create and return the default filters
     * @param appId
-     * @returns {FilterRepresentationModel[]}
     */
    public createDefaultFilters(appId: number): Observable<FilterRepresentationModel[]> {
        let involvedTasksFilter = this.getInvolvedTasksFilterInstance(appId);
@@ -87,7 +86,6 @@ export class TaskFilterService {

    /**
     * Retrieve all the Tasks filters
-     * @returns {Observable<any>}
     */
    getTaskListFilters(appId?: number): Observable<any> {
        return Observable.fromPromise(this.callApiTaskFilters(appId))
@@ -105,7 +103,6 @@ export class TaskFilterService {
     * Retrieve the Tasks filter by id
     * @param filterId - number - The id of the filter
     * @param appId - string - optional - The id of app
-     * @returns {Observable<FilterRepresentationModel>}
     */
    getTaskFilterById(filterId: number, appId?: number): Observable<FilterRepresentationModel> {
        return Observable.fromPromise(this.callApiTaskFilters(appId))
@@ -117,7 +114,6 @@ export class TaskFilterService {
    /**
     * Retrieve the Tasks filter by name
     * @param taskName - string - The name of the filter
-     * @returns {Observable<FilterRepresentationModel>}
     */
    getTaskFilterByName(taskName: string, appId?: number): Observable<FilterRepresentationModel> {
        return Observable.fromPromise(this.callApiTaskFilters(appId))
@@ -129,7 +125,6 @@ export class TaskFilterService {
    /**
     * Add a filter
     * @param filter - FilterRepresentationModel
-     * @returns {FilterRepresentationModel}
     */
    addFilter(filter: FilterRepresentationModel): Observable<FilterRepresentationModel> {
        return Observable.fromPromise(this.apiService.getInstance().activiti.userFiltersApi.createUserTaskFilter(filter))
@@ -150,7 +145,6 @@ export class TaskFilterService {
    /**
     * Return a static Involved filter instance
     * @param appId
-     * @returns {FilterRepresentationModel}
     */
    getInvolvedTasksFilterInstance(appId: number): FilterRepresentationModel {
        return new FilterRepresentationModel({
@@ -165,7 +159,6 @@ export class TaskFilterService {
    /**
     * Return a static My task filter instance
     * @param appId
-     * @returns {FilterRepresentationModel}
     */
    getMyTasksFilterInstance(appId: number): FilterRepresentationModel {
        return new FilterRepresentationModel({
@@ -180,7 +173,6 @@ export class TaskFilterService {
    /**
     * Return a static Queued filter instance
     * @param appId
-     * @returns {FilterRepresentationModel}
     */
    getQueuedTasksFilterInstance(appId: number): FilterRepresentationModel {
        return new FilterRepresentationModel({
@@ -195,7 +187,6 @@ export class TaskFilterService {
    /**
     * Return a static Completed filter instance
     * @param appId
-     * @returns {FilterRepresentationModel}
     */
    getCompletedTasksFilterInstance(appId: number): FilterRepresentationModel {
        return new FilterRepresentationModel({
--- a/lib/process-services/task-list/services/tasklist.service.ts
+++ b/lib/process-services/task-list/services/tasklist.service.ts
@@ -43,7 +43,6 @@ export class TaskListService {
     * Return all the filters in the list where the task id belong
     * @param taskId - string
     * @param filter - FilterRepresentationModel []
-     * @returns {FilterRepresentationModel}
     */
    getFilterForTaskById(taskId: string, filterList: FilterRepresentationModel[]): Observable<FilterRepresentationModel> {
        return Observable.from(filterList)
@@ -54,7 +53,6 @@ export class TaskListService {
    /**
     * Return the search node for query task based on the given filter
     * @param filter - FilterRepresentationModel
-     * @returns {TaskQueryRequestRepresentationModel}
     */
    private generateTaskRequestNodeFromFilter(filter: FilterRepresentationModel): TaskQueryRequestRepresentationModel {
        let requestNode = {
@@ -70,7 +68,6 @@ export class TaskListService {
     * Check if a taskId is filtered with the given filter
     * @param taskId - string
     * @param filter - FilterRepresentationModel
-     * @returns {FilterRepresentationModel}
     */
    isTaskRelatedToFilter(taskId: string, filter: FilterRepresentationModel): Observable<FilterRepresentationModel> {
        let requestNodeForFilter = this.generateTaskRequestNodeFromFilter(filter);
@@ -83,7 +80,6 @@ export class TaskListService {
    /**
     * Retrieve all the tasks filtered by filterModel
     * @param filter - TaskFilterRepresentationModel
-     * @returns {any}
     */
    getTasks(requestNode: TaskQueryRequestRepresentationModel): Observable<TaskListModel> {
        return Observable.fromPromise(this.callApiTasksFiltered(requestNode))
@@ -96,7 +92,6 @@ export class TaskListService {
    /**
     * Retrieve tasks filtered by filterModel and state
     * @param filter - TaskFilterRepresentationModel
-     * @returns {any}
     */
    findTasksByState(requestNode: TaskQueryRequestRepresentationModel, state?: string): Observable<TaskListModel> {
        if (state) {
@@ -108,7 +103,6 @@ export class TaskListService {
    /**
     * Retrieve all tasks filtered by filterModel and state
     * @param filter - TaskFilterRepresentationModel
-     * @returns {any}
     */
    findAllTaskByState(requestNode: TaskQueryRequestRepresentationModel, state?: string): Observable<TaskListModel> {
        if (state) {
@@ -123,7 +117,6 @@ export class TaskListService {
    /**
     * Retrieve all tasks filtered by filterModel irrespective of state
     * @param filter - TaskFilterRepresentationModel
-     * @returns {any}
     */
    findAllTasksWithoutState(requestNode: TaskQueryRequestRepresentationModel): Observable<TaskListModel> {
        return Observable.forkJoin(
@@ -142,7 +135,6 @@ export class TaskListService {
    /**
     * Retrieve all the task details
     * @param id - taskId
-     * @returns {<TaskDetailsModel>}
     */
    getTaskDetails(taskId: string): Observable<TaskDetailsModel> {
        return Observable.fromPromise(this.callApiTaskDetails(taskId))
@@ -155,7 +147,6 @@ export class TaskListService {
    /**
     * Retrieve all the task's checklist
     * @param id - taskId
-     * @returns {TaskDetailsModel}
     */
    getTaskChecklist(id: string): Observable<TaskDetailsModel[]> {
        return Observable.fromPromise(this.callApiTaskChecklist(id))
@@ -171,7 +162,6 @@ export class TaskListService {

    /**
     * Retrieve all the form shared with this user
-     * @returns {TaskDetailsModel}
     */
    getFormList(): Observable<Form []> {
        let opts = {
@@ -197,7 +187,6 @@ export class TaskListService {
    /**
     * Add a task
     * @param task - TaskDetailsModel
-     * @returns {TaskDetailsModel}
     */
    addTask(task: TaskDetailsModel): Observable<TaskDetailsModel> {
        return Observable.fromPromise(this.callApiAddTask(task))
@@ -219,7 +208,6 @@ export class TaskListService {
    /**
     * Make the task completed
     * @param id - taskId
-     * @returns {TaskDetailsModel}
     */
    completeTask(taskId: string) {
        return Observable.fromPromise(this.apiService.getInstance().activiti.taskApi.completeTask(taskId))
@@ -230,7 +218,6 @@ export class TaskListService {
    /**
     * Return the total number of the tasks by filter
     * @param requestNode - TaskFilterRepresentationModel
-     * @returns {any}
     */
    public getTotalTasks(requestNode: TaskQueryRequestRepresentationModel): Observable<any> {
        requestNode.size = 0;
@@ -243,7 +230,6 @@ export class TaskListService {
    /**
     * Create a new standalone task
     * @param task - TaskDetailsModel
-     * @returns {TaskDetailsModel}
     */
    createNewTask(task: TaskDetailsModel): Observable<TaskDetailsModel> {
        return Observable.fromPromise(this.callApiCreateTask(task))
@@ -257,7 +243,6 @@ export class TaskListService {
     * Assign task to user/group
     * @param taskId - string
     * @param requestNode - any
-     * @returns {TaskDetailsModel}
     */
    assignTask(taskId: string, requestNode: any): Observable<TaskDetailsModel> {
        let assignee = {assignee: requestNode.id};