@trayio/cdk-dsl 3.8.1-beta → 3.9.1

package/README.md

@@ -858,14 +858,32 @@ export const myOperationHandler =
     );
 ```
 
-### How to enable / disable raw http operation.
+## Error Handling
 
-By default, all the connectors come with a Raw Http Operation. You can disable it by updating the config in the connector.json
+You could use `withErrorHandling()` on the `response` to display custom error messages to the users.
 
 ```typescript
-{
-    "rawHttp": {
-        "enabled": false
-    }
-}
+handler.usingHttp((http) =>
+	http
+		.get('<url>')
+		.handleRequest((ctx, input, request) =>
+			request.withBearerToken(ctx.auth!.user.access_token).withoutBody()
+		)
+		.handleResponse((ctx, input, response) =>
+			response
+				.withErrorHandling(() => {
+					const status = response.getStatusCode();
+
+					if (status === 404) {
+						return OperationHandlerResult.failure(
+							OperationHandlerError.userInputError('post not found')
+						);
+					}
+					return OperationHandlerResult.failure(
+						OperationHandlerError.apiError(`api error: ${status}`)
+					);
+				})
+				.parseWithBodyAsJson()
+		)
+);
 ```

package/dist/connector/operation/CompositeOperationHandler.js

@@ -2,8 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CompositeOperationHandler = void 0;
 class CompositeOperationHandler {
+    _tag = 'CompositeOperationHandler';
+    handlerFunction;
     constructor(handlerFunction) {
-        this._tag = 'CompositeOperationHandler';
         this.handlerFunction = handlerFunction;
     }
 }

package/dist/connector/operation/HttpOperationHandler.js

@@ -40,6 +40,9 @@ const readPackageVersion = () => {
 };
 const packageVersion = readPackageVersion();
 class HttpOperationRequestBuilder {
+    path;
+    method;
+    request;
     constructor(method, path, request) {
         this.method = method;
         this.path = path;
@@ -74,10 +77,22 @@ class HttpOperationRequestBuilder {
         return new HttpOperationRequest(this.path, this.method, this.request, O.none, undefined);
     }
     addPathParameter(name, value) {
-        return new HttpOperationRequestBuilder(this.method, this.path, Object.assign(Object.assign({}, this.request), { pathParams: Object.assign(Object.assign({}, this.request.pathParams), { [name]: value }) }));
+        return new HttpOperationRequestBuilder(this.method, this.path, {
+            ...this.request,
+            pathParams: {
+                ...this.request.pathParams,
+                [name]: value,
+            },
+        });
     }
     addQueryString(name, value) {
-        return new HttpOperationRequestBuilder(this.method, this.path, Object.assign(Object.assign({}, this.request), { queryString: Object.assign(Object.assign({}, this.request.queryString), { [name]: value }) }));
+        return new HttpOperationRequestBuilder(this.method, this.path, {
+            ...this.request,
+            queryString: {
+                ...this.request.queryString,
+                [name]: value,
+            },
+        });
     }
     withMethod(method) {
         return new HttpOperationRequestBuilder(method, this.path, this.request);
@@ -89,11 +104,22 @@ class HttpOperationRequestBuilder {
         return this.addHeader(Http_1.HttpHeader.Authorization, `Bearer ${token}`);
     }
     addHeader(name, value) {
-        return new HttpOperationRequestBuilder(this.method, this.path, Object.assign(Object.assign({}, this.request), { headers: Object.assign(Object.assign({}, this.request.headers), { [name]: value }) }));
+        return new HttpOperationRequestBuilder(this.method, this.path, {
+            ...this.request,
+            headers: {
+                ...this.request.headers,
+                [name]: value,
+            },
+        });
     }
 }
 exports.HttpOperationRequestBuilder = HttpOperationRequestBuilder;
 class HttpOperationRequest {
+    path;
+    method;
+    request;
+    contentType;
+    body;
     constructor(path, method, request, contentType, body) {
         this.path = path;
         this.method = method;
@@ -104,6 +130,8 @@ class HttpOperationRequest {
 }
 exports.HttpOperationRequest = HttpOperationRequest;
 class HttpOperationResponseBuilder {
+    response;
+    errorHandling;
     constructor(response, errorHandling) {
         this.response = response;
         this.errorHandling = errorHandling;
@@ -135,6 +163,10 @@ class HttpOperationResponseBuilder {
 }
 exports.HttpOperationResponseBuilder = HttpOperationResponseBuilder;
 class HttpOperationResponse {
+    response;
+    errorHandling;
+    contentType;
+    responseParser;
     constructor(response, errorHandling, contentType, responseParser) {
         this.response = response;
         this.errorHandling = errorHandling;
@@ -144,8 +176,11 @@ class HttpOperationResponse {
 }
 exports.HttpOperationResponse = HttpOperationResponse;
 class HttpOperationHandler {
+    _tag = 'HttpOperationHandler';
+    request;
+    requestHandler;
+    responseHandler;
     constructor(request, requestHandler, responseHandler) {
-        this._tag = 'HttpOperationHandler';
         this.request = request;
         this.requestHandler = requestHandler;
         this.responseHandler = responseHandler;
@@ -153,6 +188,8 @@ class HttpOperationHandler {
 }
 exports.HttpOperationHandler = HttpOperationHandler;
 class HttpOperationHandlerResponseConfiguration {
+    request;
+    requestHandler;
     constructor(request, requestHandler) {
         this.request = request;
         this.requestHandler = requestHandler;
@@ -163,6 +200,7 @@ class HttpOperationHandlerResponseConfiguration {
 }
 exports.HttpOperationHandlerResponseConfiguration = HttpOperationHandlerResponseConfiguration;
 class HttpOperationHandlerRequestConfiguration {
+    request;
     constructor(request) {
         this.request = request;
     }

package/dist/connector/operation/OperationGlobalConfig.js

@@ -27,11 +27,14 @@ exports.OperationGlobalConfigHttp = void 0;
 const O = __importStar(require("fp-ts/Option"));
 const function_1 = require("fp-ts/function");
 class OperationGlobalConfigHttp {
+    baseUrl;
+    bearerToken;
+    headers;
+    _tag = 'OperationGlobalConfigHttp';
     static create() {
         return new OperationGlobalConfigHttp(O.none, O.none, []);
     }
     constructor(baseUrl, bearerToken, headers) {
-        this._tag = 'OperationGlobalConfigHttp';
         this.baseUrl = baseUrl;
         this.bearerToken = bearerToken;
         this.headers = headers;

package/dist/connector/operation/OperationHandlerSetup.js

@@ -33,6 +33,11 @@ const CompositeOperationHandler_1 = require("./CompositeOperationHandler");
 const HttpOperationHandler_1 = require("./HttpOperationHandler");
 const OperationHandlerValidation_1 = require("./OperationHandlerValidation");
 class OperationHandler {
+    name;
+    isPrivate;
+    validation;
+    implementation;
+    globalConfiguration;
     constructor(name, isPrivate, validation, implementation, globalConfiguration) {
         this.name = name;
         this.isPrivate = isPrivate;
@@ -46,6 +51,10 @@ class OperationHandlerConfiguration {
     static withName(name) {
         return new OperationHandlerConfiguration(name, false, O.none, O.none);
     }
+    name;
+    isPrivate;
+    validation;
+    globalConfiguration;
     constructor(name, isPrivate, validation, globalConfiguration) {
         this.name = name;
         this.isPrivate = isPrivate;
@@ -79,12 +88,14 @@ class OperationHandlerConfiguration {
 }
 exports.OperationHandlerConfiguration = OperationHandlerConfiguration;
 class OperationHandlerRegistry {
+    static instance = new OperationHandlerRegistry();
     static register(handler) {
         return OperationHandlerRegistry.instance.register(handler);
     }
     static resolve(reference) {
         return OperationHandlerRegistry.instance.resolve(reference);
     }
+    registry;
     constructor() {
         this.registry = new Map();
     }
@@ -100,7 +111,6 @@ class OperationHandlerRegistry {
     }
 }
 exports.OperationHandlerRegistry = OperationHandlerRegistry;
-OperationHandlerRegistry.instance = new OperationHandlerRegistry();
 const readOperationDescriptorFile = () => {
     const operationDescriptorOpt = (0, function_1.pipe)(O.fromNullable(CallSite_1.CallSite.getCurrentCallSites()[1]), // skip the last caller because it is a function within this file
     O.map((caller) => pathLib.join(caller.folderPath, 'operation.json')), O.chain((operationDescriptorPath) => O.fromEither(DynamicType_1.DynamicType.readFromFile(operationDescriptorPath))));

package/dist/connector/operation/OperationHandlerTest.js

@@ -40,6 +40,13 @@ const readContextJsonFile = (ctxName) => {
     return operationDescriptor;
 };
 class OperationHandlerTestCase {
+    description;
+    ctx;
+    testContext;
+    givenFunction;
+    whenFunction;
+    thenFunction;
+    finallyFunction;
     constructor(description, ctx, testContext, givenFunction, whenFunction, thenFunction, finallyFunction) {
         this.description = description;
         this.ctx = ctx;
@@ -52,6 +59,12 @@ class OperationHandlerTestCase {
 }
 exports.OperationHandlerTestCase = OperationHandlerTestCase;
 class OperationHandlerTestCaseFinallyConfiguration {
+    description;
+    ctx;
+    testContext;
+    givenFunction;
+    whenFunction;
+    thenFunction;
     constructor(description, ctx, testContext, givenFunction, whenFunction, thenFunction) {
         this.description = description;
         this.ctx = ctx;
@@ -69,6 +82,11 @@ class OperationHandlerTestCaseFinallyConfiguration {
 }
 exports.OperationHandlerTestCaseFinallyConfiguration = OperationHandlerTestCaseFinallyConfiguration;
 class OperationHandlerTestCaseThenConfiguration {
+    description;
+    ctx;
+    testContext;
+    givenFunction;
+    whenFunction;
     constructor(description, ctx, testContext, givenFunction, whenFunction) {
         this.description = description;
         this.ctx = ctx;
@@ -82,6 +100,10 @@ class OperationHandlerTestCaseThenConfiguration {
 }
 exports.OperationHandlerTestCaseThenConfiguration = OperationHandlerTestCaseThenConfiguration;
 class OperationHandlerTestCaseWhenConfiguration {
+    description;
+    ctx;
+    testContext;
+    givenFunction;
     constructor(description, ctx, testContext, givenFunction) {
         this.description = description;
         this.ctx = ctx;
@@ -94,6 +116,9 @@ class OperationHandlerTestCaseWhenConfiguration {
 }
 exports.OperationHandlerTestCaseWhenConfiguration = OperationHandlerTestCaseWhenConfiguration;
 class OperationHandlerTestCaseGivenConfiguration {
+    description;
+    ctx;
+    testContext;
     constructor(description, ctx, testContext) {
         this.description = description;
         this.ctx = ctx;
@@ -108,6 +133,9 @@ class OperationHandlerTestCaseGivenConfiguration {
 }
 exports.OperationHandlerTestCaseGivenConfiguration = OperationHandlerTestCaseGivenConfiguration;
 class OperationHandlerTestCaseAuthConfiguration {
+    description;
+    defaultCtx;
+    testContext;
     constructor(description, defaultCtx, testContext) {
         this.description = description;
         this.defaultCtx = defaultCtx;
@@ -125,6 +153,9 @@ class OperationHandlerTestCaseAuthConfiguration {
 }
 exports.OperationHandlerTestCaseAuthConfiguration = OperationHandlerTestCaseAuthConfiguration;
 class OperationHandlerTestCaseFactory {
+    description;
+    ctx;
+    testCaseSetup;
     constructor(description, ctx, testCaseSetup) {
         this.description = description;
         this.ctx = ctx;
@@ -136,6 +167,11 @@ class OperationHandlerTestCaseFactory {
 }
 exports.OperationHandlerTestCaseFactory = OperationHandlerTestCaseFactory;
 class OperationHandlerTest {
+    handlerReference;
+    ctx;
+    beforeAllFunction;
+    testCaseFactories;
+    afterAllFunction;
     constructor(handlerReference, ctx, beforeAllFunction, testCaseFactories, afterAllFunction) {
         this.handlerReference = handlerReference;
         this.ctx = ctx;
@@ -146,6 +182,10 @@ class OperationHandlerTest {
 }
 exports.OperationHandlerTest = OperationHandlerTest;
 class OperationHandlerTestAfterAllConfiguration {
+    handlerReference;
+    ctx;
+    beforeAllFunction;
+    testCaseFactories;
     constructor(handlerReference, ctx, beforeAllFunction, testCaseFactories) {
         this.handlerReference = handlerReference;
         this.ctx = ctx;
@@ -165,6 +205,9 @@ class OperationHandlerTestAfterAllConfiguration {
 }
 exports.OperationHandlerTestAfterAllConfiguration = OperationHandlerTestAfterAllConfiguration;
 class OperationHandlerTestMandatoryTestCaseConfiguration {
+    handlerReference;
+    ctx;
+    beforeAllFunction;
     constructor(handlerReference, ctx, beforeAllFunction) {
         this.handlerReference = handlerReference;
         this.ctx = ctx;
@@ -177,6 +220,8 @@ class OperationHandlerTestMandatoryTestCaseConfiguration {
 }
 exports.OperationHandlerTestMandatoryTestCaseConfiguration = OperationHandlerTestMandatoryTestCaseConfiguration;
 class OperationHandlerTestBeforeAllConfiguration {
+    handlerReference;
+    ctx;
     constructor(handlerReference, ctx) {
         this.handlerReference = handlerReference;
         this.ctx = ctx;
@@ -190,6 +235,7 @@ class OperationHandlerTestBeforeAllConfiguration {
 }
 exports.OperationHandlerTestBeforeAllConfiguration = OperationHandlerTestBeforeAllConfiguration;
 class OperationHandlerTestAuthConfiguration {
+    handlerReference;
     constructor(handlerReference) {
         this.handlerReference = handlerReference;
     }
@@ -199,6 +245,7 @@ class OperationHandlerTestAuthConfiguration {
 }
 exports.OperationHandlerTestAuthConfiguration = OperationHandlerTestAuthConfiguration;
 class OperationHandlerTestRegistry {
+    static instance = new OperationHandlerTestRegistry();
     static register(handlerTest) {
         OperationHandlerTestRegistry.instance.register(handlerTest);
     }
@@ -208,6 +255,8 @@ class OperationHandlerTestRegistry {
     static onRegistration(onRegistrationFunction) {
         OperationHandlerTestRegistry.instance.onRegistration(onRegistrationFunction);
     }
+    registry;
+    observers;
     constructor() {
         this.registry = new Map();
         this.observers = [];
@@ -229,7 +278,6 @@ class OperationHandlerTestRegistry {
     }
 }
 exports.OperationHandlerTestRegistry = OperationHandlerTestRegistry;
-OperationHandlerTestRegistry.instance = new OperationHandlerTestRegistry();
 exports.OperationHandlerTestSetup = {
     configureHandlerTest: (handlerReference, handlerTestSetup) => {
         const handlerTest = handlerTestSetup(new OperationHandlerTestAuthConfiguration(handlerReference));

package/dist/connector/operation/OperationHandlerValidation.js

@@ -5,6 +5,8 @@ class OperationHandlerValidation {
     static emptyValidation() {
         return new OperationHandlerValidation([], []);
     }
+    inputValidation;
+    outputValidation;
     constructor(inputValidation, outputValidation) {
         this.inputValidation = inputValidation;
         this.outputValidation = outputValidation;
@@ -18,6 +20,8 @@ class OperationHandlerValidation {
 }
 exports.OperationHandlerValidation = OperationHandlerValidation;
 class OperationHandlerInputValidation {
+    condition;
+    errorMessage;
     constructor(condition, errorMessage) {
         this.condition = condition;
         this.errorMessage = errorMessage;
@@ -25,6 +29,7 @@ class OperationHandlerInputValidation {
 }
 exports.OperationHandlerInputValidation = OperationHandlerInputValidation;
 class OperationHandlerInputValidationErrorMessageConfiguration {
+    condition;
     constructor(condition) {
         this.condition = condition;
     }
@@ -40,6 +45,8 @@ class OperationHandlerInputValidationConditionConfiguration {
 }
 exports.OperationHandlerInputValidationConditionConfiguration = OperationHandlerInputValidationConditionConfiguration;
 class OperationHandlerOutputValidation {
+    condition;
+    errorMessage;
     constructor(condition, errorMessage) {
         this.condition = condition;
         this.errorMessage = errorMessage;
@@ -47,6 +54,7 @@ class OperationHandlerOutputValidation {
 }
 exports.OperationHandlerOutputValidation = OperationHandlerOutputValidation;
 class OperationHandlerOutputValidationErrorMessageConfiguration {
+    condition;
     constructor(condition) {
         this.condition = condition;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trayio/cdk-dsl",
-  "version": "3.8.1-beta",
+  "version": "3.9.1",
   "description": "A DSL for connector development",
   "exports": {
     "./*": "./dist/*.js"
@@ -14,7 +14,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@trayio/commons": "3.8.1-beta"
+    "@trayio/commons": "3.9.1"
   },
   "typesVersions": {
     "*": {