@acorex-platform/framework-server 0.0.10

package/workflow/src/lib/runtime/workflow-runtime.types.d.ts

@@ -0,0 +1,263 @@
+import type { AXPWorkflowContinuationMetadata } from '../activity/activity.types';
+/**
+ * Represents a workflow task that needs to be executed.
+ * Inspired by Temporal's Activity Tasks and Camunda's External Tasks.
+ */
+export interface AXPWorkflowTask {
+    /**
+     * Unique token for this task (used for completion/security).
+     */
+    taskToken: string;
+    /**
+     * Activity ID from workflow definition.
+     */
+    activityId: string;
+    /**
+     * Activity type (e.g., 'workflow-activity:show-toast').
+     */
+    activityType: string;
+    /**
+     * Human-readable activity name.
+     */
+    activityName?: string;
+    /**
+     * Where this task should be executed.
+     * - 'frontend': Execute in browser (UI activities, console, events)
+     * - 'backend': Execute in backend (business logic, API calls)
+     * - 'both': Execute in both frontend and backend (hybrid activities)
+     */
+    executionMode: 'frontend' | 'backend' | 'both';
+    /**
+     * Type of task for inbox handling.
+     */
+    taskType?: 'human-task' | 'ui-activity' | 'system-activity';
+    /**
+     * Input data for the activity (for frontend activities).
+     */
+    input?: Record<string, any>;
+    /**
+     * Configuration for the activity (for frontend activities).
+     */
+    config?: Record<string, any>;
+    /**
+     * Continuation UX copied from the activity definition at task creation time.
+     */
+    continuation?: AXPWorkflowContinuationMetadata;
+}
+/**
+ * Request to start a workflow instance.
+ */
+export interface AXPStartWorkflowRequest {
+    /**
+     * Workflow ID to execute.
+     */
+    workflowId: string;
+    /**
+     * Initial input data for workflow.
+     */
+    input: Record<string, any>;
+}
+/**
+ * Response after starting workflow instance.
+ */
+export interface AXPStartWorkflowResponse {
+    /**
+     * Unique instance ID for this workflow run.
+     */
+    instanceId: string;
+    /**
+     * Current workflow state.
+     */
+    state: AXPWorkflowInstanceState;
+    /**
+     * First task to execute (determined by backend).
+     * Client should execute this task based on executionMode.
+     */
+    pendingTask?: AXPWorkflowTask | null;
+    /**
+     * Activity outputs map (activityId -> output).
+     * Returned for expression evaluation in subsequent activities.
+     */
+    activityOutputs?: Record<string, any>;
+    /**
+     * Last activity output (convenience).
+     * Prefer using `activityOutputs[activityId]` when possible.
+     */
+    lastActivityOutput?: any;
+}
+/**
+ * Request to resume a suspended workflow.
+ */
+export interface AXPResumeWorkflowRequest {
+    /**
+     * Instance ID.
+     */
+    instanceId: string;
+    /**
+     * Step ID that was waiting for user input.
+     */
+    stepId: string;
+    /**
+     * Secure task token issued with the pending task.
+     * Backend validates and resolves the step using this token.
+     */
+    taskToken: string;
+    /**
+     * User action outcome (e.g., 'Confirmed', 'Cancelled').
+     */
+    outcome?: string;
+    /**
+     * Optional user input data.
+     */
+    userInput?: any;
+}
+/**
+ * Response after resuming workflow.
+ */
+export interface AXPResumeWorkflowResponse {
+    /**
+     * Activity execution output.
+     */
+    output: any;
+    /**
+     * Activity execution outcomes.
+     */
+    outcomes: Record<string, any>;
+    /**
+     * Next task to execute (if any).
+     */
+    nextTask?: AXPWorkflowTask | null;
+    /**
+     * Updated workflow state.
+     */
+    state: AXPWorkflowInstanceState;
+}
+/**
+ * Request to get workflow instance state.
+ */
+export interface AXPGetWorkflowStateRequest {
+    /**
+     * Instance ID.
+     */
+    instanceId: string;
+}
+/**
+ * Workflow instance state (managed by backend, cached in client).
+ */
+export interface AXPWorkflowInstanceState {
+    /**
+     * Unique instance ID.
+     */
+    instanceId: string;
+    /**
+     * Workflow ID.
+     */
+    workflowId: string;
+    /**
+     * Current instance status.
+     */
+    status: 'running' | 'completed' | 'suspended' | 'error';
+    /**
+     * Current step ID (if suspended or running).
+     */
+    currentStepId?: string;
+    /**
+     * Workflow variables (state).
+     */
+    variables: Record<string, any>;
+    /**
+     * Activity outputs map (activityId -> output).
+     * Used by expression evaluation scope as `outputs.activityId`.
+     */
+    activityOutputs?: Record<string, any>;
+    /**
+     * Last activity output (convenience).
+     * Useful when the next activity needs a quick access to the previous result.
+     */
+    lastActivityOutput?: any;
+    /**
+     * Initial input data.
+     */
+    input: Record<string, any>;
+    /**
+     * Final output data (if completed).
+     */
+    output?: Record<string, any>;
+    /**
+     * Last update timestamp.
+     */
+    lastUpdated: Date;
+}
+export interface AXPFrontActivityCompleteRequest {
+    /**
+     * Instance ID.
+     */
+    instanceId: string;
+    activityNode: string;
+    output: Record<string, any>;
+    outcome?: string;
+}
+export interface AXPFrontActivityCompleteResponse {
+    /**
+     * Activity execution output.
+     */
+    output?: any;
+    /**
+     * Activity execution outcomes.
+     */
+    outcomes?: Record<string, any>;
+    /**
+     * Next task to execute (if any).
+     */
+    nextTask?: AXPWorkflowTask | null;
+    /**
+     * Updated workflow state.
+     */
+    state?: AXPWorkflowInstanceState;
+}
+/**
+ * Activity types that use the task board (suspend until user acts via inbox), not inline interactive execution.
+ */
+export declare const AXP_WORKFLOW_TASK_BOARD_ACTIVITY_TYPES: readonly string[];
+export declare function axpIsWorkflowTaskBoardActivityType(activityType: string | undefined | null): boolean;
+/**
+ * Claim a pooled workflow task (updates bookmark assignee without resuming the workflow).
+ */
+export interface AXPClaimWorkflowTaskRequest {
+    instanceId: string;
+    bookmarkId: string;
+    stepId: string;
+}
+export interface AXPClaimWorkflowTaskResponse {
+    success: boolean;
+    error?: string;
+    errorCode?: string;
+}
+/**
+ * Reassign a human-task bookmark to the current user without resuming the workflow.
+ */
+export interface AXPReassignWorkflowTaskToSelfRequest {
+    instanceId: string;
+    bookmarkId: string;
+    stepId: string;
+}
+export interface AXPReassignWorkflowTaskToSelfResponse {
+    success: boolean;
+    error?: string;
+    errorCode?: string;
+}
+/** Restore task-board visibility after the user declines a pre-interactive continuation prompt. */
+export interface AXPRevertResumeAfterDeclinedInteractiveContinuationRequest {
+    instanceId: string;
+    /** Human-task / cartable step that was resumed from the task board. */
+    suspendedStepId: string;
+    /** Inline frontend step that was about to run when the user declined. */
+    abortedStepId?: string;
+    /** Bookmark id of the suspended step (when known). */
+    bookmarkId?: string;
+}
+export interface AXPRevertResumeAfterDeclinedInteractiveContinuationResponse {
+    success: boolean;
+    state?: AXPWorkflowInstanceState;
+    error?: string;
+}

package/workflow/src/lib/runtime/workflow-runtime.types.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AXP_WORKFLOW_TASK_BOARD_ACTIVITY_TYPES = void 0;
+exports.axpIsWorkflowTaskBoardActivityType = axpIsWorkflowTaskBoardActivityType;
+/**
+ * Activity types that use the task board (suspend until user acts via inbox), not inline interactive execution.
+ */
+exports.AXP_WORKFLOW_TASK_BOARD_ACTIVITY_TYPES = [
+    'workflow-activity:human-task',
+    'workflow-activity:cartable',
+];
+function axpIsWorkflowTaskBoardActivityType(activityType) {
+    return !!activityType && exports.AXP_WORKFLOW_TASK_BOARD_ACTIVITY_TYPES.includes(activityType);
+}
+//# sourceMappingURL=workflow-runtime.types.js.map

package/workflow/src/lib/runtime/workflow-runtime.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow-runtime.types.js","sourceRoot":"","sources":["../../../../../../../../libs/framework/server/workflow/src/lib/runtime/workflow-runtime.types.ts"],"names":[],"mappings":";;;AAiRA,gFAEC;AAVD;;GAEG;AACU,QAAA,sCAAsC,GAAsB;IACvE,8BAA8B;IAC9B,4BAA4B;CAC7B,CAAC;AAEF,SAAgB,kCAAkC,CAAC,YAAuC;IACxF,OAAO,CAAC,CAAC,YAAY,IAAI,8CAAsC,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;AACzF,CAAC"}

package/workflow/src/lib/utils/multilanguage.util.d.ts

@@ -0,0 +1,2 @@
+import type { AXPMultiLanguageString } from '../runtime/platform-core.types';
+export declare function resolveMultiLanguageString(value: AXPMultiLanguageString | null | undefined, locale?: string): string;

package/workflow/src/lib/utils/multilanguage.util.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveMultiLanguageString = resolveMultiLanguageString;
+//#region ---- Multi-language string resolution ----
+function resolveMultiLanguageString(value, locale = 'en-US') {
+    if (value == null) {
+        return '';
+    }
+    if (typeof value === 'string') {
+        return value.trim();
+    }
+    const record = value;
+    const direct = record[locale] ?? record['en-US'] ?? record['fa-IR'];
+    if (typeof direct === 'string' && direct.trim().length > 0) {
+        return direct.trim();
+    }
+    const first = Object.values(record).find((v) => typeof v === 'string' && v.trim().length > 0);
+    return typeof first === 'string' ? first.trim() : '';
+}
+//#endregion
+//# sourceMappingURL=multilanguage.util.js.map

package/workflow/src/lib/utils/multilanguage.util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"multilanguage.util.js","sourceRoot":"","sources":["../../../../../../../../libs/framework/server/workflow/src/lib/utils/multilanguage.util.ts"],"names":[],"mappings":";;AAIA,gEAiBC;AAnBD,oDAAoD;AAEpD,SAAgB,0BAA0B,CACxC,KAAgD,EAChD,MAAM,GAAG,OAAO;IAEhB,IAAI,KAAK,IAAI,IAAI,EAAE,CAAC;QAClB,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,OAAO,KAAK,CAAC,IAAI,EAAE,CAAC;IACtB,CAAC;IACD,MAAM,MAAM,GAAG,KAA+B,CAAC;IAC/C,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC;IACpE,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC3D,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC;IACvB,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;IAC9F,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;AACvD,CAAC;AAED,YAAY"}

package/workflow/src/lib/utils/uuid.util.d.ts

@@ -0,0 +1 @@
+export declare function generateUuid(): string;

package/workflow/src/lib/utils/uuid.util.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateUuid = generateUuid;
+const crypto_1 = require("crypto");
+//#region ---- UUID ----
+function generateUuid() {
+    return (0, crypto_1.randomUUID)();
+}
+//#endregion
+//# sourceMappingURL=uuid.util.js.map

package/workflow/src/lib/utils/uuid.util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uuid.util.js","sourceRoot":"","sources":["../../../../../../../../libs/framework/server/workflow/src/lib/utils/uuid.util.ts"],"names":[],"mappings":";;AAIA,oCAEC;AAND,mCAAoC;AAEpC,wBAAwB;AAExB,SAAgB,YAAY;IAC1B,OAAO,IAAA,mBAAU,GAAE,CAAC;AACtB,CAAC;AAED,YAAY"}

package/workflow/src/lib/workflow.module.d.ts

@@ -0,0 +1,2 @@
+export declare class WorkflowModule {
+}

package/workflow/src/lib/workflow.module.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkflowModule = void 0;
+const tslib_1 = require("tslib");
+const common_1 = require("@nestjs/common");
+const bullmq_1 = require("@nestjs/bullmq");
+const schedule_1 = require("@nestjs/schedule");
+const core_1 = require("@acorex-platform/framework-server/core");
+const activities_1 = require("./activities");
+const workflow_job_dispatcher_service_1 = require("./jobs/workflow-job-dispatcher.service");
+const workflow_maintenance_scheduler_1 = require("./jobs/workflow-maintenance.scheduler");
+const workflow_start_processor_1 = require("./jobs/workflow-start.processor");
+const workflow_jobs_constants_1 = require("./jobs/workflow-jobs.constants");
+const workflow_redis_config_1 = require("./jobs/workflow-redis.config");
+const automation_command_middleware_1 = require("./middlewares/automation-command.middleware");
+const document_workflow_trigger_middleware_1 = require("./middlewares/document-workflow-trigger.middleware");
+const workflow_trigger_middleware_1 = require("./middlewares/workflow-trigger.middleware");
+const workflow_engine_service_1 = require("./runtime/workflow-engine.service");
+const workflow_activity_definition_service_1 = require("./runtime/workflow-activity-definition.service");
+const workflow_execution_store_service_1 = require("./runtime/workflow-execution-store.service");
+const jql_workflow_execution_store_service_1 = require("./runtime/jql-workflow-execution-store.service");
+const workflow_expression_evaluator_service_1 = require("./runtime/workflow-expression-evaluator.service");
+const workflow_expression_scope_service_1 = require("./runtime/workflow-expression-scope.service");
+//#region ---- Workflow platform module ----
+const redisConnection = (0, workflow_redis_config_1.resolveWorkflowRedisConnection)();
+const bullImports = redisConnection
+    ? [bullmq_1.BullModule.forRoot({ connection: redisConnection }), bullmq_1.BullModule.registerQueue({ name: workflow_jobs_constants_1.WORKFLOW_JOBS_QUEUE })]
+    : [];
+let WorkflowModule = class WorkflowModule {
+};
+exports.WorkflowModule = WorkflowModule;
+exports.WorkflowModule = WorkflowModule = tslib_1.__decorate([
+    (0, common_1.Module)({
+        imports: [core_1.EntityStorageModule, schedule_1.ScheduleModule.forRoot(), ...bullImports],
+        providers: [
+            {
+                provide: workflow_execution_store_service_1.WorkflowExecutionStoreService,
+                useClass: jql_workflow_execution_store_service_1.JqlWorkflowExecutionStoreService,
+            },
+            workflow_expression_scope_service_1.WorkflowExpressionScopeService,
+            workflow_expression_evaluator_service_1.WorkflowExpressionEvaluatorService,
+            workflow_activity_definition_service_1.WorkflowActivityDefinitionService,
+            activities_1.WorkflowPermissionService,
+            activities_1.WorkflowRequestSessionAdapter,
+            activities_1.CheckPermissionActivityHandler,
+            activities_1.GetCurrentSessionUserActivityHandler,
+            activities_1.GetCurrentUserManagerActivityHandler,
+            activities_1.AssignToManagerActivityHandler,
+            activities_1.DistributionRecordActivityHandler,
+            activities_1.EntityCreateActivityHandler,
+            activities_1.EntityReadActivityHandler,
+            activities_1.EntityUpdateActivityHandler,
+            activities_1.EntityDeleteActivityHandler,
+            activities_1.IfActivityHandler,
+            activities_1.SetVariableActivityHandler,
+            activities_1.ResolveEmployeeUserIdActivityHandler,
+            activities_1.HttpRequestActivityHandler,
+            activities_1.WorkflowActivityRegistryService,
+            workflow_engine_service_1.BackendWorkflowEngineService,
+            workflow_job_dispatcher_service_1.WorkflowJobDispatcherService,
+            workflow_maintenance_scheduler_1.WorkflowMaintenanceScheduler,
+            ...(redisConnection ? [workflow_start_processor_1.WorkflowStartProcessor] : []),
+            workflow_trigger_middleware_1.WorkflowTriggerMiddleware,
+            document_workflow_trigger_middleware_1.DocumentWorkflowTriggerMiddleware,
+            automation_command_middleware_1.AutomationCommandMiddleware,
+            {
+                provide: core_1.ENTITY_STORAGE_MIDDLEWARE,
+                useExisting: workflow_trigger_middleware_1.WorkflowTriggerMiddleware,
+                multi: true,
+            },
+            {
+                provide: core_1.ENTITY_STORAGE_MIDDLEWARE,
+                useExisting: document_workflow_trigger_middleware_1.DocumentWorkflowTriggerMiddleware,
+                multi: true,
+            },
+            {
+                provide: core_1.ENTITY_STORAGE_MIDDLEWARE,
+                useExisting: automation_command_middleware_1.AutomationCommandMiddleware,
+                multi: true,
+            },
+        ],
+        exports: [
+            workflow_engine_service_1.BackendWorkflowEngineService,
+            workflow_execution_store_service_1.WorkflowExecutionStoreService,
+            activities_1.WorkflowActivityRegistryService,
+            workflow_job_dispatcher_service_1.WorkflowJobDispatcherService,
+            core_1.ENTITY_STORAGE_MIDDLEWARE,
+        ],
+    })
+], WorkflowModule);
+//#endregion
+//# sourceMappingURL=workflow.module.js.map

package/workflow/src/lib/workflow.module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow.module.js","sourceRoot":"","sources":["../../../../../../../libs/framework/server/workflow/src/lib/workflow.module.ts"],"names":[],"mappings":";;;;AAAA,2CAAuD;AACvD,2CAA4C;AAC5C,+CAAkD;AAClD,iEAAwG;AACxG,6CAiBsB;AACtB,4FAAsF;AACtF,0FAAqF;AACrF,8EAAyE;AACzE,4EAAqE;AACrE,wEAA8E;AAC9E,+FAA0F;AAC1F,6GAAuG;AACvG,2FAAsF;AACtF,+EAAiF;AACjF,yGAAmG;AACnG,iGAA2F;AAC3F,yGAAkG;AAClG,2GAAqG;AACrG,mGAA6F;AAE7F,4CAA4C;AAE5C,MAAM,eAAe,GAAG,IAAA,sDAA8B,GAAE,CAAC;AACzD,MAAM,WAAW,GAAG,eAAe;IACjC,CAAC,CAAC,CAAC,mBAAU,CAAC,OAAO,CAAC,EAAE,UAAU,EAAE,eAAe,EAAE,CAAC,EAAE,mBAAU,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,6CAAmB,EAAE,CAAC,CAAC;IAChH,CAAC,CAAC,EAAE,CAAC;AA2DA,IAAM,cAAc,GAApB,MAAM,cAAc;CAAG,CAAA;AAAjB,wCAAc;yBAAd,cAAc;IAzD1B,IAAA,eAAM,EAAC;QACN,OAAO,EAAE,CAAC,0BAAmB,EAAE,yBAAc,CAAC,OAAO,EAAE,EAAE,GAAG,WAAW,CAAC;QACxE,SAAS,EAAE;YACT;gBACE,OAAO,EAAE,gEAA6B;gBACtC,QAAQ,EAAE,uEAAgC;aAC3C;YACD,kEAA8B;YAC9B,0EAAkC;YAClC,wEAAiC;YACjC,sCAAyB;YACzB,0CAA6B;YAC7B,2CAA8B;YAC9B,iDAAoC;YACpC,iDAAoC;YACpC,2CAA8B;YAC9B,8CAAiC;YACjC,wCAA2B;YAC3B,sCAAyB;YACzB,wCAA2B;YAC3B,wCAA2B;YAC3B,8BAAiB;YACjB,uCAA0B;YAC1B,iDAAoC;YACpC,uCAA0B;YAC1B,4CAA+B;YAC/B,sDAA4B;YAC5B,8DAA4B;YAC5B,6DAA4B;YAC5B,GAAG,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,iDAAsB,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;YACpD,uDAAyB;YACzB,wEAAiC;YACjC,2DAA2B;YAC3B;gBACE,OAAO,EAAE,gCAAyB;gBAClC,WAAW,EAAE,uDAAyB;gBACtC,KAAK,EAAE,IAAI;aACA;YACb;gBACE,OAAO,EAAE,gCAAyB;gBAClC,WAAW,EAAE,wEAAiC;gBAC9C,KAAK,EAAE,IAAI;aACA;YACb;gBACE,OAAO,EAAE,gCAAyB;gBAClC,WAAW,EAAE,2DAA2B;gBACxC,KAAK,EAAE,IAAI;aACA;SACd;QACD,OAAO,EAAE;YACP,sDAA4B;YAC5B,gEAA6B;YAC7B,4CAA+B;YAC/B,8DAA4B;YAC5B,gCAAyB;SAC1B;KACF,CAAC;GACW,cAAc,CAAG;AAE9B,YAAY"}