@5minds/processcube_engine_sdk 4.0.0-alpha.2 → 4.0.0-alpha.3

package/dist/DataModels/Cronjob/Cronjob.d.ts

@@ -1,80 +1,4 @@
 import { SearchQuery } from '../ProcessInstance/ProcessInstanceQuery';
-/**
- * @swagger
- * components:
- *   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:

package/dist/DataModels/Cronjob/index.d.ts

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

package/dist/DataModels/UserMetadata.d.ts

@@ -1,8 +1,11 @@
 /**
+ * @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
  * components:
  *   schemas:
  *     UserMetadata:
+ *       deprecated: true
  *       description: The user metadata
  *       type: object
  *       required:
@@ -34,10 +37,13 @@ export type UserMetadata<TKey extends string, TPIScope extends string, TFIScope
     flowNodeInstanceScope?: TFIScope;
 };
 /**
+ * @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
  * components:
  *   schemas:
  *     UserMetadataObject:
+ *       deprecated: true
  *       description: A list of user metadata
  *       type: object
  *       required:

package/dist/Engine.d.ts

@@ -167,6 +167,16 @@ export type CustomHttpRouteResult = {
     vary?: string | Array<string>;
 };
 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 = {
     token?: {
         current?: any;
@@ -363,7 +373,15 @@ export type Engine = {
     anonymousSessions: IAnonymousSessionExtensionAdapter;
     registerCustomServiceTask<TPayload extends object>(serviceTaskType: string, serviceTaskHandler: CustomServiceTaskHandler<TPayload>): void;
     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>;
     applicationInfo: IApplicationInfoExtensionAdapter;
     correlations: ICorrelationExtensionAdapter;

package/dist/ExtensionAdapter/CronjobExtensionAdapter.d.ts

@@ -1,4 +1,4 @@
-import { CronjobQuery, CronjobSortSettings, DataModels, DeployedCronjobList, Identity } from '../index';
+import { CronjobQuery, CronjobSortSettings, DeployedCronjobList, Identity } from '../index';
 export interface ICronjobExtensionAdapter {
     query(query: CronjobQuery, options?: {
         identity?: Identity;
@@ -8,21 +8,4 @@ export interface ICronjobExtensionAdapter {
     }): Promise<DeployedCronjobList>;
     enableCronjob(processModelId: string, flowNodeId: string, identity?: Identity): Promise<void>;
     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>;
 }

package/dist/amd/DataModels/Cronjob/Cronjob.js.map

@@ -1 +1 @@
-{"version":3,"file":"Cronjob.js","sourceRoot":"","sources":["../../../../src/DataModels/Cronjob/Cronjob.ts"],"names":[],"mappings":";;;;IAkLA,IAAY,sBAQX;IARD,WAAY,sBAAsB;QAChC,qEAA2C,CAAA;QAC3C,2DAAiC,CAAA;QACjC,uDAA6B,CAAA;QAC7B,6CAAmB,CAAA;QACnB,6CAAmB,CAAA;QACnB,6DAAmC,CAAA;QACnC,6DAAmC,CAAA;IACrC,CAAC,EARW,sBAAsB,GAAtB,8BAAsB,KAAtB,8BAAsB,QAQjC"}
+{"version":3,"file":"Cronjob.js","sourceRoot":"","sources":["../../../../src/DataModels/Cronjob/Cronjob.ts"],"names":[],"mappings":";;;;IAoGA,IAAY,sBAQX;IARD,WAAY,sBAAsB;QAChC,qEAA2C,CAAA;QAC3C,2DAAiC,CAAA;QACjC,uDAA6B,CAAA;QAC7B,6CAAmB,CAAA;QACnB,6CAAmB,CAAA;QACnB,6DAAmC,CAAA;QACnC,6DAAmC,CAAA;IACrC,CAAC,EARW,sBAAsB,GAAtB,8BAAsB,KAAtB,8BAAsB,QAQjC"}

package/dist/amd/DataModels/Cronjob/index.js

@@ -12,10 +12,9 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
-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

package/dist/amd/DataModels/Cronjob/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/DataModels/Cronjob/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;IAAA,wCAAiC;IACjC,iCAA0B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/DataModels/Cronjob/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;IAAA,iCAA0B"}

package/dist/commonjs/DataModels/Cronjob/Cronjob.js.map

@@ -1 +1 @@
-{"version":3,"file":"Cronjob.js","sourceRoot":"","sources":["../../../../src/DataModels/Cronjob/Cronjob.ts"],"names":[],"mappings":";;;AAkLA,IAAY,sBAQX;AARD,WAAY,sBAAsB;IAChC,qEAA2C,CAAA;IAC3C,2DAAiC,CAAA;IACjC,uDAA6B,CAAA;IAC7B,6CAAmB,CAAA;IACnB,6CAAmB,CAAA;IACnB,6DAAmC,CAAA;IACnC,6DAAmC,CAAA;AACrC,CAAC,EARW,sBAAsB,GAAtB,8BAAsB,KAAtB,8BAAsB,QAQjC"}
+{"version":3,"file":"Cronjob.js","sourceRoot":"","sources":["../../../../src/DataModels/Cronjob/Cronjob.ts"],"names":[],"mappings":";;;AAoGA,IAAY,sBAQX;AARD,WAAY,sBAAsB;IAChC,qEAA2C,CAAA;IAC3C,2DAAiC,CAAA;IACjC,uDAA6B,CAAA;IAC7B,6CAAmB,CAAA;IACnB,6CAAmB,CAAA;IACnB,6DAAmC,CAAA;IACnC,6DAAmC,CAAA;AACrC,CAAC,EARW,sBAAsB,GAAtB,8BAAsB,KAAtB,8BAAsB,QAQjC"}

package/dist/commonjs/DataModels/Cronjob/index.js

@@ -14,6 +14,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./CronjobHistory"), exports);
 __exportStar(require("./Cronjob"), exports);
 //# sourceMappingURL=index.js.map

package/dist/commonjs/DataModels/Cronjob/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/DataModels/Cronjob/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,mDAAiC;AACjC,4CAA0B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/DataModels/Cronjob/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAA0B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@5minds/processcube_engine_sdk",
-  "version": "4.0.0-alpha.2",
+  "version": "4.0.0-alpha.3",
   "description": "Software development kit for the Engine.",
   "main": "dist/commonjs/index.js",
   "types": "dist/index.d.ts",
@@ -30,21 +30,20 @@
     "build-commonjs": "tsc",
     "build-amd": "tsc --module amd --outDir ./dist/amd",
     "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.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"

package/dist/DataModels/Cronjob/CronjobHistory.d.ts

@@ -1,86 +0,0 @@
-/**
- * @swagger
- * components:
- *   schemas:
- *     CronjobHistoryEntry:
- *       description: Describes a single entry in the list of cronjob histories.
- *       type: object
- *       required:
- *         - processDefinitionId
- *         - processModelId
- *         - startEventId
- *         - crontab
- *         - executedAt
- *       properties:
- *         processDefinitionId:
- *           description: The ID of the process definition
- *           type: string
- *         processModelId:
- *           description: The ID of the process model
- *           type: string
- *         startEventId:
- *           description: The ID of the start event
- *           type: string
- *         crontab:
- *           description: The crontab that describs the cronjob.
- *           type: string
- *         executedAt:
- *           description: The time the cronjob was executed.
- *           type: string
- *         processInstanceId:
- *           description: The ID of the process instance that was started by the cronjob.
- *           type: string
- */
-export declare type CronjobHistoryEntry = {
-    processDefinitionId: string;
-    processModelId: string;
-    startEventId: string;
-    crontab: string;
-    executedAt: Date;
-    processInstanceId?: string;
-};
-/**
- * @swagger
- * components:
- *   schemas:
- *     CronjobHistoryList:
- *       description: A list of cronjob histories.
- *       type: object
- *       required:
- *         - cronjobHistories
- *         - totalCount
- *       properties:
- *         cronjobHistories:
- *           description: The cronjob histories
- *           type: array
- *           items:
- *             $ref: '#/components/schemas/CronjobHistoryEntry'
- *         totalCount:
- *           description: The total number of cronjob histories
- *           type: number
- */
-export declare type CronjobHistoryList = {
-    cronjobHistories: Array<CronjobHistoryEntry>;
-    totalCount: number;
-};
-export declare type CronjobHistoryQuery = {
-    processDefinitionId?: Array<string> | string;
-    processModelId?: Array<string> | string;
-    startEventId?: Array<string> | string;
-    crontab?: Array<string> | string;
-    executedAt?: Array<Date> | Date;
-    createdAt?: Array<Date> | Date;
-    updatedAt?: Array<Date> | Date;
-};
-export declare type CronjobHistorySortSettings = {
-    sortBy: CronjobHistorySortableColumns;
-    sortDir?: 'ASC' | 'DESC';
-};
-export declare enum CronjobHistorySortableColumns {
-    processDefinitionId = "processDefinitionId",
-    processModelId = "processModelId",
-    startEventId = "startEventId",
-    crontab = "crontab",
-    createdAt = "createdAt",
-    executedAt = "executedAt"
-}

package/dist/amd/DataModels/Cronjob/CronjobHistory.js

@@ -1,15 +0,0 @@
-define(["require", "exports"], function (require, exports) {
-    "use strict";
-    Object.defineProperty(exports, "__esModule", { value: true });
-    exports.CronjobHistorySortableColumns = void 0;
-    var CronjobHistorySortableColumns;
-    (function (CronjobHistorySortableColumns) {
-        CronjobHistorySortableColumns["processDefinitionId"] = "processDefinitionId";
-        CronjobHistorySortableColumns["processModelId"] = "processModelId";
-        CronjobHistorySortableColumns["startEventId"] = "startEventId";
-        CronjobHistorySortableColumns["crontab"] = "crontab";
-        CronjobHistorySortableColumns["createdAt"] = "createdAt";
-        CronjobHistorySortableColumns["executedAt"] = "executedAt";
-    })(CronjobHistorySortableColumns = exports.CronjobHistorySortableColumns || (exports.CronjobHistorySortableColumns = {}));
-});
-//# sourceMappingURL=CronjobHistory.js.map

package/dist/amd/DataModels/Cronjob/CronjobHistory.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"CronjobHistory.js","sourceRoot":"","sources":["../../../../src/DataModels/Cronjob/CronjobHistory.ts"],"names":[],"mappings":";;;;IAkFA,IAAY,6BAOX;IAPD,WAAY,6BAA6B;QACvC,4EAA2C,CAAA;QAC3C,kEAAiC,CAAA;QACjC,8DAA6B,CAAA;QAC7B,oDAAmB,CAAA;QACnB,wDAAuB,CAAA;QACvB,0DAAyB,CAAA;IAC3B,CAAC,EAPW,6BAA6B,GAA7B,qCAA6B,KAA7B,qCAA6B,QAOxC"}

package/dist/commonjs/DataModels/Cronjob/CronjobHistory.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CronjobHistorySortableColumns = void 0;
-var CronjobHistorySortableColumns;
-(function (CronjobHistorySortableColumns) {
-    CronjobHistorySortableColumns["processDefinitionId"] = "processDefinitionId";
-    CronjobHistorySortableColumns["processModelId"] = "processModelId";
-    CronjobHistorySortableColumns["startEventId"] = "startEventId";
-    CronjobHistorySortableColumns["crontab"] = "crontab";
-    CronjobHistorySortableColumns["createdAt"] = "createdAt";
-    CronjobHistorySortableColumns["executedAt"] = "executedAt";
-})(CronjobHistorySortableColumns = exports.CronjobHistorySortableColumns || (exports.CronjobHistorySortableColumns = {}));
-//# sourceMappingURL=CronjobHistory.js.map

package/dist/commonjs/DataModels/Cronjob/CronjobHistory.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"CronjobHistory.js","sourceRoot":"","sources":["../../../../src/DataModels/Cronjob/CronjobHistory.ts"],"names":[],"mappings":";;;AAkFA,IAAY,6BAOX;AAPD,WAAY,6BAA6B;IACvC,4EAA2C,CAAA;IAC3C,kEAAiC,CAAA;IACjC,8DAA6B,CAAA;IAC7B,oDAAmB,CAAA;IACnB,wDAAuB,CAAA;IACvB,0DAAyB,CAAA;AAC3B,CAAC,EAPW,6BAA6B,GAA7B,qCAA6B,KAA7B,qCAA6B,QAOxC"}