helper functions

fern-api · Jan 15, 2025 · 9f24889 · 9f24889
1 parent aeedc6f
commit 9f24889
Show file tree

Hide file tree

Showing 2 changed files with 139 additions and 113 deletions.
diff --git a/packages/parsers/src/openapi/3.1/paths/response/ResponseMediaTypeObjectConverter.node.ts b/packages/parsers/src/openapi/3.1/paths/response/ResponseMediaTypeObjectConverter.node.ts
@@ -16,6 +16,7 @@ import { resolveSchemaReference } from "../../../utils/3.1/resolveSchemaReferenc
 import { maybeSingleValueToArray } from "../../../utils/maybeSingleValueToArray";
 import { MediaType } from "../../../utils/MediaType";
 import { singleUndefinedArrayIfNullOrEmpty } from "../../../utils/singleUndefinedArrayIfNullOrEmpty";
+import { singleUndefinedRecordIfNullOrEmpty } from "../../../utils/singleUndefinedRecordIfNullOrEmpty";
 import { SchemaConverterNode } from "../../schemas/SchemaConverter.node";
 import { ExampleObjectConverterNode } from "../ExampleObjectConverter.node";
 import { RequestMediaTypeObjectConverterNode } from "../request/RequestMediaTypeObjectConverter.node";
@@ -27,6 +28,17 @@ export type ResponseStreamingFormat = ConstArrayToType<
   typeof SUPPORTED_STREAMING_FORMATS
 >;
 
+function matchExampleName(
+  exampleName: string,
+  requestExampleName: string
+): boolean {
+  return (
+    exampleName === requestExampleName ||
+    requestExampleName === "" ||
+    exampleName === ""
+  );
+}
+
 export class ResponseMediaTypeObjectConverterNode extends BaseOpenApiV3_1ConverterNode<
   OpenAPIV3_1.MediaTypeObject,
   | FernRegistry.api.latest.HttpResponseBodyShape
@@ -51,6 +63,123 @@ export class ResponseMediaTypeObjectConverterNode extends BaseOpenApiV3_1Convert
     this.safeParse(contentType);
   }
 
+  private isExampleDefined(
+    example: OpenAPIV3_1.ExampleObject | OpenAPIV3_1.ReferenceObject | undefined
+  ): boolean {
+    return (
+      example != null &&
+      resolveExampleReference(example, this.context.document)?.value != null
+    );
+  }
+
+  private generateSupportedExamples(
+    exampleName: string,
+    exampleObject: OpenAPIV3_1.ExampleObject | OpenAPIV3_1.ReferenceObject,
+    i: number
+  ): ExampleObjectConverterNode[] {
+    return singleUndefinedArrayIfNullOrEmpty(this.requests).flatMap((request) =>
+      Object.entries(singleUndefinedRecordIfNullOrEmpty(request?.examples))
+        .map(([requestExampleName, requestExample]) =>
+          matchExampleName(exampleName, requestExampleName) &&
+          (this.isExampleDefined(requestExample) ||
+            this.isExampleDefined(exampleObject))
+            ? new ExampleObjectConverterNode(
+                {
+                  input: {
+                    requestExample,
+                    responseExample: exampleObject,
+                  },
+                  context: this.context,
+                  accessPath: this.accessPath,
+                  pathId: `examples[${i}]`,
+                },
+                this.path,
+                this.statusCode,
+                exampleName === "" ? undefined : exampleName,
+                {
+                  requestBody: request,
+                  responseBody: this,
+                  pathParameters: this.shapes.pathParameters,
+                  queryParameters: this.shapes.queryParameters,
+                  requestHeaders: this.shapes.requestHeaders,
+                }
+              )
+            : undefined
+        )
+        .filter(isNonNullish)
+    );
+  }
+
+  private generateUnsupportedExamples(
+    exampleName: string,
+    exampleObject: OpenAPIV3_1.ExampleObject | OpenAPIV3_1.ReferenceObject,
+    i: number
+  ): ExampleObjectConverterNode[] {
+    return singleUndefinedArrayIfNullOrEmpty(this.requests).flatMap((request) =>
+      Object.entries(singleUndefinedRecordIfNullOrEmpty(request?.examples))
+        .map(([requestExampleName, requestExample]) =>
+          matchExampleName(exampleName, requestExampleName) &&
+          (this.isExampleDefined(requestExample) || exampleObject != null)
+            ? new ExampleObjectConverterNode(
+                {
+                  input: {
+                    requestExample,
+                    responseExample: {
+                      value: exampleObject,
+                    },
+                  },
+                  context: this.context,
+                  accessPath: this.accessPath,
+                  pathId: `examples[${i}]`,
+                },
+                this.path,
+                this.statusCode,
+                exampleName === "" ? undefined : exampleName,
+                {
+                  requestBody: request,
+                  responseBody: this,
+                  pathParameters: this.shapes.pathParameters,
+                  queryParameters: this.shapes.queryParameters,
+                  requestHeaders: this.shapes.requestHeaders,
+                }
+              )
+            : undefined
+        )
+        .filter(isNonNullish)
+    );
+  }
+
+  private generateFallbackExamples(
+    fallbackExample: OpenAPIV3_1.ExampleObject | OpenAPIV3_1.ReferenceObject
+  ): ExampleObjectConverterNode[] {
+    return singleUndefinedArrayIfNullOrEmpty(this.requests).flatMap((request) =>
+      Object.values(singleUndefinedRecordIfNullOrEmpty(request?.examples)).map(
+        (requestExample) =>
+          new ExampleObjectConverterNode(
+            {
+              input: {
+                requestExample,
+                responseExample: fallbackExample,
+              },
+              context: this.context,
+              accessPath: this.accessPath,
+              pathId: this.pathId,
+            },
+            this.path,
+            this.statusCode,
+            undefined,
+            {
+              requestBody: request,
+              responseBody: this,
+              pathParameters: this.shapes.pathParameters,
+              queryParameters: this.shapes.queryParameters,
+              requestHeaders: this.shapes.requestHeaders,
+            }
+          )
+      )
+    );
+  }
+
   parse(contentType: string | undefined): void {
     const mediaType = MediaType.parse(contentType);
 
@@ -104,47 +233,7 @@ export class ResponseMediaTypeObjectConverterNode extends BaseOpenApiV3_1Convert
     ).forEach(([exampleName, exampleObject], i) => {
       this.examples ??= [];
       this.examples = this.examples.concat(
-        singleUndefinedArrayIfNullOrEmpty(this.requests).flatMap((request) =>
-          Object.entries(
-            request?.examples ?? {
-              "": undefined,
-            }
-          )
-            .map(([requestExampleName, requestExample]) =>
-              (exampleName === requestExampleName ||
-                requestExampleName === "" ||
-                exampleName === "") &&
-              ((requestExample != null &&
-                resolveExampleReference(requestExample, this.context.document)
-                  ?.value != null) ||
-                (exampleObject != null &&
-                  resolveExampleReference(exampleObject, this.context.document)
-                    ?.value != null))
-                ? new ExampleObjectConverterNode(
-                    {
-                      input: {
-                        requestExample,
-                        responseExample: exampleObject,
-                      },
-                      context: this.context,
-                      accessPath: this.accessPath,
-                      pathId: `examples[${i}]`,
-                    },
-                    this.path,
-                    this.statusCode,
-                    exampleName === "" ? undefined : exampleName,
-                    {
-                      requestBody: request,
-                      responseBody: this,
-                      pathParameters: this.shapes.pathParameters,
-                      queryParameters: this.shapes.queryParameters,
-                      requestHeaders: this.shapes.requestHeaders,
-                    }
-                  )
-                : undefined
-            )
-            .filter(isNonNullish)
-        )
+        this.generateSupportedExamples(exampleName, exampleObject, i)
       );
     });
 
@@ -162,47 +251,7 @@ export class ResponseMediaTypeObjectConverterNode extends BaseOpenApiV3_1Convert
       ).forEach(([exampleName, exampleObject], i) => {
         this.examples ??= [];
         this.examples = this.examples.concat(
-          singleUndefinedArrayIfNullOrEmpty(this.requests).flatMap((request) =>
-            Object.entries(
-              request?.examples ?? {
-                "": undefined,
-              }
-            )
-              .map(([requestExampleName, requestExample]) =>
-                (exampleName === requestExampleName ||
-                  requestExampleName === "" ||
-                  exampleName === "") &&
-                ((requestExample != null &&
-                  resolveExampleReference(requestExample, this.context.document)
-                    ?.value != null) ||
-                  exampleObject != null)
-                  ? new ExampleObjectConverterNode(
-                      {
-                        input: {
-                          requestExample,
-                          responseExample: {
-                            value: exampleObject,
-                          },
-                        },
-                        context: this.context,
-                        accessPath: this.accessPath,
-                        pathId: `examples[${i}]`,
-                      },
-                      this.path,
-                      this.statusCode,
-                      exampleName === "" ? undefined : exampleName,
-                      {
-                        requestBody: request,
-                        responseBody: this,
-                        pathParameters: this.shapes.pathParameters,
-                        queryParameters: this.shapes.queryParameters,
-                        requestHeaders: this.shapes.requestHeaders,
-                      }
-                    )
-                  : undefined
-              )
-              .filter(isNonNullish)
-          )
+          this.generateUnsupportedExamples(exampleName, exampleObject, i)
         );
       });
 
@@ -220,37 +269,7 @@ export class ResponseMediaTypeObjectConverterNode extends BaseOpenApiV3_1Convert
 
         if (fallbackExample != null) {
           this.examples = this.examples.concat(
-            singleUndefinedArrayIfNullOrEmpty(this.requests).flatMap(
-              (request) =>
-                Object.values(
-                  request?.examples ?? {
-                    "": undefined,
-                  }
-                ).map(
-                  (requestExample) =>
-                    new ExampleObjectConverterNode(
-                      {
-                        input: {
-                          requestExample,
-                          responseExample: fallbackExample,
-                        },
-                        context: this.context,
-                        accessPath: this.accessPath,
-                        pathId: this.pathId,
-                      },
-                      this.path,
-                      this.statusCode,
-                      undefined,
-                      {
-                        requestBody: request,
-                        responseBody: this,
-                        pathParameters: this.shapes.pathParameters,
-                        queryParameters: this.shapes.queryParameters,
-                        requestHeaders: this.shapes.requestHeaders,
-                      }
-                    )
-                )
-            )
+            this.generateFallbackExamples(fallbackExample)
           );
         }
       }

diff --git a/packages/parsers/src/openapi/utils/singleUndefinedRecordIfNullOrEmpty.ts b/packages/parsers/src/openapi/utils/singleUndefinedRecordIfNullOrEmpty.ts
@@ -0,0 +1,7 @@
+export function singleUndefinedRecordIfNullOrEmpty<T>(
+  value: Record<string, T | undefined> | undefined
+): Record<string, T | undefined> | [undefined] {
+  return value != null && Object.keys(value).length > 0
+    ? value
+    : { "": undefined };
+}