@trayio/tray-openapi 2.10.0 → 2.11.0

package/dist/OpenApiSchemaImporter.d.ts

@@ -1,11 +1,27 @@
 import * as TE from 'fp-ts/TaskEither';
 import { FileStorage } from '@trayio/commons/file/File';
 import { Generator } from '@trayio/generator/generator/Generator';
+import { OpenApiHttpMethod } from './OpenApiTypeDescriptors';
+type BaseOperation = {
+    httpMethod: OpenApiHttpMethod;
+    path: string;
+};
+type OperationError = BaseOperation & {
+    tag: 'error';
+    errorMessage: string;
+};
+type OperationSuccess = BaseOperation & {
+    tag: 'success';
+};
+export type BuildConnectorResponse = {
+    successes: OperationSuccess[];
+    errors: OperationError[];
+};
 export declare class OpenApiSchemaImporter {
     private generator;
     private fileStorage;
     constructor(generator: Generator, fileStorage: FileStorage);
-    buildConnector(openApiSpecPath: string, connectorName: string): TE.TaskEither<Error, undefined>;
+    buildConnector(openApiSpecPath: string, connectorName: string): TE.TaskEither<Error, BuildConnectorResponse>;
     private generateOperationFromPath;
     private decodeOperation;
     private getOpenApiSpec;
@@ -13,4 +29,5 @@ export declare class OpenApiSchemaImporter {
     private generateConnectorDirectory;
     private generateOperationDirectory;
 }
+export {};
 //# sourceMappingURL=OpenApiSchemaImporter.d.ts.map

package/dist/OpenApiSchemaImporter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"OpenApiSchemaImporter.d.ts","sourceRoot":"","sources":["../src/OpenApiSchemaImporter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAC;AASvC,OAAO,EAAQ,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,uCAAuC,CAAC;AAyClE,qBAAa,qBAAqB;IACrB,OAAO,CAAC,SAAS;IAAa,OAAO,CAAC,WAAW;gBAAzC,SAAS,EAAE,SAAS,EAAU,WAAW,EAAE,WAAW;IAE1E,cAAc,CACb,eAAe,EAAE,MAAM,EACvB,aAAa,EAAE,MAAM,GACnB,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,SAAS,CAAC;IAiClC,OAAO,CAAC,yBAAyB;IA6CjC,OAAO,CAAC,eAAe;IAgBvB,OAAO,CAAC,cAAc;IAkCtB,OAAO,CAAC,oCAAoC;IAgF5C,OAAO,CAAC,0BAA0B;IAwBlC,OAAO,CAAC,0BAA0B;CAclC"}
+{"version":3,"file":"OpenApiSchemaImporter.d.ts","sourceRoot":"","sources":["../src/OpenApiSchemaImporter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAC;AASvC,OAAO,EAAQ,WAAW,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,uCAAuC,CAAC;AAGlE,OAAO,EACN,iBAAiB,EAGjB,MAAM,0BAA0B,CAAC;AAgClC,KAAK,aAAa,GAAG;IACpB,UAAU,EAAE,iBAAiB,CAAC;IAC9B,IAAI,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,KAAK,cAAc,GAAG,aAAa,GAAG;IACrC,GAAG,EAAE,OAAO,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,KAAK,gBAAgB,GAAG,aAAa,GAAG;IACvC,GAAG,EAAE,SAAS,CAAC;CACf,CAAC;AAIF,MAAM,MAAM,sBAAsB,GAAG;IACpC,SAAS,EAAE,gBAAgB,EAAE,CAAC;IAC9B,MAAM,EAAE,cAAc,EAAE,CAAC;CACzB,CAAC;AAEF,qBAAa,qBAAqB;IACrB,OAAO,CAAC,SAAS;IAAa,OAAO,CAAC,WAAW;gBAAzC,SAAS,EAAE,SAAS,EAAU,WAAW,EAAE,WAAW;IAE1E,cAAc,CACb,eAAe,EAAE,MAAM,EACvB,aAAa,EAAE,MAAM,GACnB,EAAE,CAAC,UAAU,CAAC,KAAK,EAAE,sBAAsB,CAAC;IAqD/C,OAAO,CAAC,yBAAyB;IAyDjC,OAAO,CAAC,eAAe;IAgBvB,OAAO,CAAC,cAAc;IAkCtB,OAAO,CAAC,oCAAoC;IAgF5C,OAAO,CAAC,0BAA0B;IAwBlC,OAAO,CAAC,0BAA0B;CAclC"}

package/dist/OpenApiSchemaImporter.js

@@ -59,10 +59,29 @@ class OpenApiSchemaImporter {
                     path: openApiSpec.paths[path][route],
                 })),
             })));
-        }), TE.chain(({ openApiSpec, connectorPath, paths }) => (0, Array_1.traverse)(TE.ApplicativeSeq)((path) => this.generateOperationFromPath(path, connectorPath, openApiSpec.servers[0].url, connectorName))(paths)), TE.map(() => undefined));
+        }), TE.chain(({ openApiSpec, connectorPath, paths }) => (0, Array_1.traverse)(TE.ApplicativeSeq)((path) => this.generateOperationFromPath(path, connectorPath, openApiSpec.servers[0].url, connectorName))(paths)), TE.map((operation) => {
+            console.log(operation);
+            const flatOperations = operation.flat();
+            const buildConnectorResponse = flatOperations.reduce((acc, curr) => {
+                if (curr.tag === 'error') {
+                    return Object.assign(Object.assign({}, acc), { errors: [...acc.errors, curr] });
+                }
+                return Object.assign(Object.assign({}, acc), { successes: [...acc.successes, curr] });
+            }, { successes: [], errors: [] });
+            return buildConnectorResponse;
+        }));
     }
     generateOperationFromPath(path, connectorPath, baseUrl, connectorName) {
-        return (0, function_1.pipe)((0, Array_1.traverse)(TE.ApplicativeSeq)((route) => (0, function_1.pipe)(this.decodeOperation(route.path, path.path, route.method), TE.bindTo('decodedPath'), TE.chain(({ decodedPath }) => (0, function_1.pipe)(this.generateOperationDirectory(connectorPath, decodedPath.operationId), TE.bind('inputs', () => TE.right((0, GenerateInputSchema_1.generateInputSchema)(decodedPath))), TE.bind('outputs', () => (0, GenerateOutput_1.generateOutputSchema)(decodedPath.responses)), TE.bind('decodedPath', () => TE.right(decodedPath)))), TE.chain(({ inputs, outputs, decodedPath }) => this.generateHandlerFilesAndOperationJson(route.method, decodedPath, `${connectorPath}/src/${(0, lodash_1.kebabCase)(decodedPath.operationId)}`, baseUrl, path.path, connectorName, inputs, outputs))))(path.routes), TE.map(() => undefined));
+        return (0, function_1.pipe)((0, Array_1.traverse)(TE.ApplicativeSeq)((route) => (0, function_1.pipe)(this.decodeOperation(route.path, path.path, route.method), TE.bindTo('decodedPath'), TE.chain(({ decodedPath }) => (0, function_1.pipe)(this.generateOperationDirectory(connectorPath, decodedPath.operationId), TE.bind('inputs', () => TE.right((0, GenerateInputSchema_1.generateInputSchema)(decodedPath))), TE.bind('outputs', () => (0, GenerateOutput_1.generateOutputSchema)(decodedPath.responses)), TE.bind('decodedPath', () => TE.right(decodedPath)))), TE.chain(({ inputs, outputs, decodedPath }) => this.generateHandlerFilesAndOperationJson(route.method, decodedPath, `${connectorPath}/src/${(0, lodash_1.kebabCase)(decodedPath.operationId)}`, baseUrl, path.path, connectorName, inputs, outputs)), TE.map(() => ({
+            tag: 'success',
+            httpMethod: route.method,
+            path: path.path,
+        })), TE.orElseW((error) => TE.right({
+            tag: 'error',
+            httpMethod: route.method,
+            path: path.path,
+            errorMessage: error.message,
+        }))))(path.routes));
     }
     decodeOperation(path, httpPath, method) {
         return (0, function_1.pipe)(TE.fromEither(OpenApiCodecs_1.pathCodec.decode(path)), TE.mapLeft((error) => new Error(`Failed to decode httpPath: ${httpPath} and method: ${method} : ${error}`)));

package/dist/OpenApiSchemaImporter.test.js

@@ -35,9 +35,10 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const NodeFsGenerator_1 = require("@trayio/generator/generator/NodeFsGenerator");
 const FakeFileStorage_1 = require("@trayio/commons/file/FakeFileStorage");
 const stream_1 = require("stream");
+const E = __importStar(require("fp-ts/Either"));
 const fs = __importStar(require("fs-extra"));
 const OpenApiSchemaImporter_1 = require("./OpenApiSchemaImporter");
-const openApiSpec = __importStar(require("./single-get-openapi.json"));
+const openApiSpec = __importStar(require("./test-openapi-spec.json"));
 describe('openApiSchemaImporter', () => {
     const generator = new NodeFsGenerator_1.NodeFsGenerator();
     const fileStorage = new FakeFileStorage_1.FakeFileStorage();
@@ -45,17 +46,21 @@ describe('openApiSchemaImporter', () => {
     let result;
     beforeAll(() => __awaiter(void 0, void 0, void 0, function* () {
         fileStorage.write({
-            key: `${__dirname}/single-get-openapi.json`,
-            metadata: { name: 'single-get-openapi.json' },
+            key: `${__dirname}/test-openapi-spec.json`,
+            metadata: { name: 'test-openapi-spec.json' },
             content: stream_1.Readable.from(Buffer.from(JSON.stringify(openApiSpec))),
         });
-        result = yield openApiSchemaImporter.buildConnector(`${__dirname}/single-get-openapi.json`, 'testConnector')();
+        result = yield openApiSchemaImporter.buildConnector(`${__dirname}/test-openapi-spec.json`, 'testConnector')();
     }));
     afterAll(() => __awaiter(void 0, void 0, void 0, function* () {
         yield fs.rm(`${process.cwd()}/test/`, { recursive: true, force: true });
     }));
     it('should import successfully', () => {
-        expect(result._tag).toEqual('Right');
+        const buildConnectorResponse = E.getOrElse((error) => {
+            throw new Error('Should have been right');
+        })(result);
+        expect(buildConnectorResponse.successes.length).toEqual(1);
+        expect(buildConnectorResponse.errors.length).toEqual(1);
     });
     it('should generate a operation handler', () => {
         expect(fileStorage.files.has(`/test/test-connector/src/get-post/handler.ts`)).toEqual(true);
@@ -72,4 +77,7 @@ describe('openApiSchemaImporter', () => {
     it('should generate a operation directory', () => {
         expect(fileStorage.files.has(`/test/test-connector/src/get-post`)).toEqual(true);
     });
+    it('should not generate a operation directory when failing to decode', () => {
+        expect(fileStorage.files.has(`/test/test-connector/src/update-post`)).toEqual(false);
+    });
 });

package/dist/{single-get-openapi.json → test-openapi-spec.json}

@@ -12,9 +12,66 @@
   ],
   "paths": {
     "/posts/{id}": {
+      "put": {
+        "description": "Update a post",
+        "tags": [
+          "post"
+        ],
+        "operationId": "updatePost",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "required": 1,
+                "properties": {
+                  "id": {
+                    "type": "integer"
+                  },
+                  "userId": {
+                    "type": "integer"
+                  },
+                  "title": {
+                    "type": "string"
+                  },
+                  "body": {
+                    "type": "string"
+                  }
+                }
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "All went well",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Post"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Post not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {}
+                }
+              }
+            }
+          }
+        }
+      },
       "get": {
         "description": "Returns a post by id",
-        "tags": ["Posts"],
+        "tags": [
+          "Posts"
+        ],
         "operationId": "getPost",
         "parameters": [
           {
@@ -57,7 +114,12 @@
       },
       "Post": {
         "type": "object",
-        "required": ["id", "userId", "title", "body"],
+        "required": [
+          "id",
+          "userId",
+          "title",
+          "body"
+        ],
         "properties": {
           "id": {
             "type": "integer"
@@ -75,4 +137,4 @@
       }
     }
   }
-}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trayio/tray-openapi",
-  "version": "2.10.0",
+  "version": "2.11.0",
   "description": "Creating CDK Projects from OpenAPI 3.0 Schemas",
   "exports": {
     "./*": "./dist/*.js"