@5minds/processcube_engine_sdk - npm Package Compare versions

Comparing version 4.0.0-alpha.2 to 4.0.0-alpha.3

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/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/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/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>;
 }

package.json

 {
   "name": "@5minds/processcube_engine_sdk",
-  "version": "4.0.0-alpha.2",
+  "version": "4.0.0-alpha.3",
   "description": "Software development kit for the Engine.",
@@ -33,7 +33,6 @@ "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",
@@ -44,7 +43,7 @@ "pino": "^6.12.0",
   "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",
@@ -51,0 +50,0 @@ "ts-mocha": "^10.0.0",

No alert changes

Worsened metrics

Total package byte prevSize

1181221

decreased by-0.57%

Number of package files

1073

decreased by-0.46%

Lines of code

18523

decreased by-0.98%

Dependency changes

• Updateddayjs@^1.11.9