@trayio/tray-openapi 2.3.0 → 2.5.0

package/dist/connector/input/GenerateInput.test.js

@@ -0,0 +1,133 @@
+"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;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const TE = __importStar(require("fp-ts/TaskEither"));
+const GenerateInput_1 = require("./GenerateInput");
+describe('Input: GenerateInput', () => {
+    it('it should generate input.ts file contents when given JSON schema path and query params', () => __awaiter(void 0, void 0, void 0, function* () {
+        const operationNameCamelCase = 'getPost';
+        const parameters = {
+            type: 'object',
+            properties: {
+                id: {
+                    type: 'integer',
+                },
+                filter: {
+                    type: 'string',
+                },
+            },
+            required: ['id'],
+            additionalProperties: false,
+        };
+        const generatedInput = (0, GenerateInput_1.generateInput)({
+            operationNameCamelCase,
+            parameters,
+        });
+        const generatedInputFile = yield TE.getOrElse((error) => {
+            throw new Error('Should have been right');
+        })(generatedInput)();
+        const expected = `export interface GetPostInput {
+	id: number;
+	filter?: string;
+}
+`;
+        expect(generatedInputFile).toEqual(expected);
+    }));
+    it('it should generate input.ts file contents when given JSON schema optional path and query params', () => __awaiter(void 0, void 0, void 0, function* () {
+        const operationNameCamelCase = 'getPost';
+        const parameters = {
+            type: 'object',
+            properties: {
+                id: {
+                    type: 'integer',
+                },
+                filter: {
+                    type: 'string',
+                },
+            },
+            required: [],
+            additionalProperties: false,
+        };
+        const generatedInput = (0, GenerateInput_1.generateInput)({
+            operationNameCamelCase,
+            parameters,
+        });
+        const generatedInputFile = yield TE.getOrElse((error) => {
+            throw new Error('Should have been right');
+        })(generatedInput)();
+        const expected = `export interface GetPostInput {
+	id?: number;
+	filter?: string;
+}
+`;
+        expect(generatedInputFile).toEqual(expected);
+    }));
+    it('it should generate input.ts file contents when given JSON schema body params', () => __awaiter(void 0, void 0, void 0, function* () {
+        const operationNameCamelCase = 'createPost';
+        const parameters = {
+            type: 'object',
+            required: ['id', 'userId', 'title', 'body'],
+            properties: {
+                id: {
+                    type: 'integer',
+                },
+                userId: {
+                    type: 'integer',
+                },
+                title: {
+                    type: 'string',
+                },
+                body: {
+                    type: 'string',
+                },
+            },
+            additionalProperties: false,
+        };
+        const generatedInput = (0, GenerateInput_1.generateInput)({
+            operationNameCamelCase,
+            parameters,
+        });
+        const generatedInputFile = yield TE.getOrElse((error) => {
+            throw new Error('Should have been right');
+        })(generatedInput)();
+        const expected = `export interface CreatePostInput {
+	id: number;
+	userId: number;
+	title: string;
+	body: string;
+}
+`;
+        expect(generatedInputFile).toEqual(expected);
+    }));
+});

package/dist/connector/input/ProcessInput.d.ts

@@ -0,0 +1,4 @@
+import * as TE from 'fp-ts/TaskEither';
+import { Path } from '../../OpenApiTypeDescriptors';
+export declare const processInput: (endpoint: Path) => TE.TaskEither<Error, string>;
+//# sourceMappingURL=ProcessInput.d.ts.map

package/dist/connector/input/ProcessInput.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProcessInput.d.ts","sourceRoot":"","sources":["../../../src/connector/input/ProcessInput.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAIvC,OAAO,EAAE,IAAI,EAAE,MAAM,8BAA8B,CAAC;AA2DpD,eAAO,MAAM,YAAY,aAAc,IAAI,KAAG,GAAG,UAAU,CAAC,KAAK,EAAE,MAAM,CAMxE,CAAC"}

package/dist/connector/input/ProcessInput.js

@@ -0,0 +1,81 @@
+"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.processInput = void 0;
+const lodash_1 = require("lodash");
+const O = __importStar(require("fp-ts/Option"));
+const GenerateInput_1 = require("./GenerateInput");
+const TransformInput_1 = require("./TransformInput");
+const mergeRequired = (params, body) => {
+    if ((0, lodash_1.isArray)(body.required) && (0, lodash_1.isArray)(params.required)) {
+        return [...body.required, ...params.required];
+    }
+    return [];
+};
+const mergeParamsAndBody = (params, body) => ({
+    type: 'object',
+    properties: Object.assign(Object.assign({}, body.properties), params.properties),
+    required: mergeRequired(params, body),
+    additionalProperties: false,
+});
+const getApplicationJsonMediaType = (content) => {
+    // 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));
+    if (mediaTypeApplicationJson) {
+        return content[mediaTypeApplicationJson];
+    }
+    const mediaTypes = Object.keys(content);
+    throw new Error(`Unsupported media type: ${mediaTypes}`);
+};
+const extractInput = (endpoint) => {
+    const parameters = O.toNullable(endpoint.parameters);
+    const requestBody = O.toNullable(endpoint.requestBody);
+    if (parameters && !requestBody) {
+        return (0, TransformInput_1.transformInput)(parameters);
+    }
+    if (requestBody && !parameters) {
+        return getApplicationJsonMediaType(requestBody.content).schema;
+    }
+    if (requestBody && parameters) {
+        const params = (0, TransformInput_1.transformInput)(parameters);
+        const body = getApplicationJsonMediaType(requestBody.content).schema;
+        return mergeParamsAndBody(params, body);
+    }
+    return {
+        type: 'object',
+        properties: {},
+        required: [],
+        additionalProperties: false,
+    };
+};
+const processInput = (endpoint) => {
+    const input = extractInput(endpoint);
+    return (0, GenerateInput_1.generateInput)({
+        operationNameCamelCase: endpoint.operationId,
+        parameters: input,
+    });
+};
+exports.processInput = processInput;

package/dist/connector/input/ProcessInput.test.d.ts

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

package/dist/connector/input/ProcessInput.test.d.ts.map

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

package/dist/connector/input/ProcessInput.test.js

@@ -0,0 +1,227 @@
+"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;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const TE = __importStar(require("fp-ts/TaskEither"));
+const O = __importStar(require("fp-ts/Option"));
+const ProcessInput_1 = require("./ProcessInput");
+describe('Input: ProcessInput', () => {
+    it('it should process an endpoint with path and query string parameters and generate input.ts file contents', () => __awaiter(void 0, void 0, void 0, function* () {
+        const endpoint = {
+            operationId: 'getPost',
+            description: '',
+            tags: [],
+            parameters: O.some([
+                {
+                    name: 'id',
+                    in: 'path',
+                    required: true,
+                    description: 'The user id.',
+                    schema: {
+                        type: 'integer',
+                        format: O.some('int64'),
+                    },
+                },
+            ]),
+            requestBody: O.none,
+        };
+        const processedInput = (0, ProcessInput_1.processInput)(endpoint);
+        const generatedInputFile = yield TE.getOrElse((error) => {
+            throw new Error('Should have been right');
+        })(processedInput)();
+        const expectedInputFile = `export interface GetPostInput {
+	/**
+	 * @description The user id.
+	 */
+	id: number;
+}
+`;
+        expect(generatedInputFile).toEqual(expectedInputFile);
+    }));
+    it('it should process an endpoint with body parameters and generate input.ts file contents', () => __awaiter(void 0, void 0, void 0, function* () {
+        const endpoint = {
+            operationId: 'createPost',
+            description: 'Create a new post',
+            tags: [],
+            parameters: O.none,
+            requestBody: O.some({
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'object',
+                            required: ['id', 'userId', 'title', 'body'],
+                            properties: {
+                                id: {
+                                    type: 'integer',
+                                },
+                                userId: {
+                                    type: 'integer',
+                                },
+                                title: {
+                                    type: 'string',
+                                },
+                                body: {
+                                    type: 'string',
+                                },
+                            },
+                            additionalProperties: false,
+                        },
+                    },
+                },
+                required: true,
+            }),
+        };
+        const processedInput = (0, ProcessInput_1.processInput)(endpoint);
+        const generatedInputFile = yield TE.getOrElse((error) => {
+            throw new Error('Should have been right');
+        })(processedInput)();
+        const expectedInputFile = `export interface CreatePostInput {
+	id: number;
+	userId: number;
+	title: string;
+	body: string;
+}
+`;
+        expect(generatedInputFile).toEqual(expectedInputFile);
+    }));
+    it('it should process an endpoint with path, query string and body parameters and generate input.ts file contents', () => __awaiter(void 0, void 0, void 0, function* () {
+        const endpoint = {
+            operationId: 'getPost',
+            description: '',
+            tags: [],
+            parameters: O.some([
+                {
+                    name: 'id',
+                    in: 'path',
+                    required: true,
+                    description: 'The user id.',
+                    schema: {
+                        type: 'integer',
+                        format: O.some('int64'),
+                    },
+                },
+            ]),
+            requestBody: O.some({
+                content: {
+                    'application/json': {
+                        schema: {
+                            type: 'object',
+                            required: ['id', 'userId', 'title', 'body'],
+                            properties: {
+                                userId: {
+                                    type: 'integer',
+                                },
+                                title: {
+                                    type: 'string',
+                                },
+                                body: {
+                                    type: 'string',
+                                },
+                            },
+                            additionalProperties: false,
+                        },
+                    },
+                },
+                required: true,
+            }),
+        };
+        const processedInput = (0, ProcessInput_1.processInput)(endpoint);
+        const generatedInputFile = yield TE.getOrElse((error) => {
+            throw new Error('Should have been right');
+        })(processedInput)();
+        const expectedInputFile = `export interface GetPostInput {
+	userId: number;
+	title: string;
+	body: string;
+	/**
+	 * @description The user id.
+	 */
+	id: number;
+}
+`;
+        expect(generatedInputFile).toEqual(expectedInputFile);
+    }));
+    it('it should process an endpoint with no parameters and generate empty input.ts file contents', () => __awaiter(void 0, void 0, void 0, function* () {
+        const endpoint = {
+            operationId: 'getPosts',
+            description: '',
+            tags: [],
+            parameters: O.none,
+            requestBody: O.none,
+        };
+        const processedInput = (0, ProcessInput_1.processInput)(endpoint);
+        const generatedInputFile = yield TE.getOrElse((error) => {
+            throw new Error('Should have been right');
+        })(processedInput)();
+        const expectedInputFile = `export interface GetPostsInput {}
+`;
+        expect(generatedInputFile).toEqual(expectedInputFile);
+    }));
+    it('it should throw an exception when finding an unsupported media type', () => __awaiter(void 0, void 0, void 0, function* () {
+        const endpoint = {
+            operationId: 'createPost',
+            description: '',
+            tags: [],
+            parameters: O.none,
+            requestBody: O.some({
+                content: {
+                    'unsupported-media-type': {
+                        schema: {
+                            type: 'object',
+                            required: ['id', 'userId', 'title', 'body'],
+                            properties: {
+                                id: {
+                                    type: 'integer',
+                                },
+                                userId: {
+                                    type: 'integer',
+                                },
+                                title: {
+                                    type: 'string',
+                                },
+                                body: {
+                                    type: 'string',
+                                },
+                            },
+                            additionalProperties: false,
+                        },
+                    },
+                },
+                required: true,
+            }),
+        };
+        yield expect(() => __awaiter(void 0, void 0, void 0, function* () {
+            (0, ProcessInput_1.processInput)(endpoint);
+        })).rejects.toThrow('Unsupported media type: unsupported-media-type');
+    }));
+});

package/dist/connector/input/TransformInput.d.ts

@@ -0,0 +1,4 @@
+import { JSONSchema4 } from 'json-schema';
+import { Parameter } from '../../OpenApiTypeDescriptors';
+export declare const transformInput: (parameters: Parameter[]) => JSONSchema4;
+//# sourceMappingURL=TransformInput.d.ts.map

package/dist/connector/input/TransformInput.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TransformInput.d.ts","sourceRoot":"","sources":["../../../src/connector/input/TransformInput.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAG1C,OAAO,EAAE,SAAS,EAAE,MAAM,8BAA8B,CAAC;AAEzD,eAAO,MAAM,cAAc,eAAgB,SAAS,EAAE,KAAG,WA4BxD,CAAC"}

package/dist/connector/input/TransformInput.js

@@ -0,0 +1,54 @@
+"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.transformInput = void 0;
+const openapi_schema_to_json_schema_1 = require("@openapi-contrib/openapi-schema-to-json-schema");
+const O = __importStar(require("fp-ts/Option"));
+const transformInput = (parameters) => {
+    const transformedParameters = {};
+    const requiredParameters = [];
+    parameters.forEach((parameter) => {
+        const paramterWithJsdocAnnotation = {
+            name: parameter.name,
+            description: `@description ${parameter.description}`,
+            required: parameter.required,
+            schema: {
+                type: parameter.schema.type,
+                format: O.toNullable(parameter.schema.format) || undefined,
+            },
+        };
+        transformedParameters[parameter.name] = (0, openapi_schema_to_json_schema_1.fromParameter)(paramterWithJsdocAnnotation);
+        if (parameter.required === true) {
+            requiredParameters.push(parameter.name);
+        }
+    });
+    return {
+        type: 'object',
+        properties: Object.assign({}, transformedParameters),
+        required: [...requiredParameters],
+        additionalProperties: false,
+    };
+};
+exports.transformInput = transformInput;

package/dist/connector/input/TransformInput.test.d.ts

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

package/dist/connector/input/TransformInput.test.d.ts.map

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

package/dist/connector/input/TransformInput.test.js

@@ -0,0 +1,75 @@
+"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 O = __importStar(require("fp-ts/Option"));
+const TransformInput_1 = require("./TransformInput");
+describe('Input: TransformInput', () => {
+    it('it should transform open api spec path and query parameters into JSON schema', () => {
+        const openApiSpecParameters = [
+            {
+                name: 'id',
+                in: 'path',
+                required: true,
+                description: 'The user id.',
+                schema: {
+                    type: 'integer',
+                    format: O.some('int64'),
+                },
+            },
+            {
+                name: 'filter',
+                in: 'query',
+                required: false,
+                description: 'The type to filter on.',
+                schema: {
+                    type: 'string',
+                    format: O.none,
+                },
+            },
+        ];
+        const generatedJsonSchema = (0, TransformInput_1.transformInput)(openApiSpecParameters);
+        const expectedJsonSchema = {
+            type: 'object',
+            properties: {
+                id: {
+                    type: 'integer',
+                    $schema: 'http://json-schema.org/draft-04/schema#',
+                    description: '@description The user id.',
+                    format: 'int64',
+                    maximum: 9223372036854776000,
+                    minimum: -9223372036854776000,
+                },
+                filter: {
+                    type: 'string',
+                    $schema: 'http://json-schema.org/draft-04/schema#',
+                    description: '@description The type to filter on.',
+                },
+            },
+            required: ['id'],
+            additionalProperties: false,
+        };
+        expect(generatedJsonSchema).toEqual(expectedJsonSchema);
+    });
+});