@trayio/tray-openapi 0.0.1-beta

package/dist/file-generators/GenerateOperationJson.test.d.ts.map

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

package/dist/file-generators/GenerateOperationJson.test.js

@@ -0,0 +1,78 @@
+"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 E = __importStar(require("fp-ts/Either"));
+const FakeFileStorage_1 = require("@trayio/commons/file/FakeFileStorage");
+const O = __importStar(require("fp-ts/Option"));
+const GenerateOperationJson_1 = require("./GenerateOperationJson");
+describe('generateOperationJson', () => {
+    const fileStorage = new FakeFileStorage_1.FakeFileStorage();
+    it('should generate operation.json file', () => __awaiter(void 0, void 0, void 0, function* () {
+        const writeSpy = jest.spyOn(fileStorage, 'write');
+        const operationDirPath = '/path/to/operation';
+        const operationNameSnakeCase = 'get_photo';
+        const operationNameKebabCase = 'get-photo';
+        const operationDescription = 'Get photo operation';
+        const result = yield (0, GenerateOperationJson_1.generateOperationJson)(fileStorage, operationDirPath, operationNameSnakeCase, operationNameKebabCase, operationDescription)();
+        if (E.isLeft(result)) {
+            throw new Error('expected result to be right');
+        }
+        expect(writeSpy).toHaveBeenCalledWith({
+            content: expect.anything(),
+            key: '/path/to/operation/operation.json',
+            metadata: { name: 'operation.json' },
+        }, O.none);
+        expect(result.right).toBeUndefined();
+        expect(fileStorage.files.has('/path/to/operation/operation.json')).toEqual(true);
+    }));
+    it('should generate correct data for operation.json', () => __awaiter(void 0, void 0, void 0, function* () {
+        const operationDirPath = '/path/to/operation';
+        const operationNameSnakeCase = 'get_photo';
+        const operationNameKebabCase = 'get-photo';
+        const operationDescription = 'Get photo operation';
+        const result = yield (0, GenerateOperationJson_1.generateOperationJson)(fileStorage, operationDirPath, operationNameSnakeCase, operationNameKebabCase, operationDescription)();
+        if (E.isLeft(result)) {
+            throw new Error('expected result to be right');
+        }
+        const operationJson = fileStorage.files.get('/path/to/operation/operation.json');
+        if (operationJson === undefined) {
+            throw new Error('expected operationJson to be defined');
+        }
+        expect(operationJson.content.read()).toEqual(JSON.stringify({
+            name: 'get_photo',
+            title: 'get-photo',
+            description: 'Get photo operation',
+        }));
+    }));
+});

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

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

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

@@ -0,0 +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;AA4ItC,eAAO,MAAM,mBAAmB,aACrB,IAAI,KACZ,EAAE,MAAM,CAAC,KAAK,EAAE,YAAY,CAiC9B,CAAC"}

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

@@ -0,0 +1,131 @@
+"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.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");
+const CompositeCodec_1 = require("@trayio/commons/codec/CompositeCodec");
+const RemoveNullValuesCodec_1 = require("@trayio/commons/codec/RemoveNullValuesCodec");
+const OpenApiCodecs_1 = require("../../OpenApiCodecs");
+const OpenApiTypeDescriptors_1 = require("../../OpenApiTypeDescriptors");
+const mergeRequired = (params, body) => {
+    const requiredBody = O.fold(() => [], (required) => required)(body.required);
+    const requiredParams = O.fold(() => [], (required) => required)(params.required);
+    if ((0, lodash_1.isArray)(requiredBody) && (0, lodash_1.isArray)(requiredParams)) {
+        return [...requiredBody, ...requiredParams];
+    }
+    return [];
+};
+const mergeParamsAndBody = (params, body) => ({
+    title: O.none,
+    type: O.some('object'),
+    properties: O.some(Object.assign(Object.assign({}, (O.isSome(body.properties) && body.properties.value)), (O.isSome(params.properties) && params.properties.value))),
+    required: O.some(mergeRequired(params, body)),
+    additionalProperties: O.some(false),
+    allOf: O.none,
+    anyOf: O.none,
+    oneOf: O.none,
+    not: O.none,
+    in: O.none,
+});
+const transformInput = (parameters) => {
+    const transformedParameters = {};
+    const requiredParameters = [];
+    parameters.forEach((parameter) => {
+        const codecWithNullValueRemoval = CompositeCodec_1.CompositeCodec.fromCodecs(OpenApiCodecs_1.parameterSchemaCodec, RemoveNullValuesCodec_1.RemoveNullValuesCodec.instance);
+        const parameterWithNoOptions = codecWithNullValueRemoval.encode(parameter);
+        const parameterWithJsdocAnnotation = Object.assign(Object.assign({}, parameterWithNoOptions), { description: `@description ${parameter.description}` });
+        const decodedParam = OpenApiTypeDescriptors_1.schemaObjectTypeDescriptor.decode(Object.assign(Object.assign({}, (0, openapi_schema_to_json_schema_1.fromParameter)(parameterWithJsdocAnnotation)), { in: parameter.in }));
+        if (decodedParam._tag === 'Left') {
+            throw new Error('Failed to decode params');
+        }
+        transformedParameters[parameter.name] = decodedParam.right;
+        if (O.isSome(parameter.required) && parameter.required.value === true) {
+            requiredParameters.push(parameter.name);
+        }
+    });
+    return {
+        title: O.none,
+        type: O.some('object'),
+        properties: O.some(transformedParameters),
+        required: O.some([...requiredParameters]),
+        additionalProperties: O.some(false),
+        allOf: O.none,
+        anyOf: O.none,
+        oneOf: O.none,
+        not: O.none,
+        in: O.none,
+    };
+};
+/**
+ * OpenAPI spec's body params don't have an .in property, we add one in here since query, path, and header params do
+ */
+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 = () => ({
+    title: O.none,
+    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));
+    if (mediaTypeApplicationJson) {
+        return E.right(content[mediaTypeApplicationJson]);
+    }
+    const mediaTypes = Object.keys(content);
+    return E.left(new Error(`Unsupported media type: ${mediaTypes}`));
+};
+const generateInputSchema = (endpoint) => {
+    const parameters = O.toNullable(endpoint.parameters);
+    const requestBody = O.toNullable(endpoint.requestBody);
+    if (parameters && !requestBody) {
+        return E.right(transformInput(parameters));
+    }
+    if (requestBody && !parameters) {
+        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);
+        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 E.right(blankOutputSchema());
+};
+exports.generateInputSchema = generateInputSchema;

package/dist/file-generators/types/GenerateInputSchema.test.d.ts

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

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

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

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

@@ -0,0 +1,260 @@
+"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 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");
+const GenerateInputTypes_1 = require("./GenerateInputTypes");
+describe('GenerateInputSchema', () => {
+    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: O.some([]),
+            parameters: O.some([
+                {
+                    name: 'id',
+                    in: 'path',
+                    required: O.some(true),
+                    description: 'The user id.',
+                    schema: {
+                        type: O.some('integer'),
+                        title: 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,
+                },
+                {
+                    name: 'date',
+                    in: 'query',
+                    required: O.none,
+                    description: 'The date of the post.',
+                    schema: {
+                        type: O.some('string'),
+                        title: O.none,
+                        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,
+                },
+            ]),
+            requestBody: O.none,
+            responses: O.none,
+        };
+        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');
+        })(inputTypes)();
+        const expectedInputFile = `export interface GetPostInput {
+	/**
+	 * @description The user id.
+	 */
+	id: number;
+	/**
+	 * @description The date of the post.
+	 */
+	date?: string;
+}
+`;
+        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: O.some([]),
+            parameters: O.none,
+            requestBody: O.some({
+                content: {
+                    'application/json': {
+                        schema: O.some({
+                            type: O.some('object'),
+                            title: O.some('Post'),
+                            required: O.some(['id', 'userId', 'title', 'body']),
+                            properties: O.some({
+                                id: {
+                                    type: O.some('integer'),
+                                    title: 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,
+                                },
+                                userId: {
+                                    type: O.some('integer'),
+                                    title: 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,
+                                },
+                                title: {
+                                    type: O.some('string'),
+                                    title: 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,
+                                },
+                                body: {
+                                    type: O.some('string'),
+                                    title: 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.some(false),
+                            allOf: O.none,
+                            anyOf: O.none,
+                            oneOf: O.none,
+                            not: O.none,
+                            in: O.none,
+                        }),
+                    },
+                },
+            }),
+            responses: O.none,
+        };
+        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');
+        })(inputTypes)();
+        const expectedInputFile = `export interface CreatePostInput {
+	id: number;
+	userId: number;
+	title: string;
+	body: string;
+}
+`;
+        expect(generatedInputFile).toEqual(expectedInputFile);
+    }));
+    it('it should process an endpoint with query string parameter array and generate input.ts file contents', () => __awaiter(void 0, void 0, void 0, function* () {
+        const endpoint = {
+            operationId: 'getPost',
+            description: '',
+            tags: O.some([]),
+            parameters: O.some([
+                {
+                    name: 'tags',
+                    in: 'query',
+                    required: O.some(true),
+                    description: 'tags to filter by.',
+                    schema: {
+                        title: O.none,
+                        type: 'array',
+                        format: O.none,
+                        items: {
+                            type: O.some('string'),
+                            title: 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,
+                        },
+                        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,
+                },
+            ]),
+            requestBody: O.none,
+            responses: O.none,
+        };
+        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');
+        })(inputTypes)();
+        const expectedInputFile = `export interface GetPostInput {
+	/**
+	 * @description tags to filter by.
+	 */
+	tags: string[];
+}
+`;
+        expect(generatedInputFile).toEqual(expectedInputFile);
+    }));
+});

package/dist/file-generators/types/GenerateInputType.test.d.ts

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

package/dist/file-generators/types/GenerateInputType.test.d.ts.map

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