@5minds/processcube_engine_sdk - npm Package Compare versions

Comparing version 4.0.0-develop-104a59-ljeixxgq to 4.0.0-develop-2a0f21-llujalud

dist/amd/DataModels/Cronjob/index.js

@@ -15,8 +15,7 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
 };
-define(["require", "exports", "./CronjobHistory", "./Cronjob"], function (require, exports, CronjobHistory_1, Cronjob_1) {
+define(["require", "exports", "./Cronjob"], function (require, exports, Cronjob_1) {
     "use strict";
     Object.defineProperty(exports, "__esModule", { value: true });
-    __exportStar(CronjobHistory_1, exports);
     __exportStar(Cronjob_1, exports);
 });
 //# sourceMappingURL=index.js.map

dist/amd/EngineEvents/EngineEvent.js

@@ -18,2 +18,3 @@ define(["require", "exports"], function (require, exports) {
     (function (EngineEventType) {
+        EngineEventType["OnActivityError"] = "OnActivityError";
         EngineEventType["OnEventProcessed"] = "OnEventProcessed";
@@ -20,0 +21,0 @@ EngineEventType["OnProcessDeployed"] = "OnProcessDeployed";

dist/amd/Errors/BaseError.js

@@ -40,3 +40,4 @@ define(["require", "exports", "./index"], function (require, exports, errorClasses) {
             const callStackUndefined = errorInfo.callStack === undefined;
-            const structureIsIncorrect = errorClassUndefined || codeUndefined || callStackUndefined;
+            const errorTypeUndefined = errorInfo.errorType === undefined;
+            const structureIsIncorrect = errorClassUndefined || codeUndefined || callStackUndefined || errorTypeUndefined;
             if (structureIsIncorrect) {
@@ -61,2 +62,4 @@ throw new Error('Error while deserializing error: Serialized object has an incompatible structure.');
                 additionalInformation: this.additionalInformation,
+                errorType: 'Error',
+                ...this,
             });
@@ -63,0 +66,0 @@ }

dist/amd/ProcessModel/ProcessModelFacade/SubProcessModelFacade.js

@@ -34,5 +34,2 @@ define(["require", "exports", "../../Errors/index", "../Model/index", "./index"], function (require, exports, index_1, index_2, index_3) {
         }
-        getProcessModelHasLanes() {
-            throw new index_1.NotImplementedError('Subprocesses cannot have lanes!');
-        }
         getIncomingSequenceFlowsFor(flowNodeId) {
@@ -144,4 +141,3 @@ const flowNodeExists = this.subProcessActivity.flowNodes.some((flowNode) => flowNode.id === flowNodeId);
             }
-            const matchingLane = super.findLaneForFlowNodeIdFromLaneSet(this.subProcessActivity.id, this.processModel.laneSet);
-            return matchingLane;
+            return super.getLaneForFlowNode(this.subProcessActivity.id);
         }
@@ -148,0 +144,0 @@ getLinkCatchEventsByLinkName(linkName) {

dist/amd/Serializer.js

@@ -70,3 +70,7 @@ define(["require", "exports", "./DataModels/ProcessInstance/BpmnError", "./Errors/BaseError"], function (require, exports, BpmnError_1, BaseError_1) {
         const deserializedValue = tryParse(stringifiedError, reviverFunction);
-        const notAnErrorOrEmpty = deserializedValue == undefined || deserializedValue.name == undefined || deserializedValue.message == undefined || deserializedValue.stack == undefined;
+        const notAnErrorOrEmpty = deserializedValue == undefined ||
+            deserializedValue.name == undefined ||
+            deserializedValue.message == undefined ||
+            deserializedValue.stack == undefined ||
+            deserializedValue.errorType == undefined;
         if (notAnErrorOrEmpty) {
@@ -80,2 +84,7 @@ return deserializedValue;
             }
+            Object.keys(deserializedValue).forEach((key) => {
+                if (!error[key]) {
+                    error[key] = deserializedValue[key];
+                }
+            });
             return error;
@@ -87,2 +96,7 @@ }
         error.name = deserializedValue.name;
+        Object.keys(deserializedValue).forEach((key) => {
+            if (!error[key]) {
+                error[key] = deserializedValue[key];
+            }
+        });
         return error;
@@ -89,0 +103,0 @@ }

dist/commonjs/DataModels/Cronjob/index.js

@@ -17,4 +17,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./CronjobHistory"), exports);
 __exportStar(require("./Cronjob"), exports);
 //# sourceMappingURL=index.js.map

dist/commonjs/EngineEvents/EngineEvent.js

@@ -17,2 +17,3 @@ "use strict";
 (function (EngineEventType) {
+    EngineEventType["OnActivityError"] = "OnActivityError";
     EngineEventType["OnEventProcessed"] = "OnEventProcessed";
@@ -19,0 +20,0 @@ EngineEventType["OnProcessDeployed"] = "OnProcessDeployed";

dist/commonjs/Errors/BaseError.js

@@ -40,3 +40,4 @@ "use strict";
         const callStackUndefined = errorInfo.callStack === undefined;
-        const structureIsIncorrect = errorClassUndefined || codeUndefined || callStackUndefined;
+        const errorTypeUndefined = errorInfo.errorType === undefined;
+        const structureIsIncorrect = errorClassUndefined || codeUndefined || callStackUndefined || errorTypeUndefined;
         if (structureIsIncorrect) {
@@ -61,2 +62,4 @@ throw new Error('Error while deserializing error: Serialized object has an incompatible structure.');
             additionalInformation: this.additionalInformation,
+            errorType: 'Error',
+            ...this,
         });
@@ -63,0 +66,0 @@ }

dist/commonjs/ProcessModel/ProcessModelFacade/SubProcessModelFacade.js

@@ -36,5 +36,2 @@ "use strict";
     }
-    getProcessModelHasLanes() {
-        throw new index_1.NotImplementedError('Subprocesses cannot have lanes!');
-    }
     getIncomingSequenceFlowsFor(flowNodeId) {
@@ -146,4 +143,3 @@ const flowNodeExists = this.subProcessActivity.flowNodes.some((flowNode) => flowNode.id === flowNodeId);
         }
-        const matchingLane = super.findLaneForFlowNodeIdFromLaneSet(this.subProcessActivity.id, this.processModel.laneSet);
-        return matchingLane;
+        return super.getLaneForFlowNode(this.subProcessActivity.id);
     }
@@ -150,0 +146,0 @@ getLinkCatchEventsByLinkName(linkName) {

dist/commonjs/Serializer.js

@@ -71,3 +71,7 @@ "use strict";
     const deserializedValue = tryParse(stringifiedError, reviverFunction);
-    const notAnErrorOrEmpty = deserializedValue == undefined || deserializedValue.name == undefined || deserializedValue.message == undefined || deserializedValue.stack == undefined;
+    const notAnErrorOrEmpty = deserializedValue == undefined ||
+        deserializedValue.name == undefined ||
+        deserializedValue.message == undefined ||
+        deserializedValue.stack == undefined ||
+        deserializedValue.errorType == undefined;
     if (notAnErrorOrEmpty) {
@@ -81,2 +85,7 @@ return deserializedValue;
         }
+        Object.keys(deserializedValue).forEach((key) => {
+            if (!error[key]) {
+                error[key] = deserializedValue[key];
+            }
+        });
         return error;
@@ -88,2 +97,7 @@ }
     error.name = deserializedValue.name;
+    Object.keys(deserializedValue).forEach((key) => {
+        if (!error[key]) {
+            error[key] = deserializedValue[key];
+        }
+    });
     return error;
@@ -90,0 +104,0 @@ }

dist/DataModels/Cronjob/Cronjob.d.ts

@@ -6,78 +6,2 @@ import { SearchQuery } from '../ProcessInstance/ProcessInstanceQuery';
  *   schemas:
- *     ActiveCronjob:
- *       description: Describes an active cronjob.
- *       type: object
- *       required:
- *         - processDefinitionId
- *         - processModelId
- *         - startEventId
- *         - crontab
- *         - nextExecution
- *       properties:
- *         processDefinitionId:
- *           type: string
- *           description: The processDefinitionId that contains the ProcessModel with the cronjob.
- *         processModelId:
- *           type: string
- *           description: The ID of the ProcessModel that contains the cronjob.
- *         startEventId:
- *           type: string
- *           description: The ID of the StartEvent that contains the cronjob.
- *         crontab:
- *           type: string
- *           description: The crontab that describs the cronjob.
- *         nextExecution:
- *           type: string
- *           description: The next time the cronjob will be triggered.
- */
-export declare type ActiveCronjob = {
-    /**
-     * The processDefinitionId that contains the ProcessModel with the cronjob.
-     */
-    processDefinitionId: string;
-    /**
-     * The ID of the ProcessModel that contains the cronjob.
-     */
-    processModelId: string;
-    /**
-     * The ID of the StartEvent that contains the cronjob.
-     */
-    startEventId: string;
-    /**
-     * The crontab that describs the cronjob.
-     */
-    crontab: string;
-    /**
-     * The next time the cronjob will be triggered.
-     */
-    nextExecution: Date;
-};
-/**
- * @swagger
- * components:
- *   schemas:
- *     CronjobList:
- *       description: A list of active cronjobs.
- *       type: object
- *       required:
- *         - cronjobs
- *         - totalCount
- *       properties:
- *         cronjobs:
- *           type: array
- *           items:
- *             $ref: '#/components/schemas/ActiveCronjob'
- *           description: The active cronjobs
- *         totalCount:
- *           type: number
- *           description: The total number of active cronjobs
- */
-export declare type CronjobList = {
-    cronjobs: Array<ActiveCronjob>;
-    totalCount: number;
-};
-/**
- * @swagger
- * components:
- *   schemas:
  *     Cronjob:
@@ -84,0 +8,0 @@ *       description: Describes a cronjob.

dist/DataModels/Cronjob/index.d.ts

@@ -1,2 +0,1 @@
-export * from './CronjobHistory';
 export * from './Cronjob';

dist/DataModels/UserMetadata.d.ts

 /**
+ * @deprecated This feature is no longer officially supported, since this is more of an App SDK Feature.
+ * Therefore, this functionality will soon be moved to the App SDK entirely.
  * @swagger
@@ -6,2 +8,3 @@ * components:
  *     UserMetadata:
+ *       deprecated: true
  *       description: The user metadata
@@ -38,2 +41,4 @@ *       type: object
 /**
+ * @deprecated This feature is no longer officially supported, since this is more of an App SDK Feature.
+ * Therefore, this functionality will soon be moved to the App SDK entirely.
  * @swagger
@@ -43,2 +48,3 @@ * components:
  *     UserMetadataObject:
+ *       deprecated: true
  *       description: A list of user metadata
@@ -45,0 +51,0 @@ *       type: object

dist/Engine.d.ts

@@ -170,2 +170,12 @@ /// <reference types="node" />
 export type CustomHttpRouteHandler = (request: CustomHttpRouteRequest) => Promise<CustomHttpRouteResult> | CustomHttpRouteResult;
+/**
+ * Additional Settings for a Custom HTTP Route.
+ */
+export type CustomHttpRouteOptions = {
+    /**
+     * If set, accessing the HTTP route will require a valid Auth Token.
+     * Defaults to 'true'.
+     */
+    protected?: boolean;
+};
 export type RuntimeExpressionParameters = {
@@ -367,3 +377,11 @@ token?: {
     removeCustomServiceTask(serviceTaskType: string): void;
-    registerHttpRoute(httpRoute: string, method: 'get' | 'post' | 'put' | 'delete', routeHandler: CustomHttpRouteHandler): void;
+    /**
+     * Registers a HTTP Route at the Engine Server. These routes will be hosted by the engine itself and can be used to extend the Engine's native API.
+     *
+     * @param path          The HTTP path to use
+     * @param method        The HTTP Method for the route. Currently supports GET, POST, PUT and DELETE
+     * @param routeHandler  A callback for handling requests against the route
+     * @param options       Additional settings for the HTTP route.
+     */
+    registerHttpRoute(path: string, method: 'get' | 'post' | 'put' | 'delete', routeHandler: CustomHttpRouteHandler, options?: CustomHttpRouteOptions): void;
     executeRuntimeExpression<TExpectedResult>(expression: string, params: RuntimeExpressionParameters): Promise<TExpectedResult>;
@@ -370,0 +388,0 @@ applicationInfo: IApplicationInfoExtensionAdapter;

dist/EngineEvents/EngineEvent.d.ts

@@ -48,2 +48,3 @@ import { RuntimeExpressionParameters } from '..';
 export declare enum EngineEventType {
+    OnActivityError = "OnActivityError",
     OnEventProcessed = "OnEventProcessed",
@@ -50,0 +51,0 @@ OnProcessDeployed = "OnProcessDeployed",

dist/EngineEvents/EventCallbackTypes.d.ts

 import { CronjobEventMessage, CronjobEnabledChangedMessage, EventMessage, ExternalTaskCreatedMessage, ExternalTaskExpiredMessage, ExternalTaskLockedMessage, ExternalTaskUnlockedMessage, MetadataChangedMessage, ProcessDeploymentMessage, ProcessInstancesDeletedMessage, ProcessIsExecutableChangedMessage, UserTaskFinishedMessage } from './EventPayloads/index';
+export type OnActivityErrorCallback = (activityError: EventMessage) => void | Promise<void>;
 export type OnProcessDeployedCallback = (message: ProcessDeploymentMessage) => void | Promise<void>;
@@ -43,1 +44,2 @@ export type OnProcessInstancesDeletedCallback = (message: ProcessInstancesDeletedMessage) => void | Promise<void>;
 export type OnCorrelationMetadataChangedCallback = (metadataChanged: MetadataChangedMessage) => void | Promise<void>;
+export type OnGatewayFinishedCallback = (gatewayFinished: EventMessage) => void | Promise<void>;

dist/ExtensionAdapter/CronjobExtensionAdapter.d.ts

@@ -1,2 +0,2 @@
-import { CronjobQuery, CronjobSortSettings, DataModels, DeployedCronjobList, Identity } from '../index';
+import { CronjobQuery, CronjobSortSettings, DeployedCronjobList, Identity } from '../index';
 export interface ICronjobExtensionAdapter {
@@ -11,19 +11,2 @@ query(query: CronjobQuery, options?: {
     disableCronjob(processModelId: string, flowNodeId: string, identity?: Identity): Promise<void>;
-    /**
-     * @deprecated Use "query" instead.
-     */
-    getActive(options?: {
-        identity?: Identity;
-        offset?: number;
-        limit?: number;
-    }): Promise<DataModels.Cronjob.CronjobList>;
-    /**
-     * @deprecated Use "query" instead.
-     */
-    queryHistory(query: DataModels.Cronjob.CronjobHistoryQuery, options?: {
-        identity?: Identity;
-        offset?: number;
-        limit?: number;
-        sortSettings?: DataModels.Cronjob.CronjobHistorySortSettings;
-    }): Promise<DataModels.Cronjob.CronjobHistoryList>;
 }

dist/ExtensionAdapter/NotificationExtensionAdapter.d.ts

 import { Identity, Messages, Subscription } from '../index';
 export interface INotificationExtensionAdapter {
     removeSubscription(subscription: Subscription, identity?: Identity): void;
+    onActivityError(callback: Messages.CallbackTypes.OnActivityErrorCallback, options?: {
+        subscribeOnce?: boolean;
+        identity?: Identity;
+    }): Promise<Subscription>;
     onProcessDeployed(callback: Messages.CallbackTypes.OnProcessDeployedCallback, options?: {
@@ -164,2 +168,6 @@ subscribeOnce?: boolean;
     }): Promise<Subscription>;
+    onGatewayFinished(callback: Messages.CallbackTypes.OnGatewayFinishedCallback, options?: {
+        subscribeOnce?: boolean;
+        identity?: Identity;
+    }): Promise<Subscription>;
 }

dist/index.d.ts

@@ -15,2 +15,3 @@ import { EngineEventType } from './EngineEvents/index';
 export declare const LogEventType: {
+    OnActivityError: EngineEventType.OnActivityError;
     OnEventProcessed: EngineEventType.OnEventProcessed;
@@ -17,0 +18,0 @@ OnProcessDeployed: EngineEventType.OnProcessDeployed;

dist/ProcessModel/ProcessModelFacade/SubProcessModelFacade.d.ts

@@ -12,3 +12,2 @@ import { BpmnType, Model } from '../Model/index';
     getFlowNodeById(flowNodeId: string): Model.Base.FlowNode;
-    getProcessModelHasLanes(): boolean;
     getIncomingSequenceFlowsFor(flowNodeId: string): Array<Model.ProcessElements.SequenceFlow>;
@@ -15,0 +14,0 @@ getOutgoingSequenceFlowsFor(flowNodeId: string): Array<Model.ProcessElements.SequenceFlow>;

package.json

 {
   "name": "@5minds/processcube_engine_sdk",
-  "version": "4.0.0-develop-104a59-ljeixxgq",
+  "version": "4.0.0-develop-2a0f21-llujalud",
   "description": "Software development kit for the Engine.",
@@ -33,21 +33,20 @@ "main": "dist/commonjs/index.js",
     "prepare": "npm run clean-build",
-    "test:smoke": "ts-mocha -t 120000 -p ./tsconfig.json ./test/smoke-test-sample.spec.ts",
     "test:unit": "ts-mocha -p ./tsconfig.json \"./src/**/*.spec.ts\" ./test/**/*.spec.ts --exit"
   },
   "dependencies": {
-    "dayjs": "^1.11.7",
+    "dayjs": "^1.11.9",
     "lodash.clonedeep": "^4.5.0",
     "pino": "^6.12.0",
-    "xml2js": "^0.5.0"
+    "xml2js": "^0.6.2"
   },
   "devDependencies": {
-    "@atlas-engine/fullstack_server": "15.0.0",
+    "@types/express": "^4.17.1",
     "@types/mocha": "^10.0.1",
-    "@types/node": "^18.16.0",
-    "inversify": "6.0.1",
+    "@types/node": "^18.17.8",
     "mocha": "^10.2.0",
+    "reflect-metadata": "^0.1.13",
     "should": "^13.2.3",
     "ts-mocha": "^10.0.0",
-    "typescript": "^5.0.4"
+    "typescript": "~5.0.4"
   }
 }

No alert changes

Worsened metrics

Total package byte prevSize

1181237

decreased by-0.38%

Number of package files

1073

decreased by-0.46%

Lines of code

18523

decreased by-0.78%

Dependency changes

• + Addedxml2js@0.6.2(transitive)

• - Removedxml2js@0.5.0(transitive)

• Updateddayjs@^1.11.9

• Updatedxml2js@^0.6.2