@rytass/bpm-core-nestjs-module 0.5.0 → 0.5.1

package/src/lib/workflow-engine/workflow-engine.service.d.ts

@@ -0,0 +1,188 @@
+import { Repository } from 'typeorm';
+import { AttachmentService } from '../attachment/attachment.service';
+import { DelegationService } from '../delegation/delegation.service';
+import { FormDefinitionVersionEntity } from '../form/form-definition-version.entity';
+import { NotificationService } from '../notification/notification.service';
+import { NotificationEntity } from '../notification/notification.entity';
+import { NotificationChannelEnum } from '../notification/notification.enums';
+import { SignatureService } from '../signature/signature.service';
+import { ConditionService } from '../condition/condition.service';
+import { BPMAuthContext } from '../bpm-auth';
+import { ApprovalTemplateVersionEntity } from '../template/approval-template-version.entity';
+import { ApprovalTemplateEntity } from '../template/approval-template.entity';
+import { CancelApprovalInstanceInput } from './dto/cancel-approval-instance.input';
+import { DecideTaskInput } from './dto/decide-task.input';
+import { DryRunApprovalWorkflowInput } from './dto/dry-run-approval-workflow.input';
+import { ResubmitApprovalInstanceInput } from './dto/resubmit-approval-instance.input';
+import { SubmitApprovalInstanceInput } from './dto/submit-approval-instance.input';
+import { ActivityLogEntity } from './activity-log.entity';
+import { AdhocDirectiveEntity } from './adhoc-directive.entity';
+import { AdhocDirectiveTypeEnum, AdhocPreApprovalRejectBehaviorEnum } from './adhoc.enums';
+import { AdhocTargetInput } from './dto/adhoc-target.input';
+import { ApprovalInstanceEntity } from './approval-instance.entity';
+import { TaskDecisionEntity } from './task-decision.entity';
+import { TaskCandidateEntity } from './task-candidate.entity';
+import { TaskEntity } from './task.entity';
+import { ApprovalInstanceListViewEnum, ApprovalInstanceStateEnum } from './workflow-engine.enums';
+import { WorkflowDryRunResultObject } from './workflow-dry-run.object';
+import { BPMWorkflowServiceTaskDispatcher } from './workflow-service-task-dispatcher.token';
+import { WorkflowTokenEntity } from './workflow-token.entity';
+interface ListApprovalInstancesOptions {
+    readonly page?: number;
+    readonly pageSize?: number;
+    readonly searchText?: string;
+    readonly state?: readonly ApprovalInstanceStateEnum[];
+    readonly templateId?: string;
+    readonly view?: ApprovalInstanceListViewEnum;
+}
+interface WorkflowDashboardSummaryOptions {
+    readonly from?: Date;
+    readonly to?: Date;
+}
+type WorkflowReadScope = BPMAuthContext;
+export declare class WorkflowEngineService {
+    private readonly approvalInstanceRepository;
+    private readonly workflowTokenRepository;
+    private readonly taskRepository;
+    private readonly taskCandidateRepository;
+    private readonly taskDecisionRepository;
+    private readonly notificationRepository;
+    private readonly activityLogRepository;
+    private readonly adhocDirectiveRepository;
+    private readonly approvalTemplateRepository;
+    private readonly approvalTemplateVersionRepository;
+    private readonly formDefinitionVersionRepository;
+    private readonly attachmentService;
+    private readonly conditionService;
+    private readonly delegationService;
+    private readonly notificationService;
+    private readonly signatureService;
+    private readonly serviceTaskDispatcher;
+    constructor(approvalInstanceRepository: Repository<ApprovalInstanceEntity>, workflowTokenRepository: Repository<WorkflowTokenEntity>, taskRepository: Repository<TaskEntity>, taskCandidateRepository: Repository<TaskCandidateEntity>, taskDecisionRepository: Repository<TaskDecisionEntity>, notificationRepository: Repository<NotificationEntity>, activityLogRepository: Repository<ActivityLogEntity>, adhocDirectiveRepository: Repository<AdhocDirectiveEntity>, approvalTemplateRepository: Repository<ApprovalTemplateEntity>, approvalTemplateVersionRepository: Repository<ApprovalTemplateVersionEntity>, formDefinitionVersionRepository: Repository<FormDefinitionVersionEntity>, attachmentService: AttachmentService, conditionService: ConditionService, delegationService: DelegationService, notificationService: NotificationService, signatureService: SignatureService, serviceTaskDispatcher?: BPMWorkflowServiceTaskDispatcher);
+    submitApprovalInstance(input: SubmitApprovalInstanceInput): Promise<ApprovalInstanceEntity>;
+    processInstance(instanceId: string): Promise<void>;
+    decideTask(input: DecideTaskInput): Promise<TaskDecisionEntity>;
+    cancelApprovalInstance(input: CancelApprovalInstanceInput): Promise<ApprovalInstanceEntity>;
+    resubmitApprovalInstance(input: ResubmitApprovalInstanceInput): Promise<ApprovalInstanceEntity>;
+    requestAdhocCountersign({ comment, requestedByMemberId, target, taskId, }: {
+        readonly comment?: string | null;
+        readonly requestedByMemberId: string;
+        readonly target: AdhocTargetInput;
+        readonly taskId: string;
+    }): Promise<AdhocDirectiveEntity>;
+    requestAdhocPreApproval({ comment, onReject, requestedByMemberId, target, taskId, }: {
+        readonly comment?: string | null;
+        readonly onReject: AdhocPreApprovalRejectBehaviorEnum;
+        readonly requestedByMemberId: string;
+        readonly target: AdhocTargetInput;
+        readonly taskId: string;
+    }): Promise<TaskEntity>;
+    configureAdhocNotification({ channels, requestedByMemberId, target, taskId, type, }: {
+        readonly channels?: readonly NotificationChannelEnum[] | null;
+        readonly requestedByMemberId: string;
+        readonly target: AdhocTargetInput;
+        readonly taskId: string;
+        readonly type: AdhocDirectiveTypeEnum.COMPLETION_NOTIFY | AdhocDirectiveTypeEnum.STAGE_NOTIFY;
+    }): Promise<AdhocDirectiveEntity>;
+    cancelAdhocDirective({ cancelledByMemberId, directiveId, }: {
+        readonly cancelledByMemberId: string;
+        readonly directiveId: string;
+    }): Promise<AdhocDirectiveEntity>;
+    listAdhocDirectives(instanceId: string, scope?: WorkflowReadScope): Promise<readonly AdhocDirectiveEntity[]>;
+    private readTaskActorContext;
+    private loadAdhocOperationContext;
+    private recordAdhocDirectiveActivity;
+    private createAdhocTaskForDirective;
+    private spawnCountersignTasksForNode;
+    private hasOpenTasksForTokenNode;
+    private handleAdhocPreApprovalRejection;
+    private readOpenTaskRecipientMemberIds;
+    private dispatchAdhocStageNotifications;
+    private dispatchAdhocCompletionNotifications;
+    private dispatchAdhocDirectiveNotification;
+    private cancelPendingAdhocDirectives;
+    dryRunApprovalWorkflow(input: DryRunApprovalWorkflowInput): WorkflowDryRunResultObject;
+    private simulateWorkflow;
+    private simulateWorkflowPath;
+    private readDryRunAvailableOutgoingEdges;
+    private evaluateDryRunEdge;
+    private resolveDryRunAssigneeMemberId;
+    getApprovalInstance(id: string, scope?: WorkflowReadScope): Promise<ApprovalInstanceEntity>;
+    listApprovalInstances(scope?: WorkflowReadScope, options?: ListApprovalInstancesOptions): Promise<readonly ApprovalInstanceEntity[]>;
+    countApprovalInstances(scope?: WorkflowReadScope, options?: Omit<ListApprovalInstancesOptions, 'page' | 'pageSize'>): Promise<number>;
+    readApprovalInstancePageInfo(scope?: WorkflowReadScope, options?: ListApprovalInstancesOptions): Promise<{
+        readonly hasNextPage: boolean;
+        readonly hasPreviousPage: boolean;
+        readonly page: number;
+        readonly pageSize: number;
+        readonly totalCount: number;
+        readonly totalPages: number;
+    }>;
+    private createFilteredApprovalInstanceQueryBuilder;
+    private applyReadableInstanceFilter;
+    readWorkflowDashboardSummary(scope?: WorkflowReadScope, options?: WorkflowDashboardSummaryOptions): Promise<{
+        readonly activeInstanceCount: number;
+        readonly completedInstanceCount: number;
+        readonly overdueTaskCount: number;
+        readonly pendingTaskCount: number;
+        readonly rejectedInstanceCount: number;
+        readonly totalInstanceCount: number;
+    }>;
+    listLaunchableApprovalTemplates(memberId: string): Promise<readonly ApprovalTemplateEntity[]>;
+    listWorkflowTokens(instanceId: string, scope?: WorkflowReadScope): Promise<readonly WorkflowTokenEntity[]>;
+    listTasks(instanceId: string, scope?: WorkflowReadScope): Promise<readonly TaskEntity[]>;
+    listInboxTasks(assigneeMemberId: string): Promise<readonly TaskEntity[]>;
+    listApprovalHistoryTasks(assigneeMemberId: string): Promise<readonly TaskEntity[]>;
+    listTaskDecisions(taskId: string, scope?: WorkflowReadScope): Promise<readonly TaskDecisionEntity[]>;
+    listTaskCandidates(taskId: string, scope?: WorkflowReadScope): Promise<readonly TaskCandidateEntity[]>;
+    private attachTaskCandidateSummaries;
+    private readDefaultInitiatorMetadataSnapshot;
+    listActivityLogs(instanceId: string, scope?: WorkflowReadScope): Promise<readonly ActivityLogEntity[]>;
+    private assertTaskReadable;
+    private isApprovalInstanceReadableByMember;
+    private processActiveToken;
+    private processRunningInstance;
+    private completeInstanceIfNoOpenRuntimeState;
+    private isNodeEntryReady;
+    private advanceTokenToOutgoingNodes;
+    private isNodeEntryConditionMet;
+    private skipNodeByEntryCondition;
+    private readAvailableOutgoingEdges;
+    private evaluateWorkflowEdge;
+    private readLastDecisionContext;
+    private advanceTokenAlongEdge;
+    private forkTokenAlongEdges;
+    private completeTokenAtEndNode;
+    private createUserTaskForToken;
+    private markTaskCandidateDecision;
+    private transferTask;
+    private resolveRuntimeTaskCandidates;
+    private applyDelegationToResolvedCandidates;
+    private resolveApproverResolver;
+    private resolvePositionCandidates;
+    private resolveInitiatorManagerCandidates;
+    private resolveFallbackAssignee;
+    private resolveManagerMemberIdsFromOrganization;
+    private resolveManagerMemberIdsAtLevel;
+    private resolveDirectManagerMemberIds;
+    private resolveOrgUnitManagerCandidates;
+    private readOrgUnitAndAncestorIds;
+    private resolveManagerResolutionCandidates;
+    private resolveOrgUnitMemberCandidates;
+    private resolveOrgUnitPositionCandidates;
+    private readOrgUnitScopeIds;
+    private processExclusiveGateway;
+    private executeServiceTask;
+    private rejectInstance;
+    private returnInstanceToNode;
+    private readLatestReturnedInstanceContext;
+    private resumeReturnedInstanceFromReturnPoint;
+    private consumeOpenRuntimeState;
+    private consumeJoinedTokens;
+    private cancelAlternativeTokensForOrTrigger;
+    private closeTaskCandidates;
+    private getTemplateOrThrow;
+    private getPublishedTemplateVersionOrThrow;
+    private getPublishedFormVersionOrThrow;
+}
+export {};