@acorex-platform/module-workflow-management-client 0.0.21

package/types/acorex-platform-module-workflow-management-client-contracts.d.ts

@@ -0,0 +1,341 @@
+import { AXPActivityCategory, AXPActivityDefinition, AXPFilterClause, AXPWorkflowDefinition, AXPMultiLanguageString, AXPWorkflowStatus, AXPWorkflowSubStatus, AXPWorkflowInstance } from '@acorex-platform/framework-shared/core';
+import { AXPEntityModel } from '@acorex-platform/framework-shared/entity';
+
+declare const AXPWorkflowManagementMenuKeys: {
+    readonly Root: "workflow-management:menu";
+    readonly Workflow: "workflow-management:workflow";
+    readonly WorkflowDefinitions: "workflow-management:workflow-definitions";
+    readonly WorkflowInstances: "workflow-management:workflow-instances";
+    readonly Activities: "workflow-management:activities";
+};
+
+/**
+ * Administration capabilities used by this module.
+ * Domain capability keys for this module. Root groups live in `AXPCommonPermissionGroupKeys` (common contracts).
+ */
+declare const AXPAdministrationPermissionKeys: {
+    readonly Access: "Administration:Permission:Access";
+    readonly MaintainUsersAndRoles: "Administration:Permission:MaintainUsersAndRoles";
+    readonly ManageSessions: "Administration:Permission:ManageSessions";
+    readonly MaintainPolicies: "Administration:Permission:MaintainPolicies";
+    readonly ViewIntegrations: "Administration:Permission:ViewIntegrations";
+    readonly MaintainConnections: "Administration:Permission:MaintainConnections";
+    readonly MaintainWorkflows: "Administration:Permission:MaintainWorkflows";
+    readonly ManageWorkflowActions: "Administration:Permission:ManageWorkflowActions";
+    readonly ViewRules: "Administration:Permission:ViewRules";
+    readonly MaintainRules: "Administration:Permission:MaintainRules";
+    readonly ManageRuleActions: "Administration:Permission:ManageRuleActions";
+    readonly MaintainAi: "Administration:Permission:MaintainAi";
+    readonly UseAiAssist: "Administration:Permission:UseAiAssist";
+    readonly MaintainDashboards: "Administration:Permission:MaintainDashboards";
+    readonly ViewJobs: "Administration:Permission:ViewJobs";
+    readonly ManageJobActions: "Administration:Permission:ManageJobActions";
+    readonly ViewObservability: "Administration:Permission:ViewObservability";
+    readonly MaintainObservability: "Administration:Permission:MaintainObservability";
+};
+/**
+ * @deprecated Prefer {@link AXPAdministrationPermissionKeys}.
+ * Legacy nested shape kept so existing imports compile during migration.
+ */
+declare const AXMPermissionsKeys: {
+    readonly WorkflowManagement: {
+        readonly Management: "Administration:Permission:MaintainWorkflows";
+    };
+    readonly WorkflowInstance: {
+        readonly ReassignToSelf: "Administration:Permission:ManageWorkflowActions";
+    };
+};
+
+declare const RootConfig: {
+    readonly config: {
+        i18n: string;
+        module: string;
+    };
+    readonly module: {
+        readonly route: "workflow-management";
+        readonly name: string;
+        readonly title: "@workflow-management:module.title";
+        readonly icon: "fa-light fa-diagram-project";
+    };
+    /** Task-board suspend activity type ids (match activity definition keys). */
+    readonly activities: {
+        readonly humanTask: "workflow-activity:human-task";
+        readonly cartable: "workflow-activity:cartable";
+    };
+    readonly entities: {
+        readonly workflowDefinition: {
+            readonly name: "WorkflowDefinition";
+            readonly fullName: `${string}.WorkflowDefinition`;
+            readonly title: "@workflow-management:workflow-definitions.entities.workflow-definition.title";
+            readonly titlePlural: "@workflow-management:workflow-definitions.entities.workflow-definition.plural";
+            readonly icon: "fa-light fa-diagram-project";
+        };
+        readonly workflowInstance: {
+            readonly name: "WorkflowInstance";
+            readonly fullName: `${string}.WorkflowInstance`;
+            readonly title: "@workflow-management:workflow-instances.entities.workflow-instance.title";
+            readonly titlePlural: "@workflow-management:workflow-instances.entities.workflow-instance.plural";
+            readonly icon: "fa-light fa-play-circle";
+        };
+        readonly activityDefinition: {
+            readonly name: "ActivityDefinition";
+            readonly fullName: `${string}.ActivityDefinition`;
+            readonly title: "@workflow-management:activities.entities.activity-definition.title";
+            readonly titlePlural: "@workflow-management:activities.entities.activity-definition.plural";
+            readonly icon: "fa-light fa-puzzle-piece";
+        };
+        readonly automation: {
+            readonly name: "Automation";
+            readonly fullName: `${string}.Automation`;
+            readonly title: "@workflow-management:automations.entities.automation.title";
+            readonly titlePlural: "@workflow-management:automations.entities.automation.plural";
+            readonly icon: "fa-light fa-bolt";
+        };
+    };
+    /**
+     * Live dashboard queries bound to base DashboardManagement chart/KPI widgets.
+     * Keys: `{module}:Dashboard:{Name}`.
+     */
+    readonly queries: {
+        readonly dashboard: {
+            readonly definitionsKpi: `${string}:Dashboard:DefinitionsKpi`;
+            readonly activitiesKpi: `${string}:Dashboard:ActivitiesKpi`;
+            readonly definitionsByStatusBar: `${string}:Dashboard:DefinitionsByStatusBar`;
+            readonly activitiesByCategoryDonut: `${string}:Dashboard:ActivitiesByCategoryDonut`;
+            readonly publishedDefinitionsGauge: `${string}:Dashboard:PublishedDefinitionsGauge`;
+            /** @deprecated Prefer {@link runningInstancesKpi} for runtime ops dashboards. */
+            readonly workflowDefinitionsKpi: `${string}:Dashboard:WorkflowDefinitionsKpi`;
+            /** @deprecated Prefer {@link instancesBySubStatusDonut} for runtime ops dashboards. */
+            readonly workflowsByStatusBar: `${string}:Dashboard:WorkflowsByStatusBar`;
+            readonly runningInstancesKpi: `${string}:Dashboard:RunningInstancesKpi`;
+            readonly faultedInstancesKpi: `${string}:Dashboard:FaultedInstancesKpi`;
+            readonly awaitingActionInstancesKpi: `${string}:Dashboard:AwaitingActionInstancesKpi`;
+            readonly startedTodayInstancesKpi: `${string}:Dashboard:StartedTodayInstancesKpi`;
+            readonly completedTodayInstancesKpi: `${string}:Dashboard:CompletedTodayInstancesKpi`;
+            readonly avgRunningAgeHoursKpi: `${string}:Dashboard:AvgRunningAgeHoursKpi`;
+            readonly instancesBySubStatusDonut: `${string}:Dashboard:InstancesBySubStatusDonut`;
+            readonly instancesByDefinitionBar: `${string}:Dashboard:InstancesByDefinitionBar`;
+            readonly instancesThroughputLine: `${string}:Dashboard:InstancesThroughputLine`;
+            readonly instancesByCurrentActivityBar: `${string}:Dashboard:InstancesByCurrentActivityBar`;
+            readonly instancesFaultHeatmap: `${string}:Dashboard:InstancesFaultHeatmap`;
+        };
+    };
+};
+
+/** Component key for the Workflow Instance Activity instances tab. Register via AXP_PAGE_COMPONENT_PROVIDER. */
+declare const WORKFLOW_INSTANCE_ACTIVITY_INSTANCES_PAGE_COMPONENT_KEY = "workflow-instance-activity-instances-page";
+
+/** Registry key for the workflow definition Activities custom page (linear graph editor). */
+declare const WORKFLOW_DEFINITION_ACTIVITIES_PAGE_COMPONENT_KEY = "workflow-definition-activities-page";
+
+/**
+ * Human-task / cartable `context` payload: technical ids at the root; display metadata under reserved keys.
+ *
+ * @example
+ * ```json
+ * {
+ *   "leaveRequestId": "{{ variables.leaveRequestId }}",
+ *   "_taskI18n": {
+ *     "employeeDisplayName": "{{ variables.employeeDisplayName }}",
+ *     "leaveTypeTitle": "{{ variables.leaveTypeTitle }}"
+ *   },
+ *   "_taskTitleParts": [
+ *     "{{ variables.employeeDisplayName }}",
+ *     "{{ variables.leaveTypeTitle }}"
+ *   ]
+ * }
+ * ```
+ */
+/** Interpolation map for `@scope:key` task title and description strings. */
+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";
+
+interface AXMWorkflowManagementActivityCategoryEntityModel extends AXPEntityModel<string>, AXPActivityCategory {
+    id: string;
+}
+
+interface AXMWorkflowManagementActivityDefinitionEntityModel extends AXPEntityModel<string>, AXPActivityDefinition {
+}
+
+/**
+ * Reusable automation entity model.
+ * refType + refId reference any parent entity (e.g. AssessmentManagement.Questionnaire, refId = questionnaire id).
+ */
+interface AXMWorkflowManagementAutomationEntityModel extends AXPEntityModel<string> {
+    /** Entity type of the parent record (e.g. "AssessmentManagement.Questionnaire"). */
+    refType: string;
+    /** Parent record id. */
+    refId: string;
+    name?: string;
+    title?: string;
+    description?: string;
+    condition: AXPFilterClause;
+    /** Activity/command key and parameters (from activity-command-configurator). */
+    command: {
+        key: string;
+        title?: string;
+        payload?: Record<string, unknown>;
+    };
+}
+
+/**
+ * Workflow Definition Entity Model.
+ *
+ * Extends AXPWorkflowDefinition directly - all workflow definition fields are available.
+ * System fields are managed by entity system.
+ */
+interface AXMWorkflowManagementWorkflowDefinitionEntityModel extends AXPEntityModel<string>, AXPWorkflowDefinition {
+    /**
+     * Entity ID (from AXPEntityModel) - unique ID for this workflow definition version
+     */
+    id: string;
+    /**
+     * Schema reference (system field - set automatically).
+     */
+    $schema?: string;
+    /**
+     * Tenant ID (system field - set automatically).
+     */
+    tenantId?: string | null;
+    /**
+     * Creation timestamp (from AXPEntityModel).
+     */
+    createdAt: string;
+    /**
+     * Version number (system field - managed automatically).
+     */
+    version: number;
+    /**
+     * Tool version (system field - set automatically).
+     */
+    toolVersion?: string | null;
+    /**
+     * Whether this is the latest version (system field - managed automatically).
+     */
+    isLatest: boolean;
+    /**
+     * Publication lifecycle (draft, pending-review, published, archived) via status plugin.
+     */
+    statusId: string;
+    /** Registered catalog scope keys (module providers). */
+    catalogScopeKeys?: string[];
+    /** Resolved scope labels for list display (enriched by catalog-scope resolver middleware). */
+    catalogScopes?: Array<{
+        name: string;
+        title: AXPMultiLanguageString | string;
+        cssClass?: string;
+    }>;
+}
+
+/**
+ * Workflow Instance Entity Model.
+ *
+ * Extends AXPWorkflowInstance with entity-specific fields for UI.
+ */
+interface AXMWorkflowManagementWorkflowInstanceEntityModel extends AXPEntityModel<string> {
+    /**
+     * Workflow definition ID (logical ID, same across versions)
+     */
+    definitionId: string;
+    /**
+     * Workflow definition version ID
+     */
+    definitionVersionId: string;
+    /**
+     * Workflow definition version number
+     */
+    version: number;
+    /**
+     * Workflow status
+     */
+    status: AXPWorkflowStatus;
+    /**
+     * Workflow sub-status
+     */
+    subStatus: AXPWorkflowSubStatus;
+    /**
+     * Correlation ID (for tracking related workflows)
+     */
+    correlationId?: string;
+    /**
+     * Instance name
+     */
+    name?: string;
+    /**
+     * Incident count (errors/faults)
+     */
+    incidentCount: number;
+    /**
+     * Parent workflow instance ID (for child workflows)
+     */
+    parentWorkflowInstanceId?: string;
+    /**
+     * Creation timestamp
+     */
+    createdAt: string;
+    /**
+     * Last update timestamp
+     */
+    updatedAt: string;
+    /**
+     * Finished timestamp (null if still running)
+     */
+    finishedAt?: string;
+    /**
+     * Full workflow instance (stored as JSON)
+     */
+    workflowInstance?: AXPWorkflowInstance;
+    /**
+     * Entity reference type
+     */
+    entityRefType?: string;
+    /**
+     * Entity reference ID
+     */
+    entityRefId?: string;
+    /**
+     * Human-readable combined status (status + subStatus) for overview display.
+     */
+    statusDisplay?: string;
+    /**
+     * Current step index (1-based) for progress display.
+     */
+    currentStepIndex?: number;
+    /**
+     * Total number of steps in the workflow (for progress display).
+     */
+    totalSteps?: number;
+    /**
+     * Progress percentage (0–100) for progress bar widget.
+     */
+    progressPercentage?: number;
+    /**
+     * Display title for the workflow (name or definitionId).
+     */
+    workflowTitle?: string;
+    /**
+     * Workflow variables table for UI: name (key), title (from definition), value (formatted for display).
+     */
+    workflowVariablesTable?: {
+        name: string;
+        title: string;
+        value: string;
+    }[];
+    /**
+     * Primary user for assignee / last-action column (lookup id).
+     */
+    assignUser?: {
+        id: string;
+    };
+    /**
+     * Hydrated lookup snapshot for list columns (`expose` targets).
+     */
+    assignUserRef?: {
+        id: string;
+        displayName: string;
+    };
+}
+
+export { AXMPermissionsKeys, AXPAdministrationPermissionKeys, AXPWorkflowManagementMenuKeys, AXP_WORKFLOW_TASK_CONTEXT_I18N_KEY, AXP_WORKFLOW_TASK_CONTEXT_TITLE_PARTS_KEY, RootConfig, WORKFLOW_DEFINITION_ACTIVITIES_PAGE_COMPONENT_KEY, WORKFLOW_INSTANCE_ACTIVITY_INSTANCES_PAGE_COMPONENT_KEY };
+export type { AXMWorkflowManagementActivityCategoryEntityModel, AXMWorkflowManagementActivityDefinitionEntityModel, AXMWorkflowManagementAutomationEntityModel, AXMWorkflowManagementWorkflowDefinitionEntityModel, AXMWorkflowManagementWorkflowInstanceEntityModel };