@5minds/processcube_engine_sdk - npm Package Compare versions

Comparing version 6.1.0-feature-5e9cbe-m4beqb2b to 6.1.0-feature-69775c-m5xp5j4h

dist/commonjs/DataModels/index.js

@@ -53,2 +53,3 @@ "use strict";
 __exportStar(require("./DataObjectInstance"), exports);
+__exportStar(require("./EngineMetadata"), exports);
 __exportStar(require("./ExternalTask/index"), exports);
@@ -55,0 +56,0 @@ __exportStar(require("./FlowNodeInstance/index"), exports);

dist/commonjs/EngineEvents/EngineEvent.js

@@ -17,3 +17,2 @@ "use strict";
 (function (EngineEventType) {
-    EngineEventType["OnActivityError"] = "OnActivityError";
     EngineEventType["OnEventProcessed"] = "OnEventProcessed";
@@ -38,5 +37,3 @@ EngineEventType["OnMessageTriggered"] = "OnMessageTriggered";
     EngineEventType["OnFlowNodeCallActivityResponseReceived"] = "OnFlowNodeCallActivityResponseReceived";
-    EngineEventType["OnFlowNodeEventSending"] = "OnFlowNodeEventSending";
-    EngineEventType["OnFlowNodeEventRetrySending"] = "OnFlowNodeEventRetrySending";
-    EngineEventType["OnFlowNodeEventResponseReceived"] = "OnFlowNodeEventResponseReceived";
+    EngineEventType["OnFlowNodeSubProcessResponseReceived"] = "OnFlowNodeSubProcessResponseReceived";
     EngineEventType["OnFlowNodeTimerStarted"] = "OnFlowNodeTimerStarted";
@@ -43,0 +40,0 @@ EngineEventType["OnFlowNodeTimerRemoved"] = "OnFlowNodeTimerRemoved";

dist/commonjs/EngineEvents/index.js

@@ -50,3 +50,2 @@ "use strict";
 __exportStar(require("./EventPayloads/index"), exports);
-__exportStar(require("./Subscription"), exports);
 var Messages;
@@ -53,0 +52,0 @@ (function (Messages) {

dist/commonjs/ExtensionAdapter/index.js

@@ -26,2 +26,3 @@ "use strict";
 __exportStar(require("./ManualTaskExtensionAdapter"), exports);
+__exportStar(require("./MessageEventExtensionAdapter"), exports);
 __exportStar(require("./NotificationExtensionAdapter"), exports);
@@ -28,0 +29,0 @@ __exportStar(require("./ProcessDefinitionExtensionAdapter"), exports);

dist/commonjs/index.js

@@ -25,3 +25,7 @@ "use strict";
 __exportStar(require("./Engine"), exports);
+__exportStar(require("./EngineEventBus"), exports);
 __exportStar(require("./EngineConfiguration"), exports);
+__exportStar(require("./EngineEventBusSettings"), exports);
+__exportStar(require("./EngineRestApiSettings"), exports);
+__exportStar(require("./EngineSocketIoSettings"), exports);
 __exportStar(require("./Logger"), exports);
@@ -28,0 +32,0 @@ __exportStar(require("./Serializer"), exports);

dist/commonjs/ProcessModel/Model/Process.js

@@ -27,6 +27,2 @@ "use strict";
     /**
-     * If true, this process can only be run once at a time.
-     */
-    isSingleton;
-    /**
      * The lanes contained in this process.
@@ -33,0 +29,0 @@ */

dist/commonjs/ProcessModel/ProcessModelFacade/ProcessModelFacade.js

@@ -20,5 +20,2 @@ "use strict";
     }
-    getIsSingleton() {
-        return this.processModel.isSingleton;
-    }
     getFlowNodesByType(flowNodeType, includeEmbeddedSubProcess = false) {
@@ -25,0 +22,0 @@ return this.processModel.getFlowNodesByType(flowNodeType, includeEmbeddedSubProcess);

dist/commonjs/ProcessModel/ProcessModelParser/Parser/ProcessParser.js

@@ -23,3 +23,2 @@ "use strict";
             process.isExecutable = rawProcess.isExecutable === 'true';
-            process.isSingleton = rawProcess.isSingleton === 'true';
             const bpmnErrors = parseProcessModelErrors(rawProcessDefinition);
@@ -26,0 +25,0 @@ const eventDefinitions = parseEventDefinitionsFromObjectModel(rawProcessDefinition);

dist/DataModels/ApplicationInfo.d.ts

@@ -0,1 +1,2 @@
+import { EngineMetadata } from './EngineMetadata';
 /**
@@ -59,3 +60,4 @@ * @swagger
     }>;
+    clusterInfo?: Array<EngineMetadata>;
     extraInfo: any;
 };

dist/DataModels/index.d.ts

@@ -19,2 +19,3 @@ /**
 export * from './DataObjectInstance';
+export * from './EngineMetadata';
 export * from './ExternalTask/index';
@@ -21,0 +22,0 @@ export * from './FlowNodeInstance/index';

dist/Engine.d.ts

 import * as express from 'express';
 import { UserTaskInstance } from './DataModels';
 import { Identity } from './DataModels/Iam/index';
+import { ExternalEventBus } from './EngineEventBus';
 import { EngineEventType, MiddlewareCallback } from './EngineEvents/index';
-import { IApplicationInfoExtensionAdapter, ICorrelationExtensionAdapter, ICronjobExtensionAdapter, IDataObjectInstanceExtensionAdapter, IEventExtensionAdapter, IExternalTaskExtensionAdapter, IFlowNodeInstanceExtensionAdapter, IIamExtensionAdapter, IManualTaskExtensionAdapter, INotificationExtensionAdapter, IProcessDefinitionExtensionAdapter, IProcessInstanceExtensionAdapter, IProcessModelExtensionAdapter, IUntypedTaskExtensionAdapter, IUserTaskExtensionAdapter } from './ExtensionAdapter';
+import { IApplicationInfoExtensionAdapter, ICorrelationExtensionAdapter, ICronjobExtensionAdapter, IDataObjectInstanceExtensionAdapter, IEventExtensionAdapter, IExternalTaskExtensionAdapter, IFlowNodeInstanceExtensionAdapter, IIamExtensionAdapter, IManualTaskExtensionAdapter, IMessageEventExtensionAdapter, INotificationExtensionAdapter, IProcessDefinitionExtensionAdapter, IProcessInstanceExtensionAdapter, IProcessModelExtensionAdapter, IUntypedTaskExtensionAdapter, IUserTaskExtensionAdapter } from './ExtensionAdapter';
 import { EventViewModel, FlowNodeViewModel } from './ProcessModel/index';
@@ -210,2 +211,10 @@ /**
     /**
+     * Registers a custom Event Bus, which will replace the Engine's own internal Event Bus.
+     *
+     * **NOTE:** Can only be used BEFORE the {@link Engine.onReady} Event was fired!
+     *
+     * @param eventBus A custom {@link ExternalEventBus}.
+     */
+    registerCustomEventBus(eventBus: ExternalEventBus): void;
+    /**
      * Registers the given callback as an Event Middleware.
@@ -352,2 +361,3 @@ * This middleware gets called whenever a Log Event occurs at the Engine.
     manualTasks: IManualTaskExtensionAdapter;
+    messageEvents: IMessageEventExtensionAdapter;
     notification: INotificationExtensionAdapter;
@@ -354,0 +364,0 @@ processDefinitions: IProcessDefinitionExtensionAdapter;

dist/EngineConfiguration.d.ts

@@ -86,2 +86,3 @@ import { LogLevel } from './EngineEvents';
     host?: string;
+    allowedCorsOrigins?: string[];
 };
@@ -88,0 +89,0 @@ export declare type IAMConfiguration = {

dist/EngineEvents/EngineEvent.d.ts

@@ -18,3 +18,5 @@ import { RuntimeExpressionParameters } from '..';
 export declare type EngineEvent = {
+    eventId?: string;
     eventType: EngineEventType;
+    logLevel: LogLevel;
     timestamp: Date;
@@ -30,12 +32,38 @@ processStartedAt?: Date;
     processDefinitionHash: string;
+    processInstanceId: string;
+    parentProcessInstanceId?: string;
+    correlationId: string;
+    /**
+     * Only included with OnFlowNodeXX events.
+     */
     flowNodeId?: string;
+    /**
+     * Only included with OnFlowNodeXX events.
+     */
     flowNodeInstanceId?: string;
+    /**
+     * Only included with OnFlowNodeXX events.
+     */
     flowNodeType?: BpmnType;
+    /**
+     * Only included with OnFlowNodeXX events.
+     */
     currentFlowNode?: BaseElementViewModel;
-    processInstanceId: string;
-    parentProcessInstanceId?: string;
-    correlationId: string;
-    logLevel: LogLevel;
-    tokenPayload?: object;
-    eventId?: string;
+    /**
+     * For "OnFlowNodeXX" Events, this will contain the current token on the FlowNodeInstance.
+     * For "OnProcessXX" Events, this will contain either the ProcessInstance's initial token, or its end token.
+     */
+    tokenPayload?: Record<string, any>;
+    /**
+     * Only included with OnFlowNodeExited events.
+     */
+    writtenDataObjectValues?: Record<string, any>;
+    /**
+     * Only included with OnFlowNodeEntered events.
+     */
+    writtenCorrelationMetadata?: Record<string, string>;
+    /**
+     * Only included with OnFlowNodeEntered events.
+     */
+    writtenProcessInstanceMetadata?: Record<string, string>;
     messageChannel?: string;
@@ -53,3 +81,2 @@ signalChannel?: string;
 export declare enum EngineEventType {
-    OnActivityError = "OnActivityError",
     OnEventProcessed = "OnEventProcessed",
@@ -74,5 +101,3 @@ OnMessageTriggered = "OnMessageTriggered",
     OnFlowNodeCallActivityResponseReceived = "OnFlowNodeCallActivityResponseReceived",
-    OnFlowNodeEventSending = "OnFlowNodeEventSending",
-    OnFlowNodeEventRetrySending = "OnFlowNodeEventRetrySending",
-    OnFlowNodeEventResponseReceived = "OnFlowNodeEventResponseReceived",
+    OnFlowNodeSubProcessResponseReceived = "OnFlowNodeSubProcessResponseReceived",
     OnFlowNodeTimerStarted = "OnFlowNodeTimerStarted",
@@ -79,0 +104,0 @@ OnFlowNodeTimerRemoved = "OnFlowNodeTimerRemoved"

dist/EngineEvents/EventPayloads/TerminateProcessInstance.d.ts

@@ -6,2 +6,3 @@ import { Identity } from '../../DataModels/Iam/index';
 export type TerminateProcessInstanceMessage = {
+    processInstanceId: string;
     /**
@@ -8,0 +9,0 @@ * If the Process Instance is terminated by a user, this will contain the users identity.

dist/EngineEvents/index.d.ts

@@ -12,3 +12,2 @@ /**
 export * from './EventPayloads/index';
-export * from './Subscription';
 export declare namespace Messages {
@@ -15,0 +14,0 @@ export import EventMessage = eventPayloads.EventMessage;

dist/ExtensionAdapter/CronjobExtensionAdapter.d.ts

@@ -11,2 +11,4 @@ import { CronjobQuery, CronjobSortSettings, DeployedCronjobList, Identity } from '../index';
     disableCronjob(processModelId: string, flowNodeId: string, identity?: Identity): Promise<void>;
+    startCronjobService(): Promise<void>;
+    stopCronjobService(): Promise<void>;
 }

dist/ExtensionAdapter/FlowNodeInstanceExtensionAdapter.d.ts

@@ -22,2 +22,3 @@ import { DataModels, Identity } from '../index';
     }): Promise<void>;
+    cleanUpOrphanedFlowNodeInstances(identity?: Identity): Promise<void>;
 }

dist/ExtensionAdapter/index.d.ts

@@ -10,2 +10,3 @@ export * from './ApplicationInfoExtensionAdapter';
 export * from './ManualTaskExtensionAdapter';
+export * from './MessageEventExtensionAdapter';
 export * from './NotificationExtensionAdapter';
@@ -12,0 +13,0 @@ export * from './ProcessDefinitionExtensionAdapter';

dist/ExtensionAdapter/NotificationExtensionAdapter.d.ts

@@ -80,2 +80,6 @@ import { Identity, Messages, Subscription } from '../index';
     }): Promise<Subscription>;
+    onActivityError(callback: Messages.CallbackTypes.OnActivityErrorCallback, options?: {
+        subscribeOnce?: boolean;
+        identity?: Identity;
+    }): Promise<Subscription>;
     onUntypedTaskWaiting(callback: Messages.CallbackTypes.OnUntypedTaskWaitingCallback, options?: {
@@ -141,6 +145,2 @@ subscribeOnce?: boolean;
     }): Promise<Subscription>;
-    onFlowNodeEventRetrySending(callback: Messages.CallbackTypes.OnFlowNodeEventRetrySendingCallback, options?: {
-        subscribeOnce?: boolean;
-        identity?: Identity;
-    }): Promise<Subscription>;
     onMessageTriggered(callback: Messages.CallbackTypes.OnMessageTriggeredCallback, options?: {
@@ -147,0 +147,0 @@ subscribeOnce?: boolean;

dist/ExtensionAdapter/ProcessInstanceExtensionAdapter.d.ts

@@ -1,2 +0,2 @@
-import { DataModels, Identity } from '../index';
+import { DataModels, Identity, ProcessInstanceState } from '../index';
 export interface IProcessInstanceExtensionAdapter {
@@ -12,2 +12,4 @@ query(query: DataModels.ProcessInstances.ProcessInstanceQuery, options?: {
     getProcessModel(processInstanceId: string, identity?: Identity): Promise<DataModels.ProcessDefinitions.ProcessModel>;
+    getRunningProcessInstanceIds(engineId?: string, identity?: Identity): Promise<Array<string>>;
+    getProcessInstanceCountByEngineId(engineId: string, state?: ProcessInstanceState): Promise<number>;
     transferOwnership(processInstanceId: string, newOwner: Identity, identity?: Identity): Promise<void>;
@@ -14,0 +16,0 @@ terminateProcessInstance(processInstanceId: string, identity?: Identity): Promise<void>;

dist/index.d.ts

@@ -8,3 +8,7 @@ import { EngineEventType } from './EngineEvents/index';
 export * from './Engine';
+export * from './EngineEventBus';
 export * from './EngineConfiguration';
+export * from './EngineEventBusSettings';
+export * from './EngineRestApiSettings';
+export * from './EngineSocketIoSettings';
 export * from './Logger';
@@ -16,3 +20,2 @@ export * from './Serializer';
 export declare const LogEventType: {
-    OnActivityError: EngineEventType.OnActivityError;
     OnEventProcessed: EngineEventType.OnEventProcessed;
@@ -37,7 +40,5 @@ OnMessageTriggered: EngineEventType.OnMessageTriggered;
     OnFlowNodeCallActivityResponseReceived: EngineEventType.OnFlowNodeCallActivityResponseReceived;
-    OnFlowNodeEventSending: EngineEventType.OnFlowNodeEventSending;
-    OnFlowNodeEventRetrySending: EngineEventType.OnFlowNodeEventRetrySending;
-    OnFlowNodeEventResponseReceived: EngineEventType.OnFlowNodeEventResponseReceived;
+    OnFlowNodeSubProcessResponseReceived: EngineEventType.OnFlowNodeSubProcessResponseReceived;
     OnFlowNodeTimerStarted: EngineEventType.OnFlowNodeTimerStarted;
     OnFlowNodeTimerRemoved: EngineEventType.OnFlowNodeTimerRemoved;
 };

dist/ProcessModel/Model/Process.d.ts

@@ -28,6 +28,2 @@ import { SubProcess } from './Activities';
     /**
-     * If true, this process can only be run once at a time.
-     */
-    isSingleton: boolean;
-    /**
      * The lanes contained in this process.
@@ -34,0 +30,0 @@ */

dist/ProcessModel/ProcessModelFacade/ProcessModelFacade.d.ts

@@ -7,3 +7,2 @@ import { BpmnType, Model } from '../Model/index';
     getIsExecutable(): boolean;
-    getIsSingleton(): boolean;
     getFlowNodesByType<TFlowNode extends Model.Base.FlowNode>(flowNodeType: BpmnType, includeEmbeddedSubProcess?: boolean): Array<TFlowNode>;
@@ -10,0 +9,0 @@ getStartEvents(includeEmbeddedSubProcess?: boolean): Array<Model.Events.StartEvent>;

package.json

 {
   "name": "@5minds/processcube_engine_sdk",
-  "version": "6.1.0-feature-5e9cbe-m4beqb2b",
+  "version": "6.1.0-feature-69775c-m5xp5j4h",
   "description": "Software development kit for the Engine.",
@@ -41,3 +41,3 @@ "main": "dist/commonjs/index.js",
   "devDependencies": {
-    "@trivago/prettier-plugin-sort-imports": "^4.2.0",
+    "@trivago/prettier-plugin-sort-imports": "^5.0.0",
     "@types/express": "^5.0.0",
@@ -44,0 +44,0 @@ "@types/mocha": "^10.0.3",

No alert changes

Improved metrics

Total package byte prevSize

853767

increased by30.81%

Number of package files

615

increased by2.5%

Lines of code

16225

increased by40.56%

No dependency changes