Merge pull request #12 from moznion/export_schema_types

Export schema types from the generated client

Author: moznion

src/index.ts

@@ -28,8 +28,13 @@ export function generateClient(schemaFilePath: string): string {
   if (!pathsInterface) {
     throw new Error(`Interface "paths" not found in ${schemaFilePath}`);
   }
+  const componentsInterface = findInterface(schemaFile, "components");
 
-  return generateClientCode(pathsInterface, path.basename(schemaFilePath));
+  return generateClientCode(
+    pathsInterface,
+    componentsInterface,
+    path.basename(schemaFilePath),
+  );
 }
 
 function findInterface(
@@ -51,6 +56,7 @@ interface EndpointInfo {
 
 function generateClientCode(
   pathsInterface: InterfaceDeclaration,
+  componentsInterface: InterfaceDeclaration | undefined,
   schemaFileName: string,
 ): string {
   const endpoints = extractEndpointsInfo(pathsInterface);
@@ -65,6 +71,8 @@ function generateClientCode(
     `import type { paths } from "./${schemaFileName}"; // generated by openapi-typescript`,
     "",
     clientClass,
+    "",
+    ...generateSchemaTypes(componentsInterface),
   ].join("\n");
 
   const tempFile = tmp.fileSync({ postfix: ".ts" }).name;
@@ -73,6 +81,27 @@ function generateClientCode(
   return fs.readFileSync(tempFile, "utf-8");
 }
 
+function generateSchemaTypes(
+  componentsInterface: InterfaceDeclaration | undefined,
+): string[] {
+  const schemasProperty = componentsInterface?.getProperty("schemas");
+
+  const types = [];
+  if (schemasProperty) {
+    const schemasType = schemasProperty.getType();
+    for (const schema of schemasType.getProperties()) {
+      const schemaType = schema.getValueDeclaration()?.getType();
+      if (schemaType) {
+        const schemaName =
+          schema.getName() === "Client" ? "ClientSchema" : schema.getName();
+        types.push(`export type ${schemaName} = ${schemaType.getText()};`);
+      }
+    }
+  }
+
+  return types;
+}
+
 function extractEndpointsInfo(
   pathsInterface: InterfaceDeclaration,
 ): EndpointInfo[] {

src/test_resources/expected_client.ts

@@ -236,3 +236,102 @@ export class Client<HT extends Record<string, string>> {
     });
   }
 }
+
+export type Error = { code: number; message: string };
+export type User = {
+  id: string;
+  name: string;
+  email: string;
+  membershipType: "REGULAR" | "PREMIUM" | "STUDENT";
+  registeredAt: string;
+  address?: {
+    postalCode?: string;
+    street: string;
+    city: string;
+    country: string;
+  };
+};
+export type Address = {
+  postalCode?: string;
+  street: string;
+  city: string;
+  country: string;
+};
+export type UserCreate = {
+  name: string;
+  email: string;
+  membershipType: "REGULAR" | "PREMIUM" | "STUDENT";
+  address?: {
+    postalCode?: string;
+    street: string;
+    city: string;
+    country: string;
+  };
+};
+export type UserUpdate = {
+  name: string;
+  email: string;
+  membershipType: "REGULAR" | "PREMIUM" | "STUDENT";
+  address?: {
+    postalCode?: string;
+    street: string;
+    city: string;
+    country: string;
+  };
+} & { id: string };
+export type UserPatch = {
+  name?: string;
+  email?: string;
+  membershipType?: "REGULAR" | "PREMIUM" | "STUDENT";
+  address?: {
+    postalCode?: string;
+    street: string;
+    city: string;
+    country: string;
+  };
+};
+export type UserList = {
+  id: string;
+  name: string;
+  email: string;
+  membershipType: "REGULAR" | "PREMIUM" | "STUDENT";
+  registeredAt: string;
+  address?: {
+    postalCode?: string;
+    street: string;
+    city: string;
+    country: string;
+  };
+}[];
+export type UserPage = {
+  total: number;
+  page: number;
+  pageSize: number;
+  items: {
+    id: string;
+    name: string;
+    email: string;
+    membershipType: "REGULAR" | "PREMIUM" | "STUDENT";
+    registeredAt: string;
+    address?: {
+      postalCode?: string;
+      street: string;
+      city: string;
+      country: string;
+    };
+  }[];
+};
+export type Loan = {
+  loanId: string;
+  book: { isbn: string; title: string; author: string };
+  borrowedAt: string;
+  dueAt: string;
+};
+export type Book = { isbn: string; title: string; author: string };
+export type BulkJobStatus = {
+  jobId: string;
+  status: "PENDING" | "PROCESSING" | "COMPLETED" | "FAILED";
+  processed: number;
+  total: number;
+};
+export type ClientSchema = { id?: string };

src/test_resources/schema.d.ts

@@ -528,6 +528,9 @@ export interface components {
       processed: number;
       total: number;
     };
+    Client: {
+      id?: string;
+    };
   };
   responses: {
     /** @description Bad request due to invalid input */

src/test_resources/schema.yaml

@@ -522,3 +522,11 @@ components:
         - status
         - processed
         - total
+
+    # this is dummy schema to check name confliction
+    Client:
+      type: object
+      properties:
+        id:
+          type: string
+