update

Author: omermecitoglu

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@omer-x/ts-openapi-interface-generator",
-  "version": "0.2.0",
+  "version": "1.0.0",
   "description": "OpenAPI interface generator for TypeScript",
   "keywords": [
     "typescript",

package.json

@@ -2,7 +2,7 @@ import yargs from "yargs";
 
 const argv = yargs.option("output", {
   alias: "o",
-  describe: "Specify the output directry",
+  describe: "Specify the output directory",
   type: "string",
   demandOption: false,
 }).argv;

src/core/arguments.ts

@@ -0,0 +1,9 @@
+import fs from "node:fs/promises";
+import path from "node:path";
+
+export default async function createFile(content: string, fileName: string, outputDir: string, targetFolder = ".") {
+  const targetPath = path.resolve(outputDir, targetFolder);
+  await fs.mkdir(targetPath, { recursive: true });
+  const filePath = path.resolve(targetPath, fileName);
+  await fs.writeFile(filePath, content);
+}

src/core/file.ts

@@ -1,9 +1,3 @@
-type SchemaComponent = {
-  type: "object" | "unknown",
-  properties: Record<string, SchemaDefinition>,
-  required?: string[],
-};
-
 export type SchemaDefinition = {
   type?: "string" | "number" | "array" | "object",
   format?: "date" | "unknown",
@@ -15,18 +9,24 @@ export type SchemaDefinition = {
   enum?: (string | null)[],
 };
 
-export type PathParameter = {
+type SchemaComponent = {
+  type: "object" | "unknown",
+  properties: Record<string, SchemaDefinition>,
+  required?: string[],
+};
+
+export type OperationParameter = {
   in: "path" | "query" | "header" | "cookie",
   name: string,
   description: string,
   required: boolean,
   schema: SchemaDefinition,
 };
 
-export type RequestBody = {
+type RequestBody = {
   description: string,
   required: boolean,
-  content: Record<ContentType, ResponseContent>,
+  content: Content,
 };
 
 type ResponseContent = {
@@ -35,33 +35,29 @@ type ResponseContent = {
 
 type ContentType = "application/json" | "text/plain";
 
-export type HttpResponse = {
+export type Content = Record<ContentType, ResponseContent>;
+
+type HttpResponse = {
   description: string,
-  content?: Record<ContentType, ResponseContent>,
+  content?: Content,
 };
 
 type HttpCode = "200" | "404";
 
-export type ApiPath = {
-  summary: string,
+export type Operation = {
   operationId: string,
-  parameters?: PathParameter[],
+  summary: string,
+  description: string,
+  parameters?: OperationParameter[],
   requestBody?: RequestBody,
   responses: Record<HttpCode, HttpResponse>,
 };
 
-export type HttpMethod = "get" | "post" | "patch" | "put" | "delete";
+type HttpMethod = "get" | "post" | "patch" | "put" | "delete";
 
-type OpenApiSpecification = {
+export type OpenAPI = {
   components: {
     schemas: Record<string, SchemaComponent>,
   },
-  paths: Record<string, Record<HttpMethod, ApiPath>>,
+  paths: Record<string, Record<HttpMethod, Operation>>,
 };
-
-export async function getSwaggerJSON(base: string, specs?: string) {
-  const url = new URL(specs ?? "/swagger", base);
-  const response = await fetch(url);
-  const data = await response.json();
-  return data as OpenApiSpecification;
-}

src/core/interface.ts

@@ -0,0 +1,18 @@
+import Handlebars from "handlebars";
+import type { OperationTemplate } from "~/core/resolvers/operation";
+import interfaceTemplate from "~/templates/interface.hbs";
+
+type InterfaceTemplate = {
+  baseUrl: string,
+  schemas: string[],
+  operations: OperationTemplate[],
+};
+
+export default function generateInterface(baseUrl: string, schemas: string[], operations: OperationTemplate[]) {
+  const template = Handlebars.compile<InterfaceTemplate>(interfaceTemplate);
+  return template({
+    baseUrl,
+    schemas,
+    operations,
+  });
+}

src/core/openapi.ts

@@ -0,0 +1,8 @@
+import Handlebars from "handlebars";
+import operationTemplate from "~/templates/operation.hbs";
+
+Handlebars.registerHelper("hasRequestBody", (input: string[]) => {
+  return input.includes("requestBody");
+});
+
+Handlebars.registerPartial("operation", operationTemplate);