@trayio/cdk-dsl 2.7.0 → 2.8.0

package/README.md

@@ -479,12 +479,7 @@ export const myOperationHandler =
                .usingHttp((http) =>
                     http.post('https://someapi.com/someresource')
                         .handleRequest((ctx, input, request) =>
-                            request.withBodyAsFile({
-                                name: 'test-image',
-                                url: 'https://tray.io/favicon.ico', // url of the source file
-                                mime_type: 'image/png',
-                                expires: 0,
-                            })
+                            request.withBodyAsFile(input.file) // where file is of type FileReference.
 					    )
                         .handleResponse((ctx, input, response) =>
                             response.parseWithBodyAsJson()
@@ -722,3 +717,66 @@ OperationHandlerTestSetup.configureHandlerTest(
 ```
 
 It is worth noting that while the DSL can be used to write complex functional tests, in practice, a connector test's focus is more about making sure that operations are properly communicating with the underlying implementation instead of testing its functionality, but ultimately it is up to the developer to decide how much and what type of coverage suits a given connector best.
+
+## File Handling.
+
+### An example operation for a file download.
+
+```typescript
+// input.ts
+export type DownloadFileInput = {}; // add input params as needed.
+```
+
+```typescript
+// output.ts
+import { FileReference } from '@trayio/cdk-dsl/dist/connector/operation/OperationHandler';
+
+export type DownloadFileOutput = {
+	file: FileReference;
+};
+```
+
+```typescript
+// handler.ts
+handler.usingHttp((http) =>
+	http
+		.get('https://someapi.com/someresource')
+		.handleRequest((ctx, input, request) => request.withoutBody())
+		.handleResponse((ctx, input, response) =>
+			response.parseWithBodyAsFile<DownloadFileOutput['file']>((file) =>
+				OperationHandlerResult.success({ file })
+			)
+		)
+);
+```
+
+### An example operation for a file upload.
+
+_(Note: This upload operation is not applicable for multipart/form-data endpoints)_
+
+```typescript
+// input.ts
+import { FileReference } from '@trayio/cdk-dsl/dist/connector/operation/OperationHandler';
+
+export type UploadFileInput = {
+	file: FileReference;
+};
+```
+
+```typescript
+// output.ts
+export type UploadFileOutput = {
+	id: number; // response from the API.
+};
+```
+
+```typescript
+// handler.ts
+handler.usingHttp((http) =>
+    http
+      .post('https://someapi.com/someresource')
+      .handleRequest((ctx, input, request) =>
+        request.withBodyAsFile(input.file)
+      )
+      .handleResponse((ctx, input, response) => response.parseWithBodyAsJson())
+```

package/package.json

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