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

package/types/yuuvis-bpm-management-app.d.ts

@@ -3,16 +3,29 @@ import { Observable } from 'rxjs';
 import { TranslateService } from '@yuuvis/client-core';
 import * as i0 from '@angular/core';
 
+/**
+ * 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. The empty path opens the first enabled entity.
+ */
 declare const YuvBpmManagementRoutes: Route[];
 
 declare const APP_ID = "io.yuuvis.app.bpm-management";
+/**
+ * Custom data a shell client can set on the app's route (`App.data`) to configure the app.
+ */
+interface BpmManagementAppData {
+    /** Show the deployments tab. Shown unless set to `false`. */
+    showDeployments?: boolean;
+    /** Show the process definitions tab. Shown unless set to `false`. */
+    showProcessDefinitions?: boolean;
+}
 interface DeploymentInstance {
     id: string;
     name: string;
     category: string;
     deploymentTime: string;
-    resources: DeploymentResourceData[];
-    definitions: ProcessDefinitionInstance[];
+    resources?: DeploymentResourceData[];
+    definitions?: ProcessDefinitionInstance[];
 }
 interface DeploymentResourceData {
     id: string;
@@ -60,7 +73,7 @@ interface ProcessInstance {
     durationInMillis: number | null;
     endTime: string | null;
     suspended: boolean;
-    variables: ProcessVariable[];
+    variables?: ProcessVariable[];
 }
 interface ProcessHistory {
     tasks: TaskInstance[];
@@ -110,12 +123,12 @@ interface TaskAssignmentHistoryEntry {
 declare const ProcessDefinitionScope: {
     readonly GLOBAL: {
         readonly value: "GLOBAL";
-        readonly label: "yuv.app.bpm-management.processdefinitions.scope.global";
+        readonly label: "yuv.app.bpm-management.definitions.scope.global";
         readonly icon: "globe";
     };
     readonly TENANT: {
         readonly value: "TENANT";
-        readonly label: "yuv.app.bpm-management.processdefinitions.scope.tenant";
+        readonly label: "yuv.app.bpm-management.definitions.scope.tenant";
         readonly icon: "tenant";
     };
 };
@@ -146,12 +159,22 @@ declare const ProcessStatus: {
         readonly value: "COMPLETED";
         readonly label: "yuv.app.bpm-management.status.completed";
     };
+    /** Display only, not a filter value: an ended process with a delete reason was cancelled. */
+    readonly CANCELED: {
+        readonly value: "CANCELED";
+        readonly label: "yuv.app.bpm-management.status.canceled";
+    };
 };
 declare const TaskStatus: {
     readonly RUNNING: {
         readonly value: "RUNNING";
         readonly label: "yuv.app.bpm-management.status.running";
     };
+    /** Display only, not a filter value: the task (or its process) is suspended. */
+    readonly SUSPENDED: {
+        readonly value: "SUSPENDED";
+        readonly label: "yuv.app.bpm-management.status.suspended";
+    };
     readonly COMPLETED: {
         readonly value: "COMPLETED";
         readonly label: "yuv.app.bpm-management.status.completed";
@@ -318,6 +341,31 @@ interface FilterValue {
 }
 type DateFormatType = 'datetime' | 'date' | 'time';
 declare function formatDateTime(utcDateString: string, locale: string, type?: DateFormatType): string;
+/** The entities of the app. The value is also the route path. */
+type BpmEntity = 'deployments' | 'definitions' | 'processes' | 'tasks';
+declare const BPM_ENTITIES: BpmEntity[];
+/** `icon` stands for the entity as a whole (navigation, list header), `itemIcon` for one item of it (details header, list row, references from other lists). */
+declare const BPM_ENTITY_META: Record<BpmEntity, {
+    icon: string;
+    itemIcon: string;
+    label: string;
+}>;
+/** An item of any entity of the app. */
+type BpmItem = DeploymentInstance | ProcessDefinitionInstance | ProcessInstance | TaskInstance;
+/** Severity of a status badge (see `ymt-badge`). */
+type BadgeSeverity = 'primary' | 'success' | 'warning' | 'neutral';
+declare function processSeverity(p: ProcessInstance): BadgeSeverity;
+/** Material icon for the status badge of a process. */
+declare function processStatusIcon(p: ProcessInstance): string;
+declare function processStatusLabel(p: ProcessInstance): string;
+declare function taskSeverity(t: TaskInstance): BadgeSeverity;
+/** Material icon for the status badge of a task. */
+declare function taskStatusIcon(t: TaskInstance): string;
+declare function taskStatusLabel(t: TaskInstance): string;
+declare function definitionSeverity(d: ProcessDefinitionInstance): BadgeSeverity;
+/** The icon of a process definition. Always the default for now, definitions will get custom icons. */
+declare function definitionIcon(_d: ProcessDefinitionInstance): string;
+declare function definitionStatusLabel(d: ProcessDefinitionInstance): string;
 
 /**
  * Base class for BPM filter conversion with shared logic
@@ -400,6 +448,8 @@ declare class TaskFilter extends BaseBpmFilter {
         id: string;
         name: string;
         status: string;
+        processDefinitionId: string;
+        processInstanceId: string;
         assignee: string;
         owner: string;
         createTimeBefore: string;
@@ -410,39 +460,54 @@ declare class TaskFilter extends BaseBpmFilter {
     id: FilterValue | undefined;
     name: FilterValue | undefined;
     status: FilterValue | undefined;
+    processDefinitionId: FilterValue | undefined;
+    processInstanceId: FilterValue | undefined;
     assignee: FilterValue | undefined;
     owner: FilterValue | undefined;
     createTimeBefore: FilterValue | undefined;
-    createimeAfter: FilterValue | undefined;
+    createTimeAfter: FilterValue | undefined;
     endTimeBefore: FilterValue | undefined;
     endTimeAfter: FilterValue | undefined;
     static fromAgFilterModel(tableFilters: TableFilters, ts: TranslateService): TaskFilter;
     protected static handleSelectFilter(filterInstance: any, columnFilter: string, columnFilterData: any): void;
 }
 
-declare class YuvBpmAdminService {
+declare class YuvBpmManagementService {
     #private;
     static DEFAULT_PAGE_SIZE: number;
     private readonly bpmApiBase;
-    getDeployments(page: number, size: number, filter?: DeploymentFilter): Observable<any>;
+    getDeployments(page: number, size: number, filter?: DeploymentFilter, sort?: {
+        by: string;
+        order: 'asc' | 'desc';
+    }): Observable<any>;
     getDeployment(deploymentId: string): Observable<DeploymentInstance | null>;
     getDeploymentResources(deploymentId: string): Observable<any>;
-    getProcessDefinitions(page: number, size: number, filter?: ProcessDefinitionFilter): Observable<any>;
+    getProcessDefinitions(page: number, size: number, filter?: ProcessDefinitionFilter, sort?: {
+        by: string;
+        order: 'asc' | 'desc';
+    }): Observable<any>;
     getProcessDefinition(processDefinitionInstanceId: string): Observable<ProcessDefinitionInstance | null>;
     executeProcessDefinitionAction(processDefinitionInstanceId: string, action: string, includeProcesses: boolean): Observable<any>;
-    getProcesses(page: number, size: number, filter?: ProcessFilter): Observable<any>;
+    executeProcessAction(processInstanceId: string, action: 'suspend' | 'activate'): Observable<any>;
+    getProcesses(page: number, size: number, filter?: ProcessFilter, sort?: {
+        by: string;
+        order: 'asc' | 'desc';
+    }): Observable<any>;
     getProcess(processInstanceId: string): Observable<ProcessInstance | null>;
     getProcessHistory(processInstanceId: string): Observable<ProcessHistory | null>;
-    getTasks(page: number, size: number, filter?: TaskFilter): Observable<any>;
+    getTasks(page: number, size: number, filter?: TaskFilter, sort?: {
+        by: string;
+        order: 'asc' | 'desc';
+    }): Observable<any>;
     getTask(taskId: string): Observable<TaskInstance | null>;
     assignTask(taskId: string, assignee: string | null): Observable<any>;
     setTaskCandidates(taskId: string, body: {
         users?: string[];
         roles?: string[];
     }): Observable<any>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<YuvBpmAdminService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<YuvBpmAdminService>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<YuvBpmManagementService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<YuvBpmManagementService>;
 }
 
-export { APP_ICONS, APP_ID, FILTER_OPERATORS, FILTER_TYPES, ProcessDefinitionScope, ProcessDefinitionStatus, ProcessStatus, TaskStatus, YuvBpmAdminService, YuvBpmManagementRoutes, formatDateTime };
-export type { Column, ColumnFilter, DateColumnFilter, DateFormatType, DeploymentInstance, DeploymentResourceData, DeploymentsSearchResponse, FilterOption, FilterValue, NumberColumnFilter, Pagination, ProcessDefinitionInstance, ProcessDefinitionSearchResponse, ProcessHistory, ProcessInstance, ProcessVariable, ProcessdefinitionStatisticsData, ProcessesSearchResponse, ProcessinstanceCountData, SelectColumnFilter, TableFilters, TaskAssignmentHistoryEntry, TaskIdentityLinks, TaskInstance, TaskVariable, TasksSearchResponse, TextColumnFilter, UserColumnFilter };
+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 };
+export type { BadgeSeverity, BpmEntity, BpmItem, BpmManagementAppData, Column, ColumnFilter, DateColumnFilter, DateFormatType, DeploymentInstance, DeploymentResourceData, DeploymentsSearchResponse, FilterOption, FilterValue, NumberColumnFilter, Pagination, ProcessDefinitionInstance, ProcessDefinitionSearchResponse, ProcessHistory, ProcessInstance, ProcessVariable, ProcessdefinitionStatisticsData, ProcessesSearchResponse, ProcessinstanceCountData, SelectColumnFilter, TableFilters, TaskAssignmentHistoryEntry, TaskIdentityLinks, TaskInstance, TaskVariable, TasksSearchResponse, TextColumnFilter, UserColumnFilter };

package/yuv-manifest.json

@@ -1,13 +1,13 @@
 {
   "id": "io.yuuvis.app.bpm-management",
-  "title": "yuuvis BPM Admin",
+  "title": "yuuvis bpm-management",
   "ui": {
     "path": "bpm-management",
     "iconName": "flowchart",
-    "routes": "YuvBpmAdminRoutes",
+    "routes": "YuvBpmManagementRoutes",
     "options": {
       "appHeader": true
     }
   },
-  "extension": "YuvBpmAdminExtension"
+  "extension": "YuvBpmManagementExtension"
 }