npm - @trayio/tray-openapi - Versions diffs - 2.10.0 → 2.11.1 - Mend

@trayio/tray-openapi 2.10.0 → 2.11.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (23) hide show

package/dist/OpenApiSchemaImporter.d.ts +2 -1
package/dist/OpenApiSchemaImporter.d.ts.map +1 -1
package/dist/OpenApiSchemaImporter.js +23 -4
package/dist/OpenApiSchemaImporter.test.js +20 -10
package/dist/OpenApiSchemaTransformer.d.ts +9 -0
package/dist/OpenApiSchemaTransformer.d.ts.map +1 -0
package/dist/OpenApiSchemaTransformer.js +68 -0
package/dist/OpenApiSchemaTransformer.test.d.ts +2 -0
package/dist/OpenApiSchemaTransformer.test.d.ts.map +1 -0
package/dist/OpenApiSchemaTransformer.test.js +118 -0
package/dist/OpenApiTypeDescriptors.d.ts +38 -6
package/dist/OpenApiTypeDescriptors.d.ts.map +1 -1
package/dist/OpenApiTypeDescriptors.js +4 -11
package/dist/file-generators/types/GenerateInputSchema.d.ts +2 -1
package/dist/file-generators/types/GenerateInputSchema.d.ts.map +1 -1
package/dist/file-generators/types/GenerateInputSchema.js +22 -27
package/dist/file-generators/types/GenerateInputSchema.test.js +54 -9
package/dist/file-generators/types/GenerateInputType.test.js +38 -13
package/dist/file-generators/types/GenerateOutput.d.ts.map +1 -1
package/dist/file-generators/types/GenerateOutput.js +1 -4
package/dist/test-openapi-spec.json +160 -0
package/package.json +1 -1
package/dist/single-get-openapi.json +0 -78

package/dist/OpenApiSchemaImporter.d.ts CHANGED Viewed

@@ -1,11 +1,12 @@
 import * as TE from 'fp-ts/TaskEither';
 import { FileStorage } from '@trayio/commons/file/File';
 import { Generator } from '@trayio/generator/generator/Generator';
+import { BuildConnectorResponse } from './OpenApiTypeDescriptors';
 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;

package/dist/OpenApiSchemaImporter.d.ts.map CHANGED Viewed

	@@ -1 +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"}
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;AAGlE,OAAO,EAEN,sBAAsB,EAMtB,MAAM,0BAA0B,CAAC;AAalC,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;IAoD/C,OAAO,CAAC,yBAAyB;IAyDjC,OAAO,CAAC,eAAe;IAgBvB,OAAO,CAAC,cAAc;IAoCtB,OAAO,CAAC,oCAAoC;IAgF5C,OAAO,CAAC,0BAA0B;IAwBlC,OAAO,CAAC,0BAA0B;CAclC"}

package/dist/OpenApiSchemaImporter.js CHANGED Viewed

@@ -42,6 +42,7 @@ const GenerateInputTypes_1 = require("./file-generators/types/GenerateInputTypes
 const GenerateHandlerTest_1 = require("./file-generators/GenerateHandlerTest");
 const GenerateOperationJson_1 = require("./file-generators/GenerateOperationJson");
 const GenerateInputSchema_1 = require("./file-generators/types/GenerateInputSchema");
+const OpenApiSchemaTransformer_1 = require("./OpenApiSchemaTransformer");
 class OpenApiSchemaImporter {
     constructor(generator, fileStorage) {
         this.generator = generator;
@@ -59,10 +60,28 @@ 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) => {
+            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.fromEither((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}`)));
@@ -72,7 +91,7 @@ class OpenApiSchemaImporter {
             const resolver = new json_ref_resolver_1.Resolver({});
             const resolvedOpenApiSpec = resolver.resolve(openApiSpec, {});
             return resolvedOpenApiSpec;
-        }, (reason) => new Error(`Failed to resolve references in schema: ${reason}`))), TE.chain((openApiSpec) => TE.right(openApiSpec.result)));
+        }, (reason) => new Error(`Failed to resolve references in schema: ${reason}`))), TE.chain((openApiSpec) => TE.fromEither((0, OpenApiSchemaTransformer_1.mergePathLevelParamsIntoHttpMethod)(openApiSpec.result))));
     }
     generateHandlerFilesAndOperationJson(method, path, operationPath, baseUrl, httpPath, connectorName, input, output) {
         const writeFile = (content, fileName) => this.fileStorage.write({
@@ -110,7 +129,7 @@ class OpenApiSchemaImporter {
             connectorNameKebabCase: (0, lodash_1.kebabCase)(connectorName),
             connectorNamePascalCase: StringExtensions_1.StringExtensions.pascalCase(connectorName),
             connectorNameCamelCase: (0, lodash_1.camelCase)(connectorName),
-        }), TE.chain((parameters) => this.generator.generate(`${__dirname}/templates/connector-template.zip`, `${process.cwd()}/test`, parameters)), TE.map(() => `/test/${(0, lodash_1.kebabCase)(connectorName)}`), TE.mapLeft((error) => new Error(`Failed to generate connector directory: ${error}`)));
+        }), TE.chain((parameters) => this.generator.generate(`${__dirname}/templates/connector-template.zip`, process.cwd(), parameters)), TE.map(() => `/${(0, lodash_1.kebabCase)(connectorName)}`), TE.mapLeft((error) => new Error(`Failed to generate connector directory: ${error}`)));
     }
     generateOperationDirectory(connectorPath, operationName) {
         return (0, function_1.pipe)(TE.tryCatch(this.fileStorage.createDirectory(`${connectorPath}/src/${(0, lodash_1.kebabCase)(operationName)}`), (error) => new Error(`Failed to create operation directory: ${error}`)), TE.map(() => `${connectorPath}/src/${(0, lodash_1.kebabCase)(operationName)}`));

package/dist/OpenApiSchemaImporter.test.js CHANGED Viewed

@@ -35,41 +35,51 @@ 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();
     const openApiSchemaImporter = new OpenApiSchemaImporter_1.OpenApiSchemaImporter(generator, fileStorage);
     let result;
+    const spec = 'test-openapi-spec.json';
     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}/${spec}`,
+            metadata: { name: spec },
             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}/${spec}`, '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) => {
+            console.error(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);
+        expect(fileStorage.files.has(`/test-connector/src/get-post/handler.ts`)).toEqual(true);
     });
     it('should generate an operation handler test', () => {
-        expect(fileStorage.files.has(`/test/test-connector/src/get-post/handler.test.ts`)).toEqual(true);
+        expect(fileStorage.files.has(`/test-connector/src/get-post/handler.test.ts`)).toEqual(true);
     });
     it('should generate an operation.json', () => {
-        expect(fileStorage.files.has(`/test/test-connector/src/get-post/operation.json`)).toEqual(true);
+        expect(fileStorage.files.has(`/test-connector/src/get-post/operation.json`)).toEqual(true);
     });
     it('should generate an output.ts', () => {
-        expect(fileStorage.files.has(`/test/test-connector/src/get-post/output.ts`)).toEqual(true);
+        expect(fileStorage.files.has(`/test-connector/src/get-post/output.ts`)).toEqual(true);
     });
     it('should generate a operation directory', () => {
-        expect(fileStorage.files.has(`/test/test-connector/src/get-post`)).toEqual(true);
+        expect(fileStorage.files.has(`/test-connector/src/get-post`)).toEqual(true);
+    });
+    it('should not generate a operation directory when failing to decode', () => {
+        expect(fileStorage.files.has(`/test-connector/src/update-post`)).toEqual(false);
     });
 });

package/dist/OpenApiSchemaTransformer.d.ts ADDED Viewed

@@ -0,0 +1,9 @@
+import * as E from 'fp-ts/Either';
+import { BaseOpenApiSpec } from './OpenApiTypeDescriptors';
+export declare const isObject: (value: unknown) => value is Record<string, unknown>;
+export declare const isObjectWithParameters: (value: unknown) => value is Record<string, unknown> & {
+    parameters: unknown[];
+};
+export declare const getMergedParameters: (pathValue: Record<string, unknown>, httpMethodValue: Record<string, unknown>) => unknown[];
+export declare const mergePathLevelParamsIntoHttpMethod: (openApiSpec: BaseOpenApiSpec) => E.Either<Error, BaseOpenApiSpec>;
+//# sourceMappingURL=OpenApiSchemaTransformer.d.ts.map

package/dist/OpenApiSchemaTransformer.d.ts.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"OpenApiSchemaTransformer.d.ts","sourceRoot":"","sources":["../src/OpenApiSchemaTransformer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,cAAc,CAAC;AAClC,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAE3D,eAAO,MAAM,QAAQ,UAAW,OAAO,qCACK,CAAC;AAE7C,eAAO,MAAM,sBAAsB,UAC3B,OAAO;gBACqC,OAAO,EAAE;CACpB,CAAC;AAE1C,eAAO,MAAM,mBAAmB,cACpB,OAAO,MAAM,EAAE,OAAO,CAAC,mBACjB,OAAO,MAAM,EAAE,OAAO,CAAC,KACtC,OAAO,EAcT,CAAC;AAEF,eAAO,MAAM,kCAAkC,gBACjC,eAAe,KAC1B,EAAE,MAAM,CAAC,KAAK,EAAE,eAAe,CAkCjC,CAAC"}

package/dist/OpenApiSchemaTransformer.js ADDED Viewed

@@ -0,0 +1,68 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.mergePathLevelParamsIntoHttpMethod = exports.getMergedParameters = exports.isObjectWithParameters = exports.isObject = void 0;
+const E = __importStar(require("fp-ts/Either"));
+const isObject = (value) => typeof value === 'object' && value !== null;
+exports.isObject = isObject;
+const isObjectWithParameters = (value) => (0, exports.isObject)(value) && 'parameters' in value;
+exports.isObjectWithParameters = isObjectWithParameters;
+const getMergedParameters = (pathValue, httpMethodValue) => {
+    if (!Array.isArray(pathValue.parameters)) {
+        throw new Error('Path parameters is not an array');
+    }
+    // if the method contains existing parameters, we merge them with the path parameters
+    if ('parameters' in httpMethodValue &&
+        Array.isArray(httpMethodValue.parameters)) {
+        return [...httpMethodValue.parameters, ...pathValue.parameters];
+    }
+    return pathValue.parameters;
+};
+exports.getMergedParameters = getMergedParameters;
+const mergePathLevelParamsIntoHttpMethod = (openApiSpec) => {
+    const paths = Object.entries(openApiSpec.paths).reduce((pathAcc, [pathName, pathValue]) => {
+        // if the path doesn't contain top level params, we just return it
+        if (!(0, exports.isObjectWithParameters)(pathValue)) {
+            pathAcc[pathName] = pathValue;
+            return pathAcc;
+        }
+        const updatedPathValue = Object.entries(pathValue).reduce((methodAcc, [httpMethodName, httpMethodValue]) => {
+            if (!(0, exports.isObject)(httpMethodValue)) {
+                throw new Error('Http method value is not an object');
+            }
+            // we skip adding the parameters object to the path object
+            if (httpMethodName === 'parameters') {
+                return methodAcc;
+            }
+            const parameters = (0, exports.getMergedParameters)(pathValue, httpMethodValue);
+            methodAcc[httpMethodName] = Object.assign(Object.assign({}, httpMethodValue), { parameters });
+            return methodAcc;
+        }, {});
+        pathAcc[pathName] = updatedPathValue;
+        return pathAcc;
+    }, {});
+    return E.right(Object.assign(Object.assign({}, openApiSpec), { paths }));
+};
+exports.mergePathLevelParamsIntoHttpMethod = mergePathLevelParamsIntoHttpMethod;

package/dist/OpenApiSchemaTransformer.test.d.ts ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ export {};
2	+ //# sourceMappingURL=OpenApiSchemaTransformer.test.d.ts.map

package/dist/OpenApiSchemaTransformer.test.d.ts.map ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"version":3,"file":"OpenApiSchemaTransformer.test.d.ts","sourceRoot":"","sources":["../src/OpenApiSchemaTransformer.test.ts"],"names":[],"mappings":""}

package/dist/OpenApiSchemaTransformer.test.js ADDED Viewed

@@ -0,0 +1,118 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const E = __importStar(require("fp-ts/Either"));
+const OpenApiSchemaTransformer_1 = require("./OpenApiSchemaTransformer");
+describe('mergePathLevelParamsIntoHttpMethod', () => {
+    it('should merge path level parameters into HTTP methods', () => {
+        const openApiSpec = {
+            openapi: '3.0.0',
+            info: {
+                version: '1.0.0',
+                title: 'JSON Placeholder API',
+                description: 'See https://jsonplaceholder.typicode.com/',
+            },
+            servers: [
+                {
+                    url: 'https://jsonplaceholder.typicode.com',
+                },
+            ],
+            paths: {
+                '/path': {
+                    parameters: [{ name: 'param1', in: 'query', required: false }],
+                    get: {
+                        parameters: [{ name: 'param2', in: 'query', required: true }],
+                    },
+                },
+            },
+        };
+        const result = (0, OpenApiSchemaTransformer_1.mergePathLevelParamsIntoHttpMethod)(openApiSpec);
+        E.fold((error) => {
+            throw new Error(`Test failed with error: ${error.message}`);
+        }, (updatedOpenApiSpec) => {
+            expect(updatedOpenApiSpec.paths['/path'].get.parameters).toEqual([
+                { name: 'param2', in: 'query', required: true },
+                { name: 'param1', in: 'query', required: false },
+            ]);
+        })(result);
+    });
+    it('should return the original spec if no top level parameters', () => {
+        const openApiSpec = {
+            openapi: '3.0.0',
+            info: {
+                version: '1.0.0',
+                title: 'JSON Placeholder API',
+                description: 'See https://jsonplaceholder.typicode.com/',
+            },
+            servers: [
+                {
+                    url: 'https://jsonplaceholder.typicode.com',
+                },
+            ],
+            paths: {
+                '/path': {
+                    get: {
+                        parameters: [{ name: 'param2', in: 'query', required: true }],
+                    },
+                },
+            },
+        };
+        const result = (0, OpenApiSchemaTransformer_1.mergePathLevelParamsIntoHttpMethod)(openApiSpec);
+        E.fold((error) => {
+            throw new Error(`Test failed with error: ${error.message}`);
+        }, (updatedOpenApiSpec) => {
+            expect(updatedOpenApiSpec).toEqual(openApiSpec);
+        })(result);
+    });
+    it('should add path level parameters into HTTP methods, if no method params already exist', () => {
+        const openApiSpec = {
+            openapi: '3.0.0',
+            info: {
+                version: '1.0.0',
+                title: 'JSON Placeholder API',
+                description: 'See https://jsonplaceholder.typicode.com/',
+            },
+            servers: [
+                {
+                    url: 'https://jsonplaceholder.typicode.com',
+                },
+            ],
+            paths: {
+                '/path': {
+                    parameters: [{ name: 'param1', in: 'query', required: false }],
+                    get: {},
+                },
+            },
+        };
+        const result = (0, OpenApiSchemaTransformer_1.mergePathLevelParamsIntoHttpMethod)(openApiSpec);
+        E.fold((error) => {
+            throw new Error(`Test failed with error: ${error.message}`);
+        }, (updatedOpenApiSpec) => {
+            expect(updatedOpenApiSpec.paths['/path'].get.parameters).toEqual([
+                { name: 'param1', in: 'query', required: false },
+            ]);
+        })(result);
+    });
+});

package/dist/OpenApiTypeDescriptors.d.ts CHANGED Viewed

@@ -1,5 +1,41 @@
 import * as t from 'io-ts';
 import * as O from 'fp-ts/Option';
+export type FlatPath = {
+    path: string;
+    routes: {
+        method: OpenApiHttpMethod;
+        path: unknown;
+    }[];
+};
+export type Server = {
+    url: string;
+};
+export type BaseOpenApiSpec = {
+    openapi: string;
+    info: {
+        version: string;
+        title: string;
+        description: string;
+    };
+    servers: Server[];
+    paths: Record<string, Record<string, unknown>>;
+};
+export type BaseOperation = {
+    httpMethod: OpenApiHttpMethod;
+    path: string;
+};
+export type OperationError = BaseOperation & {
+    tag: 'error';
+    errorMessage: string;
+};
+export type OperationSuccess = BaseOperation & {
+    tag: 'success';
+};
+export type Operation = OperationError | OperationSuccess;
+export type BuildConnectorResponse = {
+    successes: OperationSuccess[];
+    errors: OperationError[];
+};
 export type Path = {
     description: string;
     tags: O.Option<string[]>;
@@ -12,12 +48,8 @@ export type Parameter = {
     name: string;
     in: string;
     description: string;
-    required: boolean;
-    schema: {
-        type: string;
-        format: O.Option<string>;
-        items: O.Option<SchemaObject>;
-    };
+    required: O.Option<boolean>;
+    schema: SchemaObject;
 };
 export type RequestBody = {
     content: Record<string, MediaTypeObject>;

package/dist/OpenApiTypeDescriptors.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"OpenApiTypeDescriptors.d.ts","sourceRoot":"","sources":["../src/OpenApiTypeDescriptors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,OAAO,CAAC;AAE3B,OAAO,KAAK,CAAC,MAAM,cAAc,CAAC;~~AAGlC~~,MAAM,MAAM,~~IAAI~~,GAAG;~~IAClB~~,~~WAAW~~,EAAE,MAAM,CAAC;~~IACpB~~,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;~~IACzB~~,WAAW,EAAE,MAAM,CAAC;~~IACpB~~,~~UAAU~~,EAAE,CAAC,CAAC,MAAM,CAAC,~~SAAS~~,EAAE,CAAC,CAAC;~~IAClC~~,~~WAAW~~,EAAE,CAAC,CAAC,MAAM,CAAC,~~WAAW~~,CAAC,CAAC;~~IACnC~~,~~SAAS~~,EAAE,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;~~CAC/B~~,CAAC;~~AAEF~~,MAAM,MAAM,~~SAAS~~,GAAG;~~IACvB~~,~~IAAI~~,EAAE,MAAM,CAAC;~~IACb~~,~~EAAE~~,EAAE,MAAM,CAAC;~~IACX~~,WAAW,EAAE,MAAM,CAAC;IACpB,~~QAAQ~~,EAAE,~~OAAO~~,CAAC~~;IAClB~~,MAAM,EAAE;~~QACP~~,~~IAAI~~,EAAE,MAAM,CAAC;~~QACb~~,~~MAAM~~,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;~~QACzB~~,~~KAAK~~,EAAE,CAAC,CAAC,MAAM,CAAC,~~YAAY~~,CAAC,CAAC;~~KAC9B~~,CAAC;~~CACF~~,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACzB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CACzC,CAAC;AAEF,MAAM,WAAW,eAAe;IAC/B,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;CAC/B;AAED,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AAEjD,MAAM,MAAM,QAAQ,GAAG;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC;CACnD,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE5E,KAAK,eAAe,GAAG;IACtB,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC;CAChD,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE;QACL,KAAK,EAAE,MAAM,CAAC;QACd,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,OAAO,EAAE;QACR,GAAG,EAAE,MAAM,CAAC;KACZ,EAAE,CAAC;IACJ,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAChE,UAAU,EAAE,eAAe,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,iBAAiB,GAAG,oBAAoB,CAAC;AAEpE,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IAC1D,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,YAAY,CAAC;CACpB;AAED,MAAM,MAAM,wBAAwB,GACjC,SAAS,GACT,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,SAAS,CAAC;AAEb,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC7D,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,wBAAwB,CAAC,CAAC;CACzC;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC9B,oBAAoB,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,GAAG,YAAY,CAAC,CAAC;IACvD,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC;IACnD,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IAC7B,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;IAChC,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;IAChC,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;IAChC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IAC5B,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;CACrB,CAAC;AAYF,eAAO,MAAM,oCAAoC,EAAE,CAAC,CAAC,IAAI,CACxD,gBAAgB,EAChB,OAAO,CAgBP,CAAC;AAyBF,eAAO,MAAM,0BAA0B,EAAE,CAAC,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAMnE,CAAC;AAEH,eAAO,MAAM,qBAAqB,~~wDAOjC~~,CAAC;AAuBF,eAAO,MAAM,6BAA6B,EAAE,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,~~CAYpE~~,CAAC;AAEF,eAAO,MAAM,6BAA6B,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAO9D,CAAC;AAUH,eAAO,MAAM,yBAAyB,EAAE,CAAC,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAWpE,CAAC"}
1	+ {"version":3,"file":"OpenApiTypeDescriptors.d.ts","sourceRoot":"","sources":["../src/OpenApiTypeDescriptors.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,OAAO,CAAC;AAE3B,OAAO,KAAK,CAAC,MAAM,cAAc,CAAC;AAKlC,MAAM,MAAM,QAAQ,GAAG;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE;QAAE,MAAM,EAAE,iBAAiB,CAAC;QAAC,IAAI,EAAE,OAAO,CAAA;KAAE,EAAE,CAAC;CACvD,CAAC;AAEF,MAAM,MAAM,MAAM,GAAG;IACpB,GAAG,EAAE,MAAM,CAAC;CACZ,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE;QACL,OAAO,EAAE,MAAM,CAAC;QAChB,KAAK,EAAE,MAAM,CAAC;QACd,WAAW,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CAC/C,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC3B,UAAU,EAAE,iBAAiB,CAAC;IAC9B,IAAI,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,MAAM,MAAM,cAAc,GAAG,aAAa,GAAG;IAC5C,GAAG,EAAE,OAAO,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,aAAa,GAAG;IAC9C,GAAG,EAAE,SAAS,CAAC;CACf,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,cAAc,GAAG,gBAAgB,CAAC;AAE1D,MAAM,MAAM,sBAAsB,GAAG;IACpC,SAAS,EAAE,gBAAgB,EAAE,CAAC;IAC9B,MAAM,EAAE,cAAc,EAAE,CAAC;CACzB,CAAC;AAIF,MAAM,MAAM,IAAI,GAAG;IAClB,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;IAClC,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACnC,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC5B,MAAM,EAAE,YAAY,CAAC;CACrB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACzB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;CACzC,CAAC;AAEF,MAAM,WAAW,eAAe;IAC/B,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;CAC/B;AAED,MAAM,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AAEjD,MAAM,MAAM,QAAQ,GAAG;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC;CACnD,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;AAE5E,KAAK,eAAe,GAAG;IACtB,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC;CAChD,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC3B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE;QACL,KAAK,EAAE,MAAM,CAAC;QACd,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,OAAO,EAAE;QACR,GAAG,EAAE,MAAM,CAAC;KACZ,EAAE,CAAC;IACJ,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,MAAM,CAAC,iBAAiB,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;IAChE,UAAU,EAAE,eAAe,CAAC;CAC5B,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG,iBAAiB,GAAG,oBAAoB,CAAC;AAEpE,MAAM,WAAW,iBAAkB,SAAQ,gBAAgB;IAC1D,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,YAAY,CAAC;CACpB;AAED,MAAM,MAAM,wBAAwB,GACjC,SAAS,GACT,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,SAAS,CAAC;AAEb,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC7D,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,wBAAwB,CAAC,CAAC;CACzC;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC9B,oBAAoB,EAAE,CAAC,CAAC,MAAM,CAAC,OAAO,GAAG,YAAY,CAAC,CAAC;IACvD,UAAU,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC;IACnD,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IAC7B,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;IAChC,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;IAChC,KAAK,EAAE,CAAC,CAAC,MAAM,CAAC,YAAY,EAAE,CAAC,CAAC;IAChC,GAAG,EAAE,CAAC,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IAC5B,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;CACrB,CAAC;AAYF,eAAO,MAAM,oCAAoC,EAAE,CAAC,CAAC,IAAI,CACxD,gBAAgB,EAChB,OAAO,CAgBP,CAAC;AAyBF,eAAO,MAAM,0BAA0B,EAAE,CAAC,CAAC,IAAI,CAAC,YAAY,EAAE,OAAO,CAMnE,CAAC;AAEH,eAAO,MAAM,qBAAqB,wDAEjC,CAAC;AAuBF,eAAO,MAAM,6BAA6B,EAAE,CAAC,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAQpE,CAAC;AAEF,eAAO,MAAM,6BAA6B,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,CAO9D,CAAC;AAUH,eAAO,MAAM,yBAAyB,EAAE,CAAC,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAWpE,CAAC"}

package/dist/OpenApiTypeDescriptors.js CHANGED Viewed

@@ -27,7 +27,7 @@ exports.openApiSpecTypeDescriptor = exports.openApiSpecPathTypeDescriptor = expo
 const t = __importStar(require("io-ts"));
 const io_ts_types_1 = require("io-ts-types");
 const TypeCodec_1 = require("@trayio/commons/codec/TypeCodec");
-// Codecs
+// Type Descriptors
 const nonArraySchemaObjectType = t.keyof({
     boolean: null,
     object: null,
@@ -61,10 +61,7 @@ exports.schemaObjectTypeDescriptor = t.recursion('schemaObject', () => t.union([
     arraySchemaObjectSchemaTypeDescriptor,
     nonArraySchemaObjectSchemaTypeDescriptor,
 ]));
-exports.schemaObjectTypeCodec = TypeCodec_1.TypeCodec.fromDescriptor(t.recursion('schemaObject', () => t.union([
-    arraySchemaObjectSchemaTypeDescriptor,
-    nonArraySchemaObjectSchemaTypeDescriptor,
-])));
+exports.schemaObjectTypeCodec = TypeCodec_1.TypeCodec.fromDescriptor(exports.schemaObjectTypeDescriptor);
 const componentSchemaTypeDescriptor = t.type({
     schemas: (0, io_ts_types_1.optionFromNullable)(t.record(t.string, exports.schemaObjectTypeDescriptor)),
 });
@@ -82,12 +79,8 @@ exports.parameterSchemaTypeDescriptor = t.type({
     name: t.string,
     in: t.string,
     description: t.string,
-    required: t.boolean,
-    schema: t.type({
-        type: t.string,
-        format: (0, io_ts_types_1.optionFromNullable)(t.string),
-        items: (0, io_ts_types_1.optionFromNullable)(exports.schemaObjectTypeDescriptor),
-    }),
+    required: (0, io_ts_types_1.optionFromNullable)(t.boolean),
+    schema: exports.schemaObjectTypeDescriptor,
 });
 exports.openApiSpecPathTypeDescriptor = t.type({
     description: t.string,

package/dist/file-generators/types/GenerateInputSchema.d.ts CHANGED Viewed

@@ -1,3 +1,4 @@
+import * as E from 'fp-ts/Either';
 import { Path, SchemaObject } from '../../OpenApiTypeDescriptors';
-export declare const generateInputSchema: (endpoint: Path) => SchemaObject;
+export declare const generateInputSchema: (endpoint: Path) => E.Either<Error, SchemaObject>;
 //# sourceMappingURL=GenerateInputSchema.d.ts.map

package/dist/file-generators/types/GenerateInputSchema.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"GenerateInputSchema.d.ts","sourceRoot":"","sources":["../../../src/file-generators/types/GenerateInputSchema.ts"],"names":[],"mappings":"~~AAMA~~,OAAO,EACN,IAAI,EAGJ,YAAY,EAEZ,MAAM,8BAA8B,CAAC;~~AA8HtC~~,eAAO,MAAM,mBAAmB,~~aAAc~~,IAAI,~~KAAG~~,~~YAiCpD~~,CAAC"}
1	+ {"version":3,"file":"GenerateInputSchema.d.ts","sourceRoot":"","sources":["../../../src/file-generators/types/GenerateInputSchema.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,CAAC,MAAM,cAAc,CAAC;AAQlC,OAAO,EACN,IAAI,EAGJ,YAAY,EAEZ,MAAM,8BAA8B,CAAC;AAyItC,eAAO,MAAM,mBAAmB,aACrB,IAAI,KACZ,EAAE,MAAM,CAAC,KAAK,EAAE,YAAY,CAiC9B,CAAC"}

package/dist/file-generators/types/GenerateInputSchema.js CHANGED Viewed

@@ -24,6 +24,8 @@ var __importStar = (this && this.__importStar) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.generateInputSchema = void 0;
+const E = __importStar(require("fp-ts/Either"));
+const function_1 = require("fp-ts/function");
 const lodash_1 = require("lodash");
 const O = __importStar(require("fp-ts/Option"));
 const openapi_schema_to_json_schema_1 = require("@openapi-contrib/openapi-schema-to-json-schema");
@@ -62,7 +64,7 @@ const transformInput = (parameters) => {
             throw new Error('Failed to decode params');
         }
         transformedParameters[parameter.name] = decodedParam.right;
-        if (parameter.required === true) {
+        if (O.isSome(parameter.required) && parameter.required.value === true) {
             requiredParameters.push(parameter.name);
         }
     });
@@ -85,49 +87,42 @@ const appendInPropertyToBody = (body) => O.fold(() => body, (properties) => {
     const propsWithInBody = Object.keys(properties).reduce((acc, name) => (Object.assign(Object.assign({}, acc), { [name]: Object.assign(Object.assign({}, properties[name]), { in: O.some('body') }) })), {});
     return Object.assign(Object.assign({}, body), { properties: O.some(propsWithInBody) });
 })(body.properties);
+const blankOutputSchema = () => ({
+    type: O.none,
+    properties: O.none,
+    required: O.none,
+    additionalProperties: O.some(false),
+    allOf: O.none,
+    anyOf: O.none,
+    oneOf: O.none,
+    not: O.none,
+    in: O.none,
+});
 const getApplicationJsonMediaType = (content) => {
+    if (!Object.keys(content).length)
+        return E.right({ schema: O.none });
     // TODO: we should support any value here, but there may also be more than 1 media type so we need to iterate through
     // and combine all the schemas within into a single set of inputs
     const mediaTypeApplicationJson = Object.keys(content).find((mediaType) => /^application\/.*json$/.test(mediaType));
-    // TODO: fold here instead of getOrElse
     if (mediaTypeApplicationJson) {
-        return O.getOrElse(() => {
-            throw new Error('');
-        })(content[mediaTypeApplicationJson].schema);
+        return E.right(content[mediaTypeApplicationJson]);
     }
     const mediaTypes = Object.keys(content);
-    throw new Error(`Unsupported media type: ${mediaTypes}`);
+    return E.left(new Error(`Unsupported media type: ${mediaTypes}`));
 };
 const generateInputSchema = (endpoint) => {
-    // TODO: use the encode method instead of this, or fold over the values
     const parameters = O.toNullable(endpoint.parameters);
     const requestBody = O.toNullable(endpoint.requestBody);
     if (parameters && !requestBody) {
-        return transformInput(parameters);
+        return E.right(transformInput(parameters));
     }
     if (requestBody && !parameters) {
-        // TODO: update all uses to this now that getAppJsonMedia doesn't do get content within it? return getApplicationJsonMediaType(getContent(requestBody.content));
-        const body = getApplicationJsonMediaType(requestBody.content);
-        return appendInPropertyToBody(body);
-        // return getApplicationJsonMediaType(getContent(requestBody.content));
+        return (0, function_1.pipe)(getApplicationJsonMediaType(requestBody.content), E.map((mediaTypeObject) => O.fold(() => blankOutputSchema(), (schema) => appendInPropertyToBody(schema))(mediaTypeObject.schema)));
     }
     if (requestBody && parameters) {
         const params = transformInput(parameters);
-        const body = getApplicationJsonMediaType(requestBody.content);
-        const bodyWithInProperty = appendInPropertyToBody(body);
-        const mergedParamsAndBody = mergeParamsAndBody(params, bodyWithInProperty);
-        return mergedParamsAndBody;
+        return (0, function_1.pipe)(getApplicationJsonMediaType(requestBody.content), E.map((mediaTypeObject) => O.fold(() => blankOutputSchema(), (schema) => appendInPropertyToBody(schema))(mediaTypeObject.schema)), E.chain((schema) => E.right(mergeParamsAndBody(params, schema))));
     }
-    return {
-        type: O.none,
-        properties: O.none,
-        required: O.none,
-        additionalProperties: O.some(false),
-        allOf: O.none,
-        anyOf: O.none,
-        oneOf: O.none,
-        not: O.none,
-        in: O.none,
-    };
+    return E.right(blankOutputSchema());
 };
 exports.generateInputSchema = generateInputSchema;

package/dist/file-generators/types/GenerateInputSchema.test.js CHANGED Viewed

@@ -32,6 +32,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const E = __importStar(require("fp-ts/Either"));
 const TE = __importStar(require("fp-ts/TaskEither"));
 const O = __importStar(require("fp-ts/Option"));
 const GenerateInputSchema_1 = require("./GenerateInputSchema");
@@ -46,12 +47,38 @@ describe('GenerateInputSchema', () => {
                 {
                     name: 'id',
                     in: 'path',
-                    required: true,
+                    required: O.some(true),
                     description: 'The user id.',
                     schema: {
-                        type: 'integer',
-                        format: O.some('int64'),
+                        type: O.some('integer'),
+                        properties: O.none,
+                        additionalProperties: O.some(false),
+                        required: O.none,
+                        allOf: O.none,
+                        anyOf: O.none,
+                        oneOf: O.none,
+                        not: O.none,
+                        in: O.none,
+                    },
+                    additionalProperties: O.none,
+                },
+                {
+                    name: 'date',
+                    in: 'query',
+                    required: O.none,
+                    description: 'The date of the post.',
+                    schema: {
+                        type: O.some('string'),
+                        properties: O.none,
+                        additionalProperties: O.some(false),
+                        format: O.none,
                         items: O.none,
+                        required: O.none,
+                        allOf: O.none,
+                        anyOf: O.none,
+                        oneOf: O.none,
+                        not: O.none,
+                        in: O.none,
                     },
                     additionalProperties: O.none,
                 },
@@ -59,7 +86,9 @@ describe('GenerateInputSchema', () => {
             requestBody: O.none,
             responses: O.none,
         };
-        const inputSchema = (0, GenerateInputSchema_1.generateInputSchema)(endpoint);
+        const inputSchema = E.getOrElse(() => {
+            throw new Error('Should have been right');
+        })((0, GenerateInputSchema_1.generateInputSchema)(endpoint));
         const inputTypes = (0, GenerateInputTypes_1.generateInputTypes)(endpoint.operationId, inputSchema);
         const generatedInputFile = yield TE.getOrElse((error) => {
             throw new Error('Should have been right');
@@ -69,6 +98,10 @@ describe('GenerateInputSchema', () => {
 	 * @description The user id.
 	 */
 	id: number;
+	/**
+	 * @description The date of the post.
+	 */
+	date?: string;
 }
 `;
         expect(generatedInputFile).toEqual(expectedInputFile);
@@ -143,7 +176,9 @@ describe('GenerateInputSchema', () => {
             }),
             responses: O.none,
         };
-        const inputSchema = (0, GenerateInputSchema_1.generateInputSchema)(endpoint);
+        const inputSchema = E.getOrElse(() => {
+            throw new Error('Should have been right');
+        })((0, GenerateInputSchema_1.generateInputSchema)(endpoint));
         const inputTypes = (0, GenerateInputTypes_1.generateInputTypes)(endpoint.operationId, inputSchema);
         const generatedInputFile = yield TE.getOrElse((error) => {
             throw new Error('Should have been right');
@@ -166,12 +201,12 @@ describe('GenerateInputSchema', () => {
                 {
                     name: 'tags',
                     in: 'query',
-                    required: true,
+                    required: O.some(true),
                     description: 'tags to filter by.',
                     schema: {
                         type: 'array',
                         format: O.none,
-                        items: O.some({
+                        items: {
                             type: O.some('string'),
                             properties: O.none,
                             additionalProperties: O.some(false),
@@ -181,7 +216,15 @@ describe('GenerateInputSchema', () => {
                             oneOf: O.none,
                             not: O.none,
                             in: O.none,
-                        }),
+                        },
+                        properties: O.none,
+                        additionalProperties: O.some(false),
+                        required: O.none,
+                        allOf: O.none,
+                        anyOf: O.none,
+                        oneOf: O.none,
+                        not: O.none,
+                        in: O.none,
                     },
                     additionalProperties: O.none,
                 },
@@ -189,7 +232,9 @@ describe('GenerateInputSchema', () => {
             requestBody: O.none,
             responses: O.none,
         };
-        const inputSchema = (0, GenerateInputSchema_1.generateInputSchema)(endpoint);
+        const inputSchema = E.getOrElse(() => {
+            throw new Error('Should have been right');
+        })((0, GenerateInputSchema_1.generateInputSchema)(endpoint));
         const inputTypes = (0, GenerateInputTypes_1.generateInputTypes)(endpoint.operationId, inputSchema);
         const generatedInputFile = yield TE.getOrElse((error) => {
             throw new Error('Should have been right');

package/dist/file-generators/types/GenerateInputType.test.js CHANGED Viewed

@@ -32,6 +32,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const E = __importStar(require("fp-ts/Either"));
 const TE = __importStar(require("fp-ts/TaskEither"));
 const O = __importStar(require("fp-ts/Option"));
 const GenerateInputSchema_1 = require("./GenerateInputSchema");
@@ -107,7 +108,9 @@ describe('GenerateInputType', () => {
             }),
             responses: O.none,
         };
-        const inputSchema = (0, GenerateInputSchema_1.generateInputSchema)(endpoint);
+        const inputSchema = E.getOrElse(() => {
+            throw new Error('Should have been right');
+        })((0, GenerateInputSchema_1.generateInputSchema)(endpoint));
         const expectedInputSchema = {
             type: O.some('object'),
             required: O.some(['id', 'userId', 'title', 'body']),
@@ -175,23 +178,37 @@ describe('GenerateInputType', () => {
                 {
                     name: 'id',
                     in: 'path',
-                    required: true,
+                    required: O.some(true),
                     description: 'The user id.',
                     schema: {
-                        type: 'integer',
+                        type: O.some('integer'),
                         format: O.some('int64'),
-                        items: O.none,
+                        properties: O.none,
+                        additionalProperties: O.some(false),
+                        required: O.none,
+                        allOf: O.none,
+                        anyOf: O.none,
+                        oneOf: O.none,
+                        not: O.none,
+                        in: O.none,
                     },
                 },
                 {
                     name: 'categoryId',
                     in: 'path',
-                    required: false,
+                    required: O.some(false),
                     description: 'The category id.',
                     schema: {
-                        type: 'integer',
+                        type: O.some('integer'),
                         format: O.some('int64'),
-                        items: O.none,
+                        properties: O.none,
+                        additionalProperties: O.some(false),
+                        required: O.none,
+                        allOf: O.none,
+                        anyOf: O.none,
+                        oneOf: O.none,
+                        not: O.none,
+                        in: O.none,
                     },
                 },
             ]),
@@ -248,7 +265,9 @@ describe('GenerateInputType', () => {
             }),
             responses: O.none,
         };
-        const inputSchema = (0, GenerateInputSchema_1.generateInputSchema)(endpoint);
+        const inputSchema = E.getOrElse(() => {
+            throw new Error('Should have been right');
+        })((0, GenerateInputSchema_1.generateInputSchema)(endpoint));
         const inputTypes = (0, GenerateInputTypes_1.generateInputTypes)(endpoint.operationId, inputSchema);
         const generatedInputFile = yield TE.getOrElse((error) => {
             throw new Error('Should have been right');
@@ -278,7 +297,9 @@ describe('GenerateInputType', () => {
             requestBody: O.none,
             responses: O.none,
         };
-        const inputSchema = (0, GenerateInputSchema_1.generateInputSchema)(endpoint);
+        const inputSchema = E.getOrElse(() => {
+            throw new Error('Should have been right');
+        })((0, GenerateInputSchema_1.generateInputSchema)(endpoint));
         const inputTypes = (0, GenerateInputTypes_1.generateInputTypes)(endpoint.operationId, inputSchema);
         const generatedInputFile = yield TE.getOrElse((error) => {
             throw new Error('Should have been right');
@@ -312,7 +333,9 @@ describe('GenerateInputType', () => {
             }),
             responses: O.none,
         };
-        const inputSchema = (0, GenerateInputSchema_1.generateInputSchema)(endpoint);
+        const inputSchema = E.getOrElse(() => {
+            throw new Error('Should have been right');
+        })((0, GenerateInputSchema_1.generateInputSchema)(endpoint));
         const inputTypes = (0, GenerateInputTypes_1.generateInputTypes)(endpoint.operationId, inputSchema);
         const generatedInputFile = yield TE.getOrElse((error) => {
             throw new Error('Should have been right');
@@ -393,8 +416,10 @@ describe('GenerateInputType', () => {
             }),
             responses: O.none,
         };
-        yield expect(() => __awaiter(void 0, void 0, void 0, function* () {
-            (0, GenerateInputSchema_1.generateInputSchema)(endpoint);
-        })).rejects.toThrow('Unsupported media type: unsupported-media-type');
+        const inputSchema = (0, GenerateInputSchema_1.generateInputSchema)(endpoint);
+        if (E.isRight(inputSchema)) {
+            throw new Error('Should have been left');
+        }
+        expect(inputSchema.left.message).toEqual('Unsupported media type: unsupported-media-type');
     }));
 });

package/dist/file-generators/types/GenerateOutput.d.ts.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"GenerateOutput.d.ts","sourceRoot":"","sources":["../../../src/file-generators/types/GenerateOutput.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACvC,OAAO,KAAK,CAAC,MAAM,cAAc,CAAC;AAClC,OAAO,KAAK,CAAC,MAAM,cAAc,CAAC;AAKlC,OAAO,EACN,SAAS,EAET,eAAe,EACf,YAAY,EAEZ,MAAM,8BAA8B,CAAC;AAuCtC,eAAO,MAAM,2BAA2B,YAC9B,OAAO,MAAM,EAAE,eAAe,CAAC,KACtC,EAAE,MAAM,CAAC,KAAK,EAAE,eAAe,CAWjC,CAAC;AAEF,eAAO,MAAM,oBAAoB,cACrB,EAAE,MAAM,CAAC,SAAS,CAAC,KAC5B,GAAG,UAAU,CAAC,KAAK,EAAE,YAAY,CAelC,CAAC;AAWH,eAAO,MAAM,mBAAmB,2BACP,MAAM,gBAChB,YAAY,KACxB,GAAG,UAAU,CAAC,KAAK,EAAE,MAAM,~~CAe7B~~,CAAC"}
1	+ {"version":3,"file":"GenerateOutput.d.ts","sourceRoot":"","sources":["../../../src/file-generators/types/GenerateOutput.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAC;AACvC,OAAO,KAAK,CAAC,MAAM,cAAc,CAAC;AAClC,OAAO,KAAK,CAAC,MAAM,cAAc,CAAC;AAKlC,OAAO,EACN,SAAS,EAET,eAAe,EACf,YAAY,EAEZ,MAAM,8BAA8B,CAAC;AAuCtC,eAAO,MAAM,2BAA2B,YAC9B,OAAO,MAAM,EAAE,eAAe,CAAC,KACtC,EAAE,MAAM,CAAC,KAAK,EAAE,eAAe,CAWjC,CAAC;AAEF,eAAO,MAAM,oBAAoB,cACrB,EAAE,MAAM,CAAC,SAAS,CAAC,KAC5B,GAAG,UAAU,CAAC,KAAK,EAAE,YAAY,CAelC,CAAC;AAWH,eAAO,MAAM,mBAAmB,2BACP,MAAM,gBAChB,YAAY,KACxB,GAAG,UAAU,CAAC,KAAK,EAAE,MAAM,CAY7B,CAAC"}

package/dist/file-generators/types/GenerateOutput.js CHANGED Viewed

@@ -72,9 +72,6 @@ const encodeOutputSchema = (outputSchema) => {
 };
 const generateOutputTypes = (operationNameCamelCase, outputSchema) => {
     const resolvedOutputSchema = encodeOutputSchema(outputSchema);
-    return TE.tryCatch(() => (0, json_schema_to_typescript_1.compile)(resolvedOutputSchema, `${operationNameCamelCase}Output`, JsonSchemaToTypescriptOptions_1.JsonSchemaToTypescriptOptions), (error) => {
-        console.log(JSON.stringify(resolvedOutputSchema));
-        return new Error(`Failed to generate output types: ${error}`);
-    });
+    return TE.tryCatch(() => (0, json_schema_to_typescript_1.compile)(resolvedOutputSchema, `${operationNameCamelCase}Output`, JsonSchemaToTypescriptOptions_1.JsonSchemaToTypescriptOptions), (error) => new Error(`Failed to generate output types: ${error}`));
 };
 exports.generateOutputTypes = generateOutputTypes;

package/dist/test-openapi-spec.json ADDED Viewed

@@ -0,0 +1,160 @@
+{
+	"openapi": "3.0.0",
+	"info": {
+		"version": "1.0.0",
+		"title": "JSON Placeholder API",
+		"description": "See https://jsonplaceholder.typicode.com/"
+	},
+	"servers": [
+		{
+			"url": "https://jsonplaceholder.typicode.com"
+		}
+	],
+	"paths": {
+		"/posts/{id}/{uuid}": {
+			"parameters": [
+				{
+					"name": "id",
+					"in": "path",
+					"required": true,
+					"description": "The user id.",
+					"schema": {
+						"type": "integer",
+						"format": "int64"
+					},
+					"additionalProperties": false
+				},
+				{
+					"in": "path",
+					"name": "uuid",
+					"description": "UUID.",
+					"required": true,
+					"schema": {
+						"allOf": [
+							{
+								"title": "UUID Property",
+								"description": "A string that has to be a format matching the industry standard uuid",
+								"type": "string",
+								"format": "uuid",
+								"example": "04ca6ae2-0dc3-487b-953e-86d6abbdf7d3"
+							},
+							{
+								"example": "b054dd32-efb6-444a-b4a6-a797a18315ef"
+							}
+						]
+					}
+				}
+			],
+			"put": {
+				"tags": ["post"],
+				"requestBody": {
+					"content": {
+						"application/json": {
+							"schema": {
+								"type": "object",
+								"required": ["id", "userId", "title", "body"],
+								"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"],
+				"operationId": "getPost",
+				"parameters": [
+					{
+						"name": "date",
+						"in": "query",
+						"description": "The post date.",
+						"schema": {
+							"type": "string"
+						},
+						"additionalProperties": false
+					}
+				],
+				"responses": {
+					"200": {
+						"description": "Successful response",
+						"content": {
+							"application/json": {
+								"schema": {
+									"$ref": "#/components/schemas/PostsList"
+								}
+							}
+						}
+					},
+					"404": {
+						"description": "Post not found"
+					}
+				}
+			}
+		}
+	},
+	"components": {
+		"schemas": {
+			"PostsList": {
+				"type": "array",
+				"items": {
+					"$ref": "#/components/schemas/Post"
+				}
+			},
+			"Post": {
+				"type": "object",
+				"required": ["id", "userId", "title", "body"],
+				"properties": {
+					"id": {
+						"type": "integer"
+					},
+					"userId": {
+						"type": "integer"
+					},
+					"title": {
+						"type": "string"
+					},
+					"body": {
+						"type": "string"
+					}
+				}
+			}
+		}
+	}
+}

package/package.json CHANGED Viewed

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

package/dist/single-get-openapi.json DELETED Viewed

@@ -1,78 +0,0 @@
-{
-  "openapi": "3.0.0",
-  "info": {
-    "version": "1.0.0",
-    "title": "JSON Placeholder API",
-    "description": "See https://jsonplaceholder.typicode.com/"
-  },
-  "servers": [
-    {
-      "url": "https://jsonplaceholder.typicode.com"
-    }
-  ],
-  "paths": {
-    "/posts/{id}": {
-      "get": {
-        "description": "Returns a post by id",
-        "tags": ["Posts"],
-        "operationId": "getPost",
-        "parameters": [
-          {
-            "name": "id",
-            "in": "path",
-            "required": true,
-            "description": "The user id.",
-            "schema": {
-              "type": "integer",
-              "format": "int64"
-            },
-            "additionalProperties": false
-          }
-        ],
-        "responses": {
-          "200": {
-            "description": "Successful response",
-            "content": {
-              "application/json": {
-                "schema": {
-                  "$ref": "#/components/schemas/PostsList"
-                }
-              }
-            }
-          },
-          "404": {
-            "description": "Post not found"
-          }
-        }
-      }
-    }
-  },
-  "components": {
-    "schemas": {
-      "PostsList": {
-        "type": "array",
-        "items": {
-          "$ref": "#/components/schemas/Post"
-        }
-      },
-      "Post": {
-        "type": "object",
-        "required": ["id", "userId", "title", "body"],
-        "properties": {
-          "id": {
-            "type": "integer"
-          },
-          "userId": {
-            "type": "integer"
-          },
-          "title": {
-            "type": "string"
-          },
-          "body": {
-            "type": "string"
-          }
-        }
-      }
-    }
-  }
-}