@5minds/processcube_engine_sdk 3.3.2 → 3.3.3-feature-4f1709-llkn84ts

package/dist/Engine.d.ts

@@ -167,6 +167,15 @@ 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 to true, accessing the HTTP route will require a valid AUth Token.
+     */
+    protected?: boolean;
+};
 export type RuntimeExpressionParameters = {
     token?: {
         current?: any;
@@ -363,7 +372,14 @@ 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
+     */
+    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": "3.3.2",
+  "version": "3.3.3-feature-4f1709-llkn84ts",
   "description": "Software development kit for the Engine.",
   "main": "dist/commonjs/index.js",
   "types": "dist/index.d.ts",