@trayio/tray-openapi 0.0.1-beta

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

@@ -0,0 +1,213 @@
+"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 E = __importStar(require("fp-ts/Either"));
+const O = __importStar(require("fp-ts/Option"));
+const GenerateOutput_1 = require("./GenerateOutput");
+const generateOutputFileContents = (responses) => __awaiter(void 0, void 0, void 0, function* () {
+    const operationNameCamelCase = 'CreatePost';
+    const generatedOutputSchema = yield (0, GenerateOutput_1.generateOutputSchema)(responses)();
+    if (E.isLeft(generatedOutputSchema)) {
+        throw new Error('Should have been right');
+    }
+    const generatedOutputTypes = (0, GenerateOutput_1.generateOutputTypes)(operationNameCamelCase, generatedOutputSchema.right);
+    return TE.getOrElse((error) => {
+        throw new Error('Should have been right');
+    })(generatedOutputTypes)();
+});
+describe('Generate output: ', () => {
+    it('it should generate output.ts file contents for a response code 200 content json', () => __awaiter(void 0, void 0, void 0, function* () {
+        const responses = O.some({
+            '200': {
+                description: 'A post was created',
+                content: O.some({
+                    'application/json': {
+                        schema: O.some({
+                            title: O.some('Post'),
+                            type: O.some('object'),
+                            required: O.some(['id', 'userId', 'title', 'body']),
+                            properties: O.some({
+                                id: {
+                                    title: O.none,
+                                    type: O.some('integer'),
+                                    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,
+                                },
+                                userId: {
+                                    title: O.none,
+                                    type: O.some('integer'),
+                                    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,
+                                },
+                                title: {
+                                    title: O.none,
+                                    type: O.some('string'),
+                                    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,
+                                },
+                                body: {
+                                    title: O.none,
+                                    type: O.some('string'),
+                                    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,
+                                },
+                            }),
+                            additionalProperties: O.some(false),
+                            allOf: O.none,
+                            anyOf: O.none,
+                            oneOf: O.none,
+                            not: O.none,
+                            in: O.none,
+                        }),
+                    },
+                }),
+            },
+        });
+        const generatedOutputFileContents = yield generateOutputFileContents(responses);
+        const expectedOutputFileContents = `export interface CreatePostOutput {
+	id: number;
+	userId: number;
+	title: string;
+	body: string;
+}
+`;
+        expect(generatedOutputFileContents).toEqual(expectedOutputFileContents);
+    }));
+    it('it should generate output.ts file contents for a response code 201 content json', () => __awaiter(void 0, void 0, void 0, function* () {
+        const responses = O.some({
+            '201': {
+                description: 'A post was created',
+                content: O.some({
+                    'application/json': {
+                        schema: O.some({
+                            title: O.none,
+                            type: O.some('object'),
+                            required: O.some(['id', 'userId', 'title', 'body']),
+                            properties: O.some({
+                                id: {
+                                    title: O.none,
+                                    type: O.some('integer'),
+                                    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,
+                                },
+                                userId: {
+                                    title: O.none,
+                                    type: O.some('integer'),
+                                    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,
+                                },
+                                title: {
+                                    title: O.none,
+                                    type: O.some('string'),
+                                    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,
+                                },
+                                body: {
+                                    title: O.none,
+                                    type: O.some('string'),
+                                    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,
+                                },
+                            }),
+                            additionalProperties: O.some(false),
+                            allOf: O.none,
+                            anyOf: O.none,
+                            oneOf: O.none,
+                            not: O.none,
+                            in: O.none,
+                        }),
+                    },
+                }),
+            },
+        });
+        const generatedOutputFileContents = yield generateOutputFileContents(responses);
+        const expectedOutputFileContents = `export interface CreatePostOutput {
+	id: number;
+	userId: number;
+	title: string;
+	body: string;
+}
+`;
+        expect(generatedOutputFileContents).toEqual(expectedOutputFileContents);
+    }));
+});

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

@@ -0,0 +1,9 @@
+export declare const JsonSchemaToTypescriptOptions: {
+    bannerComment: string;
+    format: boolean;
+    style: {
+        singleQuote: boolean;
+        useTabs: boolean;
+    };
+};
+//# sourceMappingURL=JsonSchemaToTypescriptOptions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"JsonSchemaToTypescriptOptions.d.ts","sourceRoot":"","sources":["../../../src/file-generators/types/JsonSchemaToTypescriptOptions.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,6BAA6B;;;;;;;CAOzC,CAAC"}

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

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.JsonSchemaToTypescriptOptions = void 0;
+exports.JsonSchemaToTypescriptOptions = {
+    bannerComment: '',
+    format: true,
+    style: {
+        singleQuote: true,
+        useTabs: true,
+    },
+};

package/dist/test-openapi-spec.json

@@ -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

@@ -0,0 +1,30 @@
+{
+  "name": "@trayio/tray-openapi",
+  "version": "0.0.1-beta",
+  "description": "Creating CDK Projects from OpenAPI 3.0 Schemas",
+  "exports": {
+    "./*": "./dist/*.js"
+  },
+  "author": "Tray.io",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "*",
+        "dist/*"
+      ]
+    }
+  },
+  "files": [
+    "/dist"
+  ],
+  "dependencies": {
+    "@openapi-contrib/openapi-schema-to-json-schema": "5.1.0",
+    "@stoplight/json-ref-resolver": "3.1.6",
+    "json-schema-to-typescript": "13.1.1",
+    "json-to-typescript": "1.0.1"
+  }
+}