@acorex/modules 21.0.0-next.57 → 21.0.0-next.59

package/types/acorex-modules-workflow-management.d.ts

@@ -1,17 +1,19 @@
 import { AXPEntity, AXPMenuProvider, AXPMenuProviderContext } from '@acorex/platform/common';
-import { AXPEntityDefinitionLoader, AXPEntityPreloadEntity, AXPEntityModel } from '@acorex/platform/layout/entity';
+import { AXPEntityDefinitionLoader, AXPEntityPreloadEntity, AXPEntityModel, AXPEntityService } from '@acorex/platform/layout/entity';
 import * as i0 from '@angular/core';
-import { Type, InjectionToken } from '@angular/core';
+import { Type, InjectionToken, Injector, EnvironmentProviders } from '@angular/core';
 import * as i1 from '@acorex/modules/calendar-management';
 import * as i2 from '@acorex/platform/domain';
 import * as i4 from '@acorex/platform/layout/widget-core';
 import { AXPWidgetNode } from '@acorex/platform/layout/widget-core';
-import { AXPActivityCategory, AXPActivityDefinition, AXPWorkflowDefinition, AXPWorkflowStatus, AXPWorkflowSubStatus, AXPWorkflowInstance, AXPActivityCategoryProvider, AXPActivityProvider } from '@acorex/platform/workflow';
+import { AXPActivityCategory, AXPActivityDefinition, AXPWorkflowDefinition, AXPWorkflowStatus, AXPWorkflowSubStatus, AXPWorkflowInstance, AXPActivityCategoryProvider, AXPActivityProvider, AXPWorkflowContinuationStepContext, AXPWorkflowContinuationHook, WorkflowResumeResult } from '@acorex/platform/workflow';
 import { AXPFilterClause, AXPExecuteCommandResult, AXPActionMenuItem, AXPExecuteCommand } from '@acorex/platform/core';
 import { AXPCommand } from '@acorex/platform/runtime';
 import { AXStyleColorType } from '@acorex/cdk/common';
 import { AXPopupSizeType } from '@acorex/components/popup';
-import { AXPWorkflowTaskProvider, AXPTaskFilter, AXPTask, AXPTaskActionMenuItem, AXPExtraField, AXPTaskStatus, AXPTaskPopoverComponent } from '@acorex/modules/task-management';
+import { AXPWorkflowTaskProvider, AXPTaskFilter, AXPTask, AXPTaskActionMenuItem, AXPExtraField, AXPTaskStatus, AXPTaskPopoverMetadata, AXPTaskPopoverComponent } from '@acorex/modules/task-management';
+import { AXPSessionService } from '@acorex/platform/auth';
+import * as _acorex_modules_workflow_management from '@acorex/modules/workflow-management';
 
 declare const RootConfig: {
     config: {
@@ -904,7 +906,7 @@ interface AXPGenericWorkflowTaskProviderConfig {
 }
 /**
  * Injection token for provider config. Use when registering via DI (provide token + useFactory with deps).
- * When creating via useFactory: () => new AXPGenericWorkflowTaskProvider({ ... }), config is passed in the closure.
+ * Prefer {@link provideGenericWorkflowTaskProvider} (dynamic import) instead of a static class import in NgModule providers.
  */
 declare const AXP_GENERIC_WORKFLOW_TASK_PROVIDER_CONFIG: InjectionToken<AXPGenericWorkflowTaskProviderConfig>;
 /**
@@ -929,32 +931,35 @@ declare class AXPGenericWorkflowTaskProvider extends AXPWorkflowTaskProvider<Rec
     private readonly workflowInstanceData;
     private readonly userEntityData;
     private readonly translationService;
+    private readonly formatService;
+    private readonly settingsService;
+    private readonly entityRegistry;
+    private readonly statusDefinitionService;
+    private readonly workflowDefinitionService;
     private readonly workflowManager;
+    private readonly humanTaskService;
     private readonly sessionService;
     private readonly toastService;
-    private readonly dialogService;
+    /** Primary entity type (with status plugin) inferred from the workflow definition. */
+    private primaryEntityTypeWithStatus;
+    /** Per-provider caches (one instance per workflow definition). */
+    private readonly entityDefinitionCache;
+    private readonly statusDefinitionKeyByEntityType;
+    private readonly statusProviderByDefinitionKey;
+    private readonly userReferenceCache;
+    private readonly entityStatusIdCache;
     constructor(config: AXPGenericWorkflowTaskProviderConfig);
     get name(): string;
     get title(): string;
     get icon(): string;
-    /**
-     * Bookmark types shown on the workflow task board.
-     */
+    /** Bookmark types shown on the workflow task board. */
     private isTaskBoardBookmarkPayload;
-    /**
-     * Pooled task: must be claimed before submit/cancel (cartable, or human-task with candidates only).
-     */
+    /** Pooled task: must be claimed before submit/cancel (cartable, or human-task with candidates only). */
     private isPooledClaimablePayload;
     private normalizeUserIdList;
-    /**
-     * Human-task assigned to another user; current user may take over when permitted.
-     */
+    /** Human-task assigned to another user; current user may take over when permitted. */
     private isReassignableHumanTaskPayload;
     private canTakeOverTask;
-    private showWorkflowTaskToast;
-    private confirmReassignToSelf;
-    private reassignTaskToSelf;
-    private resumeWorkflowTask;
     /**
      * Get tasks from suspended workflow instances.
      *
@@ -975,10 +980,8 @@ declare class AXPGenericWorkflowTaskProvider extends AXPWorkflowTaskProvider<Rec
      * Reads from instance.workflowInstance?.bookmarks — no direct DB access.
      */
     private getActiveBookmarksFromInstance;
-    /**
-     * Task-board reporter: signed-in user who is viewing the app (workflow initiator context).
-     */
-    private buildReporterFromSession;
+    /** Task-board "started by": workflow instance creator (initiator), not the current viewer. */
+    private buildStartedByFromInstance;
     /**
      * Builds interpolation params from `context._taskI18n` (workflow-defined; provider stays domain-agnostic).
      */
@@ -987,6 +990,12 @@ declare class AXPGenericWorkflowTaskProvider extends AXPWorkflowTaskProvider<Rec
      * Normalizes bookmark context values for i18n interpolation (strings or multi-language maps).
      */
     private toTaskTranslationParam;
+    /**
+     * Formats dates for task title/description interpolation using regional short-date settings.
+     */
+    private formatDateForTaskDisplay;
+    private isDateLikeString;
+    private parseIsoDateString;
     /**
      * Resolves task copy: literal strings pass through; keys starting with `@` are translated with context params.
      */
@@ -999,17 +1008,12 @@ declare class AXPGenericWorkflowTaskProvider extends AXPWorkflowTaskProvider<Rec
      * True when bookmark title is the generic activity label, not workflow-specific copy.
      */
     private isGenericHumanTaskTitle;
-    /**
-     * Resolve platform user id to a display label for the task board grid.
-     */
+    /** Resolve platform user id to a display label for the task board grid. */
     private resolveAssigneeReference;
-    /**
-     * Map bookmark to task board task format.
-     */
+    private loadUserReference;
+    /** Map bookmark to task board task format. */
     private mapBookmarkToTask;
-    /**
-     * Map priority to task board priority.
-     */
+    /** Map workflow bookmark priority to task board priority. */
     private mapPriorityToTaskPriority;
     /**
      * Update tasks (not applicable for workflow instances - they are read-only from task provider perspective).
@@ -1030,6 +1034,61 @@ declare class AXPGenericWorkflowTaskProvider extends AXPWorkflowTaskProvider<Rec
     getActions(task?: AXPTask<Record<string, any>>): Promise<AXPTaskActionMenuItem[]>;
     getExtraFields(): Promise<AXPExtraField[]>;
     getStatuses(): Promise<AXPTaskStatus[]>;
+    /** Resolves task status from bookmark context `statusId` and entity status plugin; falls back to workflow Pending. */
+    private resolveTaskStatus;
+    private resolveEntityTypeForTask;
+    /** True when a bookmark value was stored without expression evaluation. */
+    private isUnresolvedWorkflowExpression;
+    /**
+     * Loads `statusId` from the linked entity row when bookmark context omits or stale-fails it.
+     */
+    private loadEntityStatusIdFromContext;
+    /**
+     * Finds a row of `entityType` linked to this workflow instance (e.g. LifecycleEvent.workflowInfo.instanceId).
+     */
+    private loadEntityStatusIdByWorkflowInstance;
+    private fetchEntityStatusIdByWorkflowInstance;
+    private loadEntityStatusId;
+    private fetchEntityStatusIdByKey;
+    /** Fallback workflow task-board status when no entity status plugin applies. */
+    private getWorkflowPendingStatus;
+    private getWorkflowTaskStatuses;
+    private mapStatusProviderToTaskStatuses;
+    private translateStatusTitle;
+    private readContextString;
+    private parseQualifiedEntityType;
+    private resolveEntityDefinition;
+    private fetchEntityDefinition;
+    private getStatusPluginDefinitionKey;
+    private entityTypeHasStatusPlugin;
+    private getStatusDefinitionKeyForEntityType;
+    /**
+     * Warms status-definition-key cache for an entity type (call after resolveEntityDefinition).
+     */
+    private rememberStatusDefinitionKeyForEntityType;
+    private getEntityStatusProvider;
+    private getStatusProviderByDefinitionKey;
+    /** Maps entity status semantic colors to badge-layout tokens (`info` → `accent3`). */
+    private mapEntityStatusColorForBadge;
+    private findStatusDefinition;
+    private warmStatusDefinitionKeyCache;
+    /**
+     * First `entity-create` target in this workflow whose entity has a status plugin (cached per provider).
+     */
+    private resolvePrimaryEntityTypeForProvider;
+    getPopoverMetadata(task: AXPTask<Record<string, unknown>>): Promise<AXPTaskPopoverMetadata>;
+    /**
+     * Builds label/value metadata rows for the workflow task popover (view-mode widgets).
+     */
+    private buildPopoverMetadata;
+    private hasMeaningfulPopoverValue;
+    private formatUserReferenceLabel;
+    private resolveDueDate;
+    private resolveEffectiveDateValue;
+    /** Parses `yyyy-mm-dd` (and ISO date prefixes) in local time to avoid UTC day shifts in the date widget. */
+    private parseDateOnlyString;
+    private resolveTaskStatusColor;
+    private resolveTaskPriorityColor;
     getComponent(): (() => Promise<Type<AXPTaskPopoverComponent>>) | Type<AXPTaskPopoverComponent> | null;
     static ɵfac: i0.ɵɵFactoryDeclaration<AXPGenericWorkflowTaskProvider, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<AXPGenericWorkflowTaskProvider>;
@@ -1058,5 +1117,192 @@ declare const AXP_WORKFLOW_TASK_CONTEXT_I18N_KEY = "_taskI18n";
 /** Ordered segments joined with " — " when bookmark title is still a generic activity label. */
 declare const AXP_WORKFLOW_TASK_CONTEXT_TITLE_PARTS_KEY = "_taskTitleParts";
 
-export { AXCCategoryProvider, AXMMenuProvider, AXMPermissionsKeys, AXMWorkflowActivitiesDefinitionProvider, AXMWorkflowManagementModule, AXMWorkflowManagementModuleEntityProvider, AXPCreateEntityActivity, AXPGenericWorkflowTaskProvider, AXP_GENERIC_WORKFLOW_TASK_PROVIDER_CONFIG, AXP_WORKFLOW_TASK_CONTEXT_I18N_KEY, AXP_WORKFLOW_TASK_CONTEXT_TITLE_PARTS_KEY, CartableTaskActivity, CollectSignatureActivity, CreateEntityFormActivity, HumanTaskActivity, RootConfig, ShowConfirmPopupActivity, ShowLayoutPopupActivity, ShowToastActivity };
-export type { AXMWorkflowManagementActivityCategoryEntityModel, AXMWorkflowManagementActivityDefinitionEntityModel, AXMWorkflowManagementAutomationEntityModel, AXMWorkflowManagementWorkflowDefinitionEntityModel, AXMWorkflowManagementWorkflowInstanceEntityModel, AXPGenericWorkflowTaskProviderConfig, CartableTaskInput, CartableTaskOutput, CollectSignatureInput, CollectSignatureOutput, CreateEnityInput, CreateEnityOutput, CreateEntityFormInput, CreateEntityFormOutput, HumanTaskInput, HumanTaskOutput, ShowConfirmPopupInput, ShowConfirmPopupOutput, ShowLayoutPopupInput, ShowToastCommandInput, ShowToastEntityCommandEnvelope, ShowToastInput, ShowToastOutput };
+/** Minimal bookmark payload shape for continuation eligibility checks. */
+interface WorkflowTaskContinuationPayload {
+    activityType: string;
+    assignedUserIds?: string[] | null;
+    candidateUserIds?: string[] | null;
+}
+/** Bookmark row shape stored on WorkflowInstance.workflowInstance.bookmarks. */
+interface WorkflowTaskContinuationBookmark {
+    id: string;
+    activityId: string;
+    type: string;
+    payload?: Record<string, unknown> | null;
+    payloadJson?: string;
+    consumed?: boolean;
+    isConsumed?: boolean;
+    createdAt?: string;
+}
+interface WorkflowTaskContinuationContext {
+    instance: AXMWorkflowManagementWorkflowInstanceEntityModel;
+    bookmark: WorkflowTaskContinuationBookmark;
+    payload: WorkflowTaskContinuationPayload;
+    sessionService: AXPSessionService;
+    /** Bookmark id of the task that was just completed (excluded from next-step detection). */
+    completedBookmarkId?: string;
+    /** Activity id that was just completed (excluded from next-step detection). */
+    completedActivityId?: string;
+}
+/** Normalizes platform user id lists on bookmark payloads. */
+declare function normalizeWorkflowTaskUserIds(value: string[] | null | undefined): string[];
+/** Workflow instance creator (task-board "started by"). */
+declare function getWorkflowInstanceInitiatorUserId(instance: AXMWorkflowManagementWorkflowInstanceEntityModel): string | null;
+/** Demo/platform operator accounts that bypass permission checks in mock auth. */
+declare function isWorkflowPlatformRootUser(sessionService: AXPSessionService): boolean;
+/** Bookmark types rendered on the workflow task board. */
+declare function isWorkflowTaskBoardBookmarkPayload(payload: WorkflowTaskContinuationPayload): boolean;
+/** Pooled task that must be claimed before acting (no direct continuation offer). */
+declare function isWorkflowPooledClaimablePayload(payload: WorkflowTaskContinuationPayload): boolean;
+/** Human-task assigned to another user; may be taken over when permitted. */
+declare function isWorkflowReassignableHumanTaskPayload(payload: WorkflowTaskContinuationPayload): boolean;
+/** Parses bookmark payload from entity storage. */
+declare function parseWorkflowTaskContinuationPayload(bookmark: WorkflowTaskContinuationBookmark): WorkflowTaskContinuationPayload | null;
+/**
+ * Whether the workflow moved forward enough to prompt "continue to next step".
+ * Skips draft save / cancel on questionnaire (same human-task bookmark remains).
+ */
+declare function shouldOfferWorkflowContinuationAfterStep(context: AXPWorkflowContinuationStepContext, activeBookmarkActivityIds: string[]): boolean;
+/**
+ * Whether the UI should offer "continue to next step" after a successful resume.
+ *
+ * - Current user is the assignee (sequential tasks for the same person, e.g. line manager).
+ * - Workflow initiator and assignee are the same person and that person is the current user.
+ * - Current user may take over a human-task assigned to someone else.
+ */
+declare function shouldOfferWorkflowTaskContinuation(ctx: WorkflowTaskContinuationContext): boolean;
+/** True when the user must take over the next bookmark before acting on it. */
+declare function needsTakeOverForWorkflowTaskContinuation(ctx: WorkflowTaskContinuationContext): boolean;
+
+/**
+ * Offers "continue to next step" / take-over after workflow start, resume, and interactive chains.
+ * Uses {@link AXPWorkflowInstanceHumanTaskService} only — not task board or popover.
+ */
+declare class AXPWorkflowTaskContinuationService implements AXPWorkflowContinuationHook {
+    private readonly sessionService;
+    private readonly translationService;
+    private readonly dialogService;
+    private readonly humanTaskService;
+    private readonly bookmarkAccess;
+    offerAfterWorkflowStep(context: AXPWorkflowContinuationStepContext): Promise<void>;
+    private offerFromPendingNextTask;
+    private offerFromInstanceBookmarks;
+    private confirmAndAdvance;
+    private isCompletedBookmark;
+    private buildPayloadFromWorkflowTask;
+    private confirmContinueToNextStep;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXPWorkflowTaskContinuationService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AXPWorkflowTaskContinuationService>;
+}
+
+/** Bookmark row on WorkflowInstance.workflowInstance.bookmarks. */
+interface WorkflowInstanceBookmarkRow {
+    id: string;
+    activityId: string;
+    type: string;
+    payload?: Record<string, unknown> | null;
+    payloadJson?: string;
+    consumed?: boolean;
+    isConsumed?: boolean;
+}
+interface HumanTaskBookmarkPayload extends WorkflowTaskContinuationPayload {
+    activityType: string;
+    activityName: string;
+    taskToken: string;
+    title?: string;
+    description?: string;
+    actions?: {
+        prefix?: unknown[];
+        suffix?: unknown[];
+    };
+    context?: Record<string, unknown>;
+}
+declare function getActiveBookmarks(instance: AXMWorkflowManagementWorkflowInstanceEntityModel): WorkflowInstanceBookmarkRow[];
+/**
+ * Loads workflow instance entity rows (including embedded bookmarks).
+ */
+declare function createWorkflowInstanceBookmarkAccess(entityService?: AXPEntityService): {
+    loadInstance(instanceId: string): Promise<AXMWorkflowManagementWorkflowInstanceEntityModel | null>;
+    getActiveBookmarks: typeof getActiveBookmarks;
+    findActiveBookmark(instanceId: string, activityId: string): Promise<{
+        instance: AXMWorkflowManagementWorkflowInstanceEntityModel;
+        bookmark: WorkflowInstanceBookmarkRow;
+    } | null>;
+    parseHumanTaskPayload(bookmark: WorkflowInstanceBookmarkRow): HumanTaskBookmarkPayload | null;
+};
+type WorkflowInstanceBookmarkAccess = ReturnType<typeof createWorkflowInstanceBookmarkAccess>;
+
+interface ResumeSuspendedHumanTaskRequest {
+    instanceId: string;
+    bookmarkId: string;
+    activityId: string;
+    taskToken: string;
+    outcome: string;
+    userInput?: Record<string, unknown>;
+    /** When true, skips the post-resume "continue to next step?" prompt on this resume. */
+    suppressContinuation?: boolean;
+}
+/**
+ * Workflow-instance human-task operations (resume, take-over, primary action).
+ * Independent of task board / popover — task board delegates here for the same behavior.
+ */
+declare class AXPWorkflowInstanceHumanTaskService {
+    private readonly injector;
+    private readonly sessionService;
+    private readonly translationService;
+    private readonly dialogService;
+    private readonly toastService;
+    private readonly eventService;
+    private readonly workflowEngine;
+    private readonly bookmarkAccess;
+    /** Resolved lazily to avoid DI cycle with {@link AXPWorkflowManager} continuation hook. */
+    private get workflowManager();
+    /**
+     * Resumes a suspended human-task bookmark (runs interactive activities via the workflow manager).
+     */
+    resumeSuspendedHumanTask(request: ResumeSuspendedHumanTaskRequest): Promise<WorkflowResumeResult>;
+    /**
+     * Runs the first configured action on a suspended human-task bookmark (e.g. start-fill → questionnaire).
+     */
+    executePrimaryHumanTaskAction(instanceId: string, activityId: string, options?: {
+        suppressContinuation?: boolean;
+        notifyViews?: boolean;
+    }): Promise<WorkflowResumeResult | null>;
+    /**
+     * Reassigns a human-task bookmark to the current user (take over) without advancing the workflow.
+     */
+    reassignBookmarkToCurrentUser(instanceId: string, bookmarkId: string, activityId: string): Promise<boolean>;
+    /**
+     * Take over with confirmation dialog (task board "Take Over" action).
+     */
+    reassignBookmarkToCurrentUserWithConfirm(instanceId: string, bookmarkId: string, activityId: string): Promise<boolean>;
+    /** First action command name on the human-task bookmark (e.g. start-fill, approve). */
+    resolvePrimaryTaskOutcome(payload: HumanTaskBookmarkPayload): string;
+    private canTakeOver;
+    private confirmReassignToSelf;
+    private showResumeError;
+    private showToast;
+    /** Optional broadcast so open task-board views refresh; does not require task-board module at runtime. */
+    notifyWorkflowTaskViewsChanged(provider?: string): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<AXPWorkflowInstanceHumanTaskService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<AXPWorkflowInstanceHumanTaskService>;
+}
+
+/**
+ * Registers one workflow task provider for a single definition (lazy-loaded).
+ * Use in feature modules that need a dedicated task-board entry per workflow.
+ */
+declare function provideGenericWorkflowTaskProvider(config: AXPGenericWorkflowTaskProviderConfig): {
+    provide: i0.InjectionToken<AXPWorkflowTaskProvider<Record<string, any>>[] | Promise<AXPWorkflowTaskProvider<Record<string, any>>>[]>;
+    multi: boolean;
+    useFactory: (injector: Injector) => Promise<_acorex_modules_workflow_management.AXPGenericWorkflowTaskProvider>;
+    deps: (typeof Injector)[];
+};
+/**
+ * Registers one task provider per workflow definition (lazy-loaded).
+ * Discovers definitions via {@link AXPWorkflowDefinitionService} at first resolve.
+ */
+declare function provideTaskWorkflow(): EnvironmentProviders;
+
+export { AXCCategoryProvider, AXMMenuProvider, AXMPermissionsKeys, AXMWorkflowActivitiesDefinitionProvider, AXMWorkflowManagementModule, AXMWorkflowManagementModuleEntityProvider, AXPCreateEntityActivity, AXPGenericWorkflowTaskProvider, AXPWorkflowInstanceHumanTaskService, AXPWorkflowTaskContinuationService, AXP_GENERIC_WORKFLOW_TASK_PROVIDER_CONFIG, AXP_WORKFLOW_TASK_CONTEXT_I18N_KEY, AXP_WORKFLOW_TASK_CONTEXT_TITLE_PARTS_KEY, CartableTaskActivity, CollectSignatureActivity, CreateEntityFormActivity, HumanTaskActivity, RootConfig, ShowConfirmPopupActivity, ShowLayoutPopupActivity, ShowToastActivity, createWorkflowInstanceBookmarkAccess, getWorkflowInstanceInitiatorUserId, isWorkflowPlatformRootUser, isWorkflowPooledClaimablePayload, isWorkflowReassignableHumanTaskPayload, isWorkflowTaskBoardBookmarkPayload, needsTakeOverForWorkflowTaskContinuation, normalizeWorkflowTaskUserIds, parseWorkflowTaskContinuationPayload, provideGenericWorkflowTaskProvider, provideTaskWorkflow, shouldOfferWorkflowContinuationAfterStep, shouldOfferWorkflowTaskContinuation };
+export type { AXMWorkflowManagementActivityCategoryEntityModel, AXMWorkflowManagementActivityDefinitionEntityModel, AXMWorkflowManagementAutomationEntityModel, AXMWorkflowManagementWorkflowDefinitionEntityModel, AXMWorkflowManagementWorkflowInstanceEntityModel, AXPGenericWorkflowTaskProviderConfig, CartableTaskInput, CartableTaskOutput, CollectSignatureInput, CollectSignatureOutput, CreateEnityInput, CreateEnityOutput, CreateEntityFormInput, CreateEntityFormOutput, HumanTaskBookmarkPayload, HumanTaskInput, HumanTaskOutput, ResumeSuspendedHumanTaskRequest, ShowConfirmPopupInput, ShowConfirmPopupOutput, ShowLayoutPopupInput, ShowToastCommandInput, ShowToastEntityCommandEnvelope, ShowToastInput, ShowToastOutput, WorkflowInstanceBookmarkAccess, WorkflowInstanceBookmarkRow, WorkflowTaskContinuationBookmark, WorkflowTaskContinuationContext, WorkflowTaskContinuationPayload };