@5minds/processcube_engine_sdk - npm Package Compare versions

Comparing version 6.1.0-feature-2c5237-m4jr6y96 to 6.1.0-feature-3092d0-m6krqu1w

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/EventPayloads/index.js

@@ -24,2 +24,3 @@ "use strict";
 __exportStar(require("./FinishUserTask"), exports);
+__exportStar(require("./KillProcessInstanceMessageInternal"), exports);
 __exportStar(require("./MessageEventReached"), exports);
@@ -26,0 +27,0 @@ __exportStar(require("./MetadataChangedMessage"), exports);

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

@@ -18,2 +18,3 @@ "use strict";
 __exportStar(require("./ApplicationInfoExtensionAdapter"), exports);
+__exportStar(require("./ClusterExtensionAdapter"), exports);
 __exportStar(require("./CorrelationExtensionAdapter"), exports);
@@ -27,2 +28,3 @@ __exportStar(require("./CronjobExtensionAdapter"), exports);
 __exportStar(require("./ManualTaskExtensionAdapter"), exports);
+__exportStar(require("./MessageEventExtensionAdapter"), exports);
 __exportStar(require("./NotificationExtensionAdapter"), exports);
@@ -32,4 +34,5 @@ __exportStar(require("./ProcessDefinitionExtensionAdapter"), exports);
 __exportStar(require("./ProcessInstanceExtensionAdapter"), exports);
+__exportStar(require("./SignalEventExtensionAdapter"), exports);
 __exportStar(require("./UntypedTaskExtensionAdapter"), exports);
 __exportStar(require("./UserTaskExtensionAdapter"), exports);
 //# sourceMappingURL=index.js.map

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

@@ -23,14 +23,6 @@ "use strict";
     /**
-     * Determines if the process is marked as executable.
-     *
-     * Defaults to 'true'.
+     * If false, this process is currently not executable.
      */
     isExecutable;
     /**
-     * Determines if the process is a singleton, i.e. if only one instance of the process may be active at any given time.
-     *
-     * Defaults to 'false'.
-     */
-    isSingleton;
-    /**
      * The lanes contained in this process.
@@ -37,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

@@ -6,3 +6,2 @@ "use strict";
 const TypeFactory_1 = require("../TypeFactory");
-const ExtensionPropertyParser_1 = require("./FlowNodeParsers/ActivityParsers/ExtensionPropertyParser");
 const index_2 = require("./index");
@@ -25,3 +24,2 @@ function parseProcesses(rawProcessDefinition, baseDefinition) {
             process.isExecutable = rawProcess.isExecutable === 'true';
-            setIsSingleton(process);
             const bpmnErrors = parseProcessModelErrors(rawProcessDefinition);
@@ -156,5 +154,2 @@ const eventDefinitions = parseEventDefinitionsFromObjectModel(rawProcessDefinition);
 }
-function setIsSingleton(process) {
-    process.isSingleton = (0, ExtensionPropertyParser_1.findCamundaExtensionPropertyByName)('engine.setIsSingleton', process.extensionElements.camundaExtensionProperties)?.value === 'true';
-}
 //# sourceMappingURL=ProcessParser.js.map

dist/DataModels/ApplicationInfo.d.ts

@@ -59,3 +59,6 @@ /**
     }>;
+    extensionInfo?: {
+        [extensionName: string]: any;
+    };
     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/DataModels/ProcessInstance/ProcessInstance.d.ts

@@ -164,2 +164,3 @@ import { EventType } from '../../ProcessModel/index';
     triggeredByFlowNodeInstance?: FlowNodeInstance;
+    engineId?: string;
 };
@@ -166,0 +167,0 @@ /**

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, IClusterExtensionAdapter, ICorrelationExtensionAdapter, ICronjobExtensionAdapter, IDataObjectInstanceExtensionAdapter, IEventExtensionAdapter, IExternalTaskExtensionAdapter, IFlowNodeInstanceExtensionAdapter, IIamExtensionAdapter, IManualTaskExtensionAdapter, IMessageEventExtensionAdapter, INotificationExtensionAdapter, IProcessDefinitionExtensionAdapter, IProcessInstanceExtensionAdapter, IProcessModelExtensionAdapter, ISignalEventExtensionAdapter, IUntypedTaskExtensionAdapter, IUserTaskExtensionAdapter } from './ExtensionAdapter';
 import { EventViewModel, FlowNodeViewModel } from './ProcessModel/index';
@@ -15,5 +16,13 @@ /**
 export type OnLoad = (engine: Engine) => void | Promise<void>;
+export type GetStatusInfo = () => Object | Promise<Object>;
 export type EngineExtension = {
     onLoad: OnLoad;
+    getStatusInfo?: GetStatusInfo;
 };
+export type Extension = {
+    exports: EngineExtension;
+    name: string;
+    version: string;
+    path: string;
+};
 export type CustomServiceTaskHandlerContext = {
@@ -211,2 +220,10 @@ token: {
     /**
+     * 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.
@@ -344,2 +361,3 @@ * This middleware gets called whenever a Log Event occurs at the Engine.
     applicationInfo: IApplicationInfoExtensionAdapter;
+    cluster: IClusterExtensionAdapter;
     correlations: ICorrelationExtensionAdapter;
@@ -354,2 +372,3 @@ cronjobs: ICronjobExtensionAdapter;
     manualTasks: IManualTaskExtensionAdapter;
+    messageEvents: IMessageEventExtensionAdapter;
     notification: INotificationExtensionAdapter;
@@ -359,3 +378,4 @@ processDefinitions: IProcessDefinitionExtensionAdapter;
     processModels: IProcessModelExtensionAdapter;
+    signalEvents: ISignalEventExtensionAdapter;
     userTasks: IUserTaskExtensionAdapter;
 };

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/index.d.ts

@@ -8,2 +8,3 @@ export * from './BaseMessage';
 export * from './FinishUserTask';
+export * from './KillProcessInstanceMessageInternal';
 export * from './MessageEventReached';
@@ -10,0 +11,0 @@ export * from './MetadataChangedMessage';

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/index.d.ts

 export * from './ApplicationInfoExtensionAdapter';
+export * from './ClusterExtensionAdapter';
 export * from './CorrelationExtensionAdapter';
@@ -10,2 +11,3 @@ export * from './CronjobExtensionAdapter';
 export * from './ManualTaskExtensionAdapter';
+export * from './MessageEventExtensionAdapter';
 export * from './NotificationExtensionAdapter';
@@ -15,3 +17,4 @@ export * from './ProcessDefinitionExtensionAdapter';
 export * from './ProcessInstanceExtensionAdapter';
+export * from './SignalEventExtensionAdapter';
 export * from './UntypedTaskExtensionAdapter';
 export * from './UserTaskExtensionAdapter';

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

@@ -20,2 +20,3 @@ import { DataModels, Identity } from '../index';
     deleteProcessInstances(processInstanceIds: Array<string>, deleteAllRelatedData: boolean, identity?: Identity): Promise<void>;
+    killProcessInstance(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

@@ -24,14 +24,6 @@ import { SubProcess } from './Activities';
     /**
-     * Determines if the process is marked as executable.
-     *
-     * Defaults to 'true'.
+     * If false, this process is currently not executable.
      */
     isExecutable: boolean;
     /**
-     * Determines if the process is a singleton, i.e. if only one instance of the process may be active at any given time.
-     *
-     * Defaults to 'false'.
-     */
-    isSingleton: boolean;
-    /**
      * The lanes contained in this process.
@@ -38,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-2c5237-m4jr6y96",
+  "version": "6.1.0-feature-3092d0-m6krqu1w",
   "description": "Software development kit for the Engine.",
@@ -5,0 +5,0 @@ "main": "dist/commonjs/index.js",

No alert changes

Improved metrics

Total package byte prevSize

856366

increased by31.07%

Number of package files

624

increased by4%

Lines of code

16276

increased by40.86%

No dependency changes