@5minds/processcube_engine_sdk
Advanced tools
Comparing version 3.3.2 to 3.3.3-feature-4f1709-llkn84ts
@@ -170,2 +170,11 @@ /// <reference types="node" /> | ||
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 = { | ||
@@ -367,3 +376,10 @@ 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 | ||
*/ | ||
registerHttpRoute(path: string, method: 'get' | 'post' | 'put' | 'delete', routeHandler: CustomHttpRouteHandler, options?: CustomHttpRouteOptions): void; | ||
executeRuntimeExpression<TExpectedResult>(expression: string, params: RuntimeExpressionParameters): Promise<TExpectedResult>; | ||
@@ -370,0 +386,0 @@ applicationInfo: IApplicationInfoExtensionAdapter; |
{ | ||
"name": "@5minds/processcube_engine_sdk", | ||
"version": "3.3.2", | ||
"version": "3.3.3-feature-4f1709-llkn84ts", | ||
"description": "Software development kit for the Engine.", | ||
@@ -5,0 +5,0 @@ "main": "dist/commonjs/index.js", |
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
1182938
2334
18647
2