@yuuvis/bpm-management-app 1.1.0-alpha.1 → 1.1.0-alpha.2

package/README.md

@@ -18,7 +18,7 @@ In your `app.routes.ts` add a new lazy loaded route for the `@yuuvis/bpm-managem
 export const apps: App[] = [
   {
     id: 'io.yuuvis.app.bpm-management',
-    title: 'yuuvis BPM Management',
+    title: 'yuuvis bpm-management',
     path: 'bpm-management',
     iconName: 'flowchart',
     loadChildren: () => import('@yuuvis/bpm-management-app').then((m) => m.YuvBpmManagementRoutes)
@@ -32,27 +32,29 @@ The app is configured by the client via the `data` property of its app entry in
 
 | Option            | Type      | Default | Description |
 | ----------------- | --------- | ------- | ----------- |
-| `showDeployments` | `boolean` | `false` | Shows the **Deployments** tab. If not set to `true`, the tab is hidden and navigating directly to `.../deployments` redirects to the processes page. |
-| `showProcessDefinitions` | `boolean` | `false` | Shows the **Process definitions** tab. If not set to `true`, the tab is hidden and navigating directly to `.../definitions` redirects to the processes page. |
+| `showDeployments` | `boolean` | `true` | Shows the **Deployments** tab. If set to `false`, the tab is hidden and navigating directly to `.../deployments` redirects to the processes page. |
+| `showProcessDefinitions` | `boolean` | `true` | Shows the **Process definitions** tab. If set to `false`, the tab is hidden and navigating directly to `.../definitions` redirects to the processes page. |
 
-Example, enabling the Deployments and Process definitions tabs:
+Example, hiding the Deployments and Process definitions tabs:
 
 ```ts
 export const apps: App[] = [
   {
     id: 'io.yuuvis.app.bpm-management',
-    title: 'yuuvis BPM Management',
+    title: 'yuuvis bpm-management',
     path: 'bpm-management',
     iconName: 'flowchart',
     loadChildren: () => import('@yuuvis/bpm-management-app').then((m) => m.YuvBpmManagementRoutes),
     data: {
-      showDeployments: true,
-      showProcessDefinitions: true
+      showDeployments: false,
+      showProcessDefinitions: false
     }
   },
 ]
 ```
 
+Navigating to the app's path (`.../bpm-management`) opens the first enabled tab: Deployments, then Process definitions, then Processes. Processes and Tasks are always available.
+
 The app can be registered multiple times with different `id`, `path` and `data` (for example one entry with all tabs and one without), each entry is configured independently.
 
 ## License

package/fesm2022/yuuvis-bpm-management-app.mjs

@@ -220,23 +220,23 @@ function resolveAppConfig(route) {
     return { appId, data };
 }
 /**
- * Whether the host shell client enabled the deployments tab via `data: { showDeployments: true }`.
+ * Whether the host shell client enabled the deployments tab unless `data: { showDeployments: false }` hides it (shown by default).
  */
 function isDeploymentsEnabled(route) {
-    return resolveAppConfig(route).data.showDeployments === true;
+    return resolveAppConfig(route).data.showDeployments !== false;
 }
 /**
- * Whether the host shell client enabled the process definitions tab via `data: { showProcessDefinitions: true }`.
+ * Whether the host shell client enabled the process definitions tab unless `data: { showProcessDefinitions: false }` hides it (shown by default).
  */
 function isProcessDefinitionsEnabled(route) {
-    return resolveAppConfig(route).data.showProcessDefinitions === true;
+    return resolveAppConfig(route).data.showProcessDefinitions !== false;
 }
 /**
- * The entities the host shell client enabled (deployments and process definitions are optional).
+ * The entities the host shell client enabled (deployments and process definitions are optional, both on by default).
  */
 function enabledEntities(route) {
     const { showDeployments, showProcessDefinitions } = resolveAppConfig(route).data;
-    return BPM_ENTITIES.filter(e => (e !== 'deployments' || showDeployments === true) && (e !== 'definitions' || showProcessDefinitions === true));
+    return BPM_ENTITIES.filter(e => (e !== 'deployments' || showDeployments !== false) && (e !== 'definitions' || showProcessDefinitions !== false));
 }
 /**
  * Guard for an optional tab's route. If the tab is not enabled, redirects to the processes page.
@@ -245,9 +245,31 @@ function optionalTabGuard(path, isEnabled) {
     const pathRegex = new RegExp(`/${path}(?=[/?#]|$)`);
     return (route, state) => isEnabled(route) || inject(Router).parseUrl(state.url.replace(pathRegex, '/processes').split(/[?#]/)[0]);
 }
+/**
+ * Guard for the empty path of the app: redirects to the first enabled entity (deployments, process
+ * definitions, processes, tasks), keeping the query string.
+ */
+const defaultEntityGuard = (route, state) => {
+    const [path, query] = state.url.split('#')[0].split('?');
+    const base = path.replace(/\/+$/, '');
+    return inject(Router).parseUrl(`${base}/${enabledEntities(route)[0]}${query ? '?' + query : ''}`);
+};
 const deploymentsGuard = optionalTabGuard('deployments', isDeploymentsEnabled);
 const processDefinitionsGuard = optionalTabGuard('definitions', isProcessDefinitionsEnabled);
 
+/**
+ * Appends the set criteria of a filter to the REST parameters.
+ * Skips unset (undefined/null) criteria and keys without a REST name, but keeps falsy values such as `false`.
+ */
+function applyBpmFilterParams(params, filter, restNames) {
+    for (const [key, criterion] of Object.entries(filter ?? {})) {
+        const value = criterion?.value;
+        if (value === undefined || value === null || !restNames[key])
+            continue;
+        params = params.set(restNames[key], value);
+    }
+    return params;
+}
 /**
  * Base class for BPM filter conversion with shared logic
  */
@@ -328,9 +350,6 @@ class DeploymentFilter extends BaseBpmFilter {
         name: 'nameLike',
         category: 'category'
     };
-    id;
-    name;
-    category;
     static fromAgFilterModel(tableFilters) {
         return this.convertFromAgFilterModel(new DeploymentFilter(), tableFilters);
     }
@@ -347,15 +366,6 @@ class ProcessDefinitionFilter extends BaseBpmFilter {
         global: 'global',
         latest: 'latest'
     };
-    id;
-    deploymentId;
-    name;
-    category;
-    version;
-    key;
-    status;
-    global;
-    latest;
     static fromAgFilterModel(tableFilters) {
         return this.convertFromAgFilterModel(new ProcessDefinitionFilter(), tableFilters);
     }
@@ -386,16 +396,6 @@ class ProcessFilter extends BaseBpmFilter {
         endTimeAfter: 'finishedAfter',
         status: 'isCompleted'
     };
-    id;
-    processDefinitionId;
-    name;
-    startUserId;
-    startTimeBefore;
-    startTimeAfter;
-    endTimeBefore;
-    endTimeAfter;
-    businessKey;
-    status;
     static fromAgFilterModel(tableFilters, ts) {
         return this.convertFromAgFilterModel(new ProcessFilter(), tableFilters, ts);
     }
@@ -427,17 +427,6 @@ class TaskFilter extends BaseBpmFilter {
         endTimeBefore: 'completedBefore',
         endTimeAfter: 'completedAfter'
     };
-    id;
-    name;
-    status;
-    processDefinitionId;
-    processInstanceId;
-    assignee;
-    owner;
-    createTimeBefore;
-    createimeAfter;
-    endTimeBefore;
-    endTimeAfter;
     static fromAgFilterModel(tableFilters, ts) {
         return this.convertFromAgFilterModel(new TaskFilter(), tableFilters, ts);
     }
@@ -456,7 +445,7 @@ class TaskFilter extends BaseBpmFilter {
     }
 }
 
-class YuvBpmAdminService {
+class YuvBpmManagementService {
     static DEFAULT_PAGE_SIZE = 15;
     bpmApiBase = '/bpm-engine/api';
     #backendService = inject(BackendService);
@@ -465,11 +454,7 @@ class YuvBpmAdminService {
         if (sort) {
             filterParams = filterParams.set('sort', `${sort.by},${sort.order}`);
         }
-        if (filter) {
-            for (const key in filter) {
-                filterParams = filterParams.set(DeploymentFilter.bpmFilterToRestApiName[key], filter[key]['value']);
-            }
-        }
+        filterParams = applyBpmFilterParams(filterParams, filter, DeploymentFilter.bpmFilterToRestApiName);
         return this.#backendService
             .get(`${this.bpmApiBase}/deployments`, ApiBase.none, { params: filterParams });
     }
@@ -487,11 +472,7 @@ class YuvBpmAdminService {
             // Spring Pageable format: one parameter, "field,direction"
             filterParams = filterParams.set('sort', `${sort.by},${sort.order}`);
         }
-        if (filter) {
-            for (const key in filter) {
-                filterParams = filterParams.set(ProcessDefinitionFilter.bpmFilterToRestApiName[key], filter[key]['value']);
-            }
-        }
+        filterParams = applyBpmFilterParams(filterParams, filter, ProcessDefinitionFilter.bpmFilterToRestApiName);
         return this.#backendService
             .get(`${this.bpmApiBase}/process-definitions`, ApiBase.none, { params: filterParams });
     }
@@ -516,11 +497,7 @@ class YuvBpmAdminService {
         if (sort) {
             filterParams = filterParams.set('sort', `${sort.by},${sort.order}`);
         }
-        if (filter) {
-            for (const key in filter) {
-                filterParams = filterParams.set(ProcessFilter.bpmFilterToRestApiName[key], filter[key]['value']);
-            }
-        }
+        filterParams = applyBpmFilterParams(filterParams, filter, ProcessFilter.bpmFilterToRestApiName);
         return this.#backendService.get(`${this.bpmApiBase}/processes`, ApiBase.none, { params: filterParams });
     }
     getProcess(processInstanceId) {
@@ -544,13 +521,9 @@ class YuvBpmAdminService {
         if (sort) {
             filterParams = filterParams.set('sort', `${sort.by},${sort.order}`);
         }
-        if (filter) {
-            for (const key in filter) {
-                filterParams = filterParams.set(TaskFilter.bpmFilterToRestApiName[key], filter[key]['value']);
-                if (key === 'assignee') {
-                    filterParams = filterParams.set('isAssigned', 'true');
-                }
-            }
+        filterParams = applyBpmFilterParams(filterParams, filter, TaskFilter.bpmFilterToRestApiName);
+        if (filter?.assignee?.value != null) {
+            filterParams = filterParams.set('isAssigned', 'true');
         }
         return this.#backendService
             .get(`${this.bpmApiBase}/tasks`, ApiBase.none, { params: filterParams });
@@ -569,10 +542,10 @@ class YuvBpmAdminService {
     setTaskCandidates(taskId, body) {
         return this.#backendService.post(`${this.bpmApiBase}/tasks/${taskId}/candidates`, body, ApiBase.none);
     }
-    static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.2.25", ngImport: i0, type: YuvBpmAdminService, deps: [], target: i0.ɵɵFactoryTarget.Injectable });
-    static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "21.2.25", ngImport: i0, type: YuvBpmAdminService, providedIn: 'root' });
+    static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "21.2.25", ngImport: i0, type: YuvBpmManagementService, deps: [], target: i0.ɵɵFactoryTarget.Injectable });
+    static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "21.2.25", ngImport: i0, type: YuvBpmManagementService, providedIn: 'root' });
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.25", ngImport: i0, type: YuvBpmAdminService, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.25", ngImport: i0, type: YuvBpmManagementService, decorators: [{
             type: Injectable,
             args: [{
                     providedIn: 'root',
@@ -2118,7 +2091,7 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "21.2.25", ngImpo
  */
 class DetailsComponent {
     #dialog = inject(MatDialog);
-    #service = inject(YuvBpmAdminService);
+    #service = inject(YuvBpmManagementService);
     #translate = inject(TranslateService);
     #notifications = inject(NotificationService);
     #logger = inject(Logger);
@@ -2361,7 +2334,7 @@ class YuvBpmManagementComponent {
     #titleService = inject(Title);
     #route = inject(ActivatedRoute);
     #router = inject(Router);
-    #service = inject(YuvBpmAdminService);
+    #service = inject(YuvBpmManagementService);
     #translate = inject(TranslateService);
     #logger = inject(Logger);
     #state = inject(BpmManagementStateService);
@@ -2756,19 +2729,19 @@ const QUICK_FILTERS = {
 
 /**
  * Deployments, process definitions, processes and tasks are rendered by the same master/details
- * container, the entity comes from the route data. Deployments and process definitions are optional.
+ * container, the entity comes from the route data. Deployments and process definitions are optional. The empty path opens the first enabled entity.
  */
 const YuvBpmManagementRoutes = [
     { path: 'deployments', component: YuvBpmManagementComponent, data: { entity: 'deployments' }, canActivate: [deploymentsGuard] },
     { path: 'definitions', component: YuvBpmManagementComponent, data: { entity: 'definitions' }, canActivate: [processDefinitionsGuard] },
     { path: 'processes', component: YuvBpmManagementComponent, data: { entity: 'processes' } },
     { path: 'tasks', component: YuvBpmManagementComponent, data: { entity: 'tasks' } },
-    { path: '', redirectTo: 'processes', pathMatch: 'full' }
+    { path: '', pathMatch: 'full', children: [], canActivate: [defaultEntityGuard] }
 ];
 
 /**
  * Generated bundle index. Do not edit.
  */
 
-export { APP_ICONS, APP_ID, BPM_ENTITIES, BPM_ENTITY_META, FILTER_OPERATORS, FILTER_TYPES, ProcessDefinitionScope, ProcessDefinitionStatus, ProcessStatus, TaskStatus, YuvBpmAdminService, YuvBpmManagementRoutes, definitionIcon, definitionSeverity, definitionStatusLabel, formatDateTime, processSeverity, processStatusIcon, processStatusLabel, taskSeverity, taskStatusIcon, taskStatusLabel };
+export { APP_ICONS, APP_ID, BPM_ENTITIES, BPM_ENTITY_META, FILTER_OPERATORS, FILTER_TYPES, ProcessDefinitionScope, ProcessDefinitionStatus, ProcessStatus, TaskStatus, YuvBpmManagementRoutes, YuvBpmManagementService, definitionIcon, definitionSeverity, definitionStatusLabel, formatDateTime, processSeverity, processStatusIcon, processStatusLabel, taskSeverity, taskStatusIcon, taskStatusLabel };
 //# sourceMappingURL=yuuvis-bpm-management-app.mjs.map