@5minds/processcube_engine_sdk 4.0.0-develop-73fc50-llmatqfe → 4.0.0-develop-dc773a-llmfml5y

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@5minds/processcube_engine_sdk",
-  "version": "4.0.0-develop-73fc50-llmatqfe",
+  "version": "4.0.0-develop-dc773a-llmfml5y",
   "description": "Software development kit for the Engine.",
   "main": "dist/commonjs/index.js",
   "types": "dist/index.d.ts",