@alfresco/adf-process-services 9.2.0-37898766965 → 9.2.0-37910004176

package/bundles/assets/adf-process-services/i18n/en.json

@@ -111,6 +111,12 @@
     "FILTERS": {
       "MESSAGES": {
         "NONE": "No task filter selected"
+      },
+      "DEFAULT": {
+        "MY_TASKS": "My Tasks",
+        "OVERDUE_TASKS": "Overdue Tasks",
+        "UNASSIGNED_TASKS": "Unassigned Tasks",
+        "COMPLETED_TASKS": "Completed Tasks"
       }
     },
     "START_TASK": {
@@ -182,6 +188,11 @@
     "FILTERS": {
       "MESSAGES": {
         "NONE": "No process instance filter selected."
+      },
+      "DEFAULT": {
+        "RUNNING": "Running",
+        "COMPLETED": "Completed",
+        "ALL": "All"
       }
     },
     "PROPERTIES": {

package/fesm2022/adf-process-services.mjs

@@ -4,7 +4,7 @@ import { inject, Injectable, EventEmitter, Output, Input, ContentChild, Componen
 import { LazyApi, TasksApi, ProcessDefinitionsApi, ProcessInstancesApi, ProcessInstanceVariablesApi, UserFiltersApi, RuntimeAppDefinitionsApi, TaskQueryRepresentation, ResultListDataRepresentationTaskRepresentation, ModelsApi, TaskActionsApi, ChecklistsApi, UsersApi, ActivitiGroupsApi, UserProfileApi, CustomModelApi, FormModelsApi, TaskFormsApi, FormSaveRepresentation, ActivitiContentApi, AlfrescoApi, ContentApi, IntegrationAlfrescoOnPremiseApi, TaskRepresentation, UserTaskFilterRepresentation, ActivitiCommentsApi } from '@alfresco/js-api';
 import { AlfrescoApiService, NodesApiService, AlfrescoViewerComponent, ContentNodeSelectorPanelComponent, DocumentListService, SitesService, SearchService, ContentService, ContentNodeDialogService, AlfrescoIconComponent, UploadService } from '@alfresco/adf-content-services';
 import { from, BehaviorSubject, Observable, forkJoin, of, throwError, merge, Subject, zip, EMPTY } from 'rxjs';
-import { map, finalize, filter, flatMap, catchError, tap, switchMap, mergeMap, debounceTime, distinctUntilChanged, share, defaultIfEmpty } from 'rxjs/operators';
+import { map, finalize, filter, switchMap, flatMap, catchError, tap, mergeMap, debounceTime, distinctUntilChanged, share, defaultIfEmpty } from 'rxjs/operators';
 import * as i1 from '@angular/common';
 import { DatePipe, CommonModule, Location } from '@angular/common';
 import * as i2 from '@angular/material/progress-spinner';
@@ -703,7 +703,7 @@ class ProcessFilterService {
      */
     getRunningFilterInstance(appId, index) {
         return {
-            name: 'Running',
+            name: 'ADF_PROCESS_LIST.FILTERS.DEFAULT.RUNNING',
             appId,
             recent: true,
             icon: 'glyphicon-random',
@@ -720,6 +720,16 @@ class ProcessFilterService {
     addProcessFilter(filter) {
         return from(this.userFiltersApi.createUserProcessInstanceFilter(filter));
     }
+    /**
+     * Updates a process filter.
+     *
+     * @param filterId existing filter id
+     * @param updatedFilter updated filter body
+     * @returns The updated filter
+     */
+    updateProcessFilter(filterId, updatedFilter) {
+        return from(this.userFiltersApi.updateUserProcessInstanceFilter(filterId, updatedFilter));
+    }
     /**
      * Calls `getUserProcessInstanceFilters` from the Alfresco JS API.
      *
@@ -736,7 +746,7 @@ class ProcessFilterService {
     }
     getCompletedFilterInstance(appId, index) {
         return {
-            name: 'Completed',
+            name: 'ADF_PROCESS_LIST.FILTERS.DEFAULT.COMPLETED',
             appId,
             recent: false,
             icon: 'glyphicon-ok-sign',
@@ -746,7 +756,7 @@ class ProcessFilterService {
     }
     getAllFilterInstance(appId, index) {
         return {
-            name: 'All',
+            name: 'ADF_PROCESS_LIST.FILTERS.DEFAULT.ALL',
             appId,
             recent: true,
             icon: 'glyphicon-th',
@@ -989,6 +999,11 @@ class IconModel {
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+const LEGACY_DEFAULT_PROCESS_FILTER_TRANSLATION_KEYS = {
+    Running: 'ADF_PROCESS_LIST.FILTERS.DEFAULT.RUNNING',
+    Completed: 'ADF_PROCESS_LIST.FILTERS.DEFAULT.COMPLETED',
+    All: 'ADF_PROCESS_LIST.FILTERS.DEFAULT.ALL'
+};
 class ProcessFiltersComponent {
     constructor() {
         this.processFilterService = inject(ProcessFilterService);
@@ -1043,25 +1058,18 @@ class ProcessFiltersComponent {
      * @param appId - optional
      */
     getFiltersByAppId(appId) {
-        this.processFilterService.getProcessFilters(appId).subscribe((res) => {
+        this.processFilterService
+            .getProcessFilters(appId)
+            .pipe(switchMap((res) => {
             if (res.length === 0 && this.isFilterListEmpty()) {
-                this.processFilterService.createDefaultFilters(appId).subscribe((resDefault) => {
-                    this.resetFilter();
-                    this.filters = resDefault;
-                    this.selectProcessFilter(this.filterParam);
-                    this.success.emit(resDefault);
-                }, (errDefault) => {
-                    this.error.emit(errDefault);
-                });
-            }
-            else {
-                this.resetFilter();
-                this.filters = res;
-                this.selectProcessFilter(this.filterParam);
-                this.success.emit(res);
+                return this.processFilterService.createDefaultFilters(appId);
             }
-        }, (err) => {
-            this.error.emit(err);
+            const migratedFilters = this.migrateDefaultFilters(res);
+            return migratedFilters.length > 0 ? forkJoin(migratedFilters).pipe(map(() => res)) : of(res);
+        }), takeUntilDestroyed(this.destroyRef))
+            .subscribe({
+            next: (filters) => this.setProcessFilters(filters),
+            error: (err) => this.error.emit(err)
         });
     }
     /**
@@ -1143,6 +1151,33 @@ class ProcessFiltersComponent {
         this.filters = [];
         this.currentFilter = undefined;
     }
+    /**
+     * Reset the current selection and display the given filters, selecting the one matching filterParam.
+     *
+     * @param filters - list of filters to display
+     */
+    setProcessFilters(filters) {
+        this.resetFilter();
+        this.filters = filters;
+        this.selectProcessFilter(this.filterParam);
+        this.success.emit(filters);
+    }
+    /**
+     * Rename default filters still stored with their legacy plain-string name to the matching translation key.
+     *
+     * @param filters - list of filters to migrate
+     * @returns list of observables for each migrated filter
+     */
+    migrateDefaultFilters(filters) {
+        const migratedFilters = [];
+        filters.forEach((filterToMigrate) => {
+            const translationKey = LEGACY_DEFAULT_PROCESS_FILTER_TRANSLATION_KEYS[filterToMigrate.name];
+            if (translationKey) {
+                migratedFilters.push(this.processFilterService.updateProcessFilter(filterToMigrate.id, { ...filterToMigrate, name: translationKey }));
+            }
+        });
+        return migratedFilters;
+    }
     static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.2.22", ngImport: i0, type: ProcessFiltersComponent, deps: [], target: i0.ɵɵFactoryTarget.Component }); }
     static { this.ɵcmp = i0.ɵɵngDeclareComponent({ minVersion: "14.0.0", version: "21.2.22", type: ProcessFiltersComponent, isStandalone: true, selector: "adf-process-instance-filters", inputs: { filterParam: "filterParam", appId: "appId", appName: "appName", showIcon: "showIcon" }, outputs: { filterClicked: "filterClicked", success: "success", error: "error", filterSelected: "filterSelected" }, usesOnChanges: true, ngImport: i0, template: "<div *ngFor=\"let filter of filters\" class=\"adf-filters__entry\" [class.adf-active]=\"isActiveRoute(filter)\">\n    <button\n        (click)=\"selectFilter(filter)\"\n        [attr.aria-label]=\"filter.name | translate\"\n        [id]=\"filter.id\"\n        [attr.data-automation-id]=\"filter.name + '_filter'\"\n        mat-button\n        class=\"adf-filter-action-button adf-full-width\"\n    >\n        <mat-icon data-automation-id=\"adf-filter-icon\" *ngIf=\"showIcon\" aria-hidden=\"true\">{{ getFilterIcon(filter.icon) }}</mat-icon>\n        <span data-automation-id=\"adf-filter-label\" class=\"adf-filter-action-button__label\">{{ filter.name | translate }}</span>\n    </button>\n</div>\n", styles: ["adf-process-instance-filters .adf-filters__entry:has(.adf-filter-action-button){padding:0;width:100%}adf-process-instance-filters .adf-filters__entry:has(.adf-filter-action-button) .adf-full-width{display:flex;width:100%}adf-process-instance-filters .adf-filters__entry:has(.adf-filter-action-button) .adf-filter-action-button{align-items:center;height:32px;justify-content:flex-start}adf-process-instance-filters .adf-filters__entry:has(.adf-filter-action-button) .adf-filter-action-button .adf-filter-action-button__label{padding-left:20px;margin:0 8px;font:var(--mat-sys-body-large)}adf-process-instance-filters .adf-filters__entry:has(.adf-filter-action-button).adf-active .adf-filter-action-button__label{color:var(--mat-sys-primary)}\n"], dependencies: [{ kind: "ngmodule", type: CommonModule }, { kind: "directive", type: i1.NgForOf, selector: "[ngFor][ngForOf]", inputs: ["ngForOf", "ngForTrackBy", "ngForTemplate"] }, { kind: "directive", type: i1.NgIf, selector: "[ngIf]", inputs: ["ngIf", "ngIfThen", "ngIfElse"] }, { kind: "ngmodule", type: MatButtonModule }, { kind: "component", type: i3.MatButton, selector: "    button[matButton], a[matButton], button[mat-button], button[mat-raised-button],    button[mat-flat-button], button[mat-stroked-button], a[mat-button], a[mat-raised-button],    a[mat-flat-button], a[mat-stroked-button]  ", inputs: ["matButton"], exportAs: ["matButton", "matAnchor"] }, { kind: "ngmodule", type: MatIconModule }, { kind: "component", type: i3$1.MatIcon, selector: "mat-icon", inputs: ["color", "inline", "svgIcon", "fontSet", "fontIcon"], exportAs: ["matIcon"] }, { kind: "pipe", type: TranslatePipe, name: "translate" }], encapsulation: i0.ViewEncapsulation.None }); }
 }
@@ -6750,7 +6785,7 @@ class TaskFilterService {
      */
     getMyTasksFilterInstance(appId, index) {
         return new UserTaskFilterRepresentation({
-            name: 'My Tasks',
+            name: 'ADF_TASK_LIST.FILTERS.DEFAULT.MY_TASKS',
             appId,
             recent: false,
             icon: 'glyphicon-inbox',
@@ -6772,7 +6807,7 @@ class TaskFilterService {
      */
     getOverdueTasksFilterInstance(appId, index) {
         return new UserTaskFilterRepresentation({
-            name: 'Overdue Tasks',
+            name: 'ADF_TASK_LIST.FILTERS.DEFAULT.OVERDUE_TASKS',
             appId,
             recent: false,
             icon: 'glyphicon-align-left',
@@ -6789,7 +6824,7 @@ class TaskFilterService {
      */
     getUnassignedTasksFilterInstance(appId, index) {
         return new UserTaskFilterRepresentation({
-            name: 'Unassigned Tasks',
+            name: 'ADF_TASK_LIST.FILTERS.DEFAULT.UNASSIGNED_TASKS',
             appId,
             recent: false,
             icon: 'glyphicon-record',
@@ -6806,7 +6841,7 @@ class TaskFilterService {
      */
     getCompletedTasksFilterInstance(appId, index) {
         return new UserTaskFilterRepresentation({
-            name: 'Completed Tasks',
+            name: 'ADF_TASK_LIST.FILTERS.DEFAULT.COMPLETED_TASKS',
             appId,
             recent: true,
             icon: 'glyphicon-ok-sign',
@@ -6843,6 +6878,12 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.22", ngImpo
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+const LEGACY_DEFAULT_TASK_FILTER_TRANSLATION_KEYS = {
+    'My Tasks': 'ADF_TASK_LIST.FILTERS.DEFAULT.MY_TASKS',
+    'Overdue Tasks': 'ADF_TASK_LIST.FILTERS.DEFAULT.OVERDUE_TASKS',
+    'Unassigned Tasks': 'ADF_TASK_LIST.FILTERS.DEFAULT.UNASSIGNED_TASKS',
+    'Completed Tasks': 'ADF_TASK_LIST.FILTERS.DEFAULT.COMPLETED_TASKS'
+};
 class TaskFiltersComponent {
     constructor() {
         this.taskFilterService = inject(TaskFilterService);
@@ -6897,23 +6938,18 @@ class TaskFiltersComponent {
      * @param appId - optional
      */
     getFiltersByAppId(appId) {
-        this.taskFilterService.getTaskListFilters(appId).subscribe((res) => {
+        this.taskFilterService
+            .getTaskListFilters(appId)
+            .pipe(switchMap((res) => {
             if (res.length === 0 && this.isFilterListEmpty()) {
-                this.createFiltersByAppId(appId);
+                return this.taskFilterService.createDefaultFilters(appId);
             }
-            else {
-                const migratedFilters = this.migrateObsoleteFilters(res);
-                if (migratedFilters.length > 0) {
-                    forkJoin(migratedFilters).subscribe(() => {
-                        this.setTaskFilters(res);
-                    });
-                }
-                else {
-                    this.setTaskFilters(res);
-                }
-            }
-        }, (err) => {
-            this.error.emit(err);
+            const migratedFilters = this.migrateObsoleteFilters(res);
+            return migratedFilters.length > 0 ? forkJoin(migratedFilters).pipe(map(() => res)) : of(res);
+        }), takeUntilDestroyed(this.destroyRef))
+            .subscribe({
+            next: (filters) => this.setTaskFilters(filters),
+            error: (err) => this.error.emit(err)
         });
     }
     /**
@@ -6928,18 +6964,6 @@ class TaskFiltersComponent {
             this.error.emit(err);
         });
     }
-    /**
-     * Create default filters by appId
-     *
-     * @param appId application id
-     */
-    createFiltersByAppId(appId) {
-        this.taskFilterService.createDefaultFilters(appId).subscribe((resDefault) => {
-            this.setTaskFilters(resDefault);
-        }, (errDefault) => {
-            this.error.emit(errDefault);
-        });
-    }
     /**
      * Pass the selected filter as next
      *
@@ -7016,7 +7040,9 @@ class TaskFiltersComponent {
         this.currentFilter = undefined;
     }
     /**
-     * Migrate "Involved" and "Queued" filters to "Overdue" and "Unassigned" filters
+     * Migrate obsolete and legacy default filters:
+     * - "Involved" and "Queued" filters become "Overdue" and "Unassigned" filters
+     * - default filters still stored with their legacy plain-string name are renamed to the matching translation key
      *
      * @param filters - list of filters to migrate
      * @returns list of observables for each migrated filter
@@ -7031,8 +7057,13 @@ class TaskFiltersComponent {
                 case 'Queued Tasks':
                     migratedFilters.push(this.taskFilterService.updateTaskFilter(filterToMigrate.id, this.taskFilterService.getUnassignedTasksFilterInstance(this.appId)));
                     break;
-                default:
+                default: {
+                    const translationKey = LEGACY_DEFAULT_TASK_FILTER_TRANSLATION_KEYS[filterToMigrate.name];
+                    if (translationKey) {
+                        migratedFilters.push(this.taskFilterService.updateTaskFilter(filterToMigrate.id, new UserTaskFilterRepresentation({ ...filterToMigrate, name: translationKey })));
+                    }
                     break;
+                }
             }
         });
         return migratedFilters;