(feat): add format to the x-fern-streaming extension to support s…

…se (#3407)
fern-api · Apr 19, 2024 · 2e0f42d · 2e0f42d
1 parent f5b73f6
commit 2e0f42d
Show file tree

Hide file tree

Showing 22 changed files with 263 additions and 24 deletions.
diff --git a/packages/cli/openapi-ir-sdk/fern/definition/finalIr.yml b/packages/cli/openapi-ir-sdk/fern/definition/finalIr.yml
@@ -325,6 +325,7 @@ types:
       file: FileResponse
       json: JsonResponse
       text: TextResponse
+      streamingSse: JsonResponse
       streamingText: TextResponse
       streamingJson:
         type: JsonResponse

diff --git a/packages/cli/openapi-ir-sdk/fern/definition/parseIr.yml b/packages/cli/openapi-ir-sdk/fern/definition/parseIr.yml
@@ -69,6 +69,7 @@ types:
       file: finalIr.FileResponse
       json: JsonResponseWithExample
       text: finalIr.TextResponse
+      streamingSse: finalIr.JsonResponse
       streamingText: finalIr.TextResponse
       streamingJson:
         type: finalIr.JsonResponse

diff --git a/packages/cli/openapi-ir-sdk/src/sdk/api/resources/finalIr/types/Response.ts b/packages/cli/openapi-ir-sdk/src/sdk/api/resources/finalIr/types/Response.ts
@@ -8,6 +8,7 @@ export type Response =
     | FernOpenapiIr.Response.File_
     | FernOpenapiIr.Response.Json
     | FernOpenapiIr.Response.Text
+    | FernOpenapiIr.Response.StreamingSse
     | FernOpenapiIr.Response.StreamingText
     /**
      * Checks if `x-fern-streaming` is present and is true. */
@@ -26,6 +27,10 @@ export declare namespace Response {
         type: "text";
     }
 
+    interface StreamingSse extends FernOpenapiIr.JsonResponse, _Utils {
+        type: "streamingSse";
+    }
+
     interface StreamingText extends FernOpenapiIr.TextResponse, _Utils {
         type: "streamingText";
     }
@@ -42,6 +47,7 @@ export declare namespace Response {
         file: (value: FernOpenapiIr.FileResponse) => _Result;
         json: (value: FernOpenapiIr.JsonResponse) => _Result;
         text: (value: FernOpenapiIr.TextResponse) => _Result;
+        streamingSse: (value: FernOpenapiIr.JsonResponse) => _Result;
         streamingText: (value: FernOpenapiIr.TextResponse) => _Result;
         streamingJson: (value: FernOpenapiIr.JsonResponse) => _Result;
         _other: (value: { type: string }) => _Result;
@@ -88,6 +94,19 @@ export const Response = {
         };
     },
 
+    streamingSse: (value: FernOpenapiIr.JsonResponse): FernOpenapiIr.Response.StreamingSse => {
+        return {
+            ...value,
+            type: "streamingSse",
+            _visit: function <_Result>(
+                this: FernOpenapiIr.Response.StreamingSse,
+                visitor: FernOpenapiIr.Response._Visitor<_Result>
+            ) {
+                return FernOpenapiIr.Response._visit(this, visitor);
+            },
+        };
+    },
+
     streamingText: (value: FernOpenapiIr.TextResponse): FernOpenapiIr.Response.StreamingText => {
         return {
             ...value,
@@ -122,6 +141,8 @@ export const Response = {
                 return visitor.json(value);
             case "text":
                 return visitor.text(value);
+            case "streamingSse":
+                return visitor.streamingSse(value);
             case "streamingText":
                 return visitor.streamingText(value);
             case "streamingJson":

diff --git a/packages/cli/openapi-ir-sdk/src/sdk/api/resources/parseIr/types/ResponseWithExample.ts b/packages/cli/openapi-ir-sdk/src/sdk/api/resources/parseIr/types/ResponseWithExample.ts
@@ -8,6 +8,7 @@ export type ResponseWithExample =
     | FernOpenapiIr.ResponseWithExample.File_
     | FernOpenapiIr.ResponseWithExample.Json
     | FernOpenapiIr.ResponseWithExample.Text
+    | FernOpenapiIr.ResponseWithExample.StreamingSse
     | FernOpenapiIr.ResponseWithExample.StreamingText
     /**
      * Checks if `x-fern-streaming` is present and is true. */
@@ -26,6 +27,10 @@ export declare namespace ResponseWithExample {
         type: "text";
     }
 
+    interface StreamingSse extends FernOpenapiIr.JsonResponse, _Utils {
+        type: "streamingSse";
+    }
+
     interface StreamingText extends FernOpenapiIr.TextResponse, _Utils {
         type: "streamingText";
     }
@@ -42,6 +47,7 @@ export declare namespace ResponseWithExample {
         file: (value: FernOpenapiIr.FileResponse) => _Result;
         json: (value: FernOpenapiIr.JsonResponseWithExample) => _Result;
         text: (value: FernOpenapiIr.TextResponse) => _Result;
+        streamingSse: (value: FernOpenapiIr.JsonResponse) => _Result;
         streamingText: (value: FernOpenapiIr.TextResponse) => _Result;
         streamingJson: (value: FernOpenapiIr.JsonResponse) => _Result;
         _other: (value: { type: string }) => _Result;
@@ -88,6 +94,19 @@ export const ResponseWithExample = {
         };
     },
 
+    streamingSse: (value: FernOpenapiIr.JsonResponse): FernOpenapiIr.ResponseWithExample.StreamingSse => {
+        return {
+            ...value,
+            type: "streamingSse",
+            _visit: function <_Result>(
+                this: FernOpenapiIr.ResponseWithExample.StreamingSse,
+                visitor: FernOpenapiIr.ResponseWithExample._Visitor<_Result>
+            ) {
+                return FernOpenapiIr.ResponseWithExample._visit(this, visitor);
+            },
+        };
+    },
+
     streamingText: (value: FernOpenapiIr.TextResponse): FernOpenapiIr.ResponseWithExample.StreamingText => {
         return {
             ...value,
@@ -125,6 +144,8 @@ export const ResponseWithExample = {
                 return visitor.json(value);
             case "text":
                 return visitor.text(value);
+            case "streamingSse":
+                return visitor.streamingSse(value);
             case "streamingText":
                 return visitor.streamingText(value);
             case "streamingJson":

diff --git a/packages/cli/openapi-ir-sdk/src/sdk/serialization/resources/finalIr/types/Response.ts b/packages/cli/openapi-ir-sdk/src/sdk/serialization/resources/finalIr/types/Response.ts
@@ -11,6 +11,7 @@ export const Response: core.serialization.Schema<serializers.Response.Raw, FernO
         file: core.serialization.lazyObject(async () => (await import("../../..")).FileResponse),
         json: core.serialization.lazyObject(async () => (await import("../../..")).JsonResponse),
         text: core.serialization.lazyObject(async () => (await import("../../..")).TextResponse),
+        streamingSse: core.serialization.lazyObject(async () => (await import("../../..")).JsonResponse),
         streamingText: core.serialization.lazyObject(async () => (await import("../../..")).TextResponse),
         streamingJson: core.serialization.lazyObject(async () => (await import("../../..")).JsonResponse),
     })
@@ -23,6 +24,8 @@ export const Response: core.serialization.Schema<serializers.Response.Raw, FernO
                     return FernOpenapiIr.Response.json(value);
                 case "text":
                     return FernOpenapiIr.Response.text(value);
+                case "streamingSse":
+                    return FernOpenapiIr.Response.streamingSse(value);
                 case "streamingText":
                     return FernOpenapiIr.Response.streamingText(value);
                 case "streamingJson":
@@ -35,7 +38,13 @@ export const Response: core.serialization.Schema<serializers.Response.Raw, FernO
     });
 
 export declare namespace Response {
-    type Raw = Response.File | Response.Json | Response.Text | Response.StreamingText | Response.StreamingJson;
+    type Raw =
+        | Response.File
+        | Response.Json
+        | Response.Text
+        | Response.StreamingSse
+        | Response.StreamingText
+        | Response.StreamingJson;
 
     interface File extends serializers.FileResponse.Raw {
         type: "file";
@@ -49,6 +58,10 @@ export declare namespace Response {
         type: "text";
     }
 
+    interface StreamingSse extends serializers.JsonResponse.Raw {
+        type: "streamingSse";
+    }
+
     interface StreamingText extends serializers.TextResponse.Raw {
         type: "streamingText";
     }

diff --git a/...s/cli/openapi-ir-sdk/src/sdk/serialization/resources/parseIr/types/ResponseWithExample.ts b/...s/cli/openapi-ir-sdk/src/sdk/serialization/resources/parseIr/types/ResponseWithExample.ts
@@ -14,6 +14,7 @@ export const ResponseWithExample: core.serialization.Schema<
         file: core.serialization.lazyObject(async () => (await import("../../..")).FileResponse),
         json: core.serialization.lazyObject(async () => (await import("../../..")).JsonResponseWithExample),
         text: core.serialization.lazyObject(async () => (await import("../../..")).TextResponse),
+        streamingSse: core.serialization.lazyObject(async () => (await import("../../..")).JsonResponse),
         streamingText: core.serialization.lazyObject(async () => (await import("../../..")).TextResponse),
         streamingJson: core.serialization.lazyObject(async () => (await import("../../..")).JsonResponse),
     })
@@ -26,6 +27,8 @@ export const ResponseWithExample: core.serialization.Schema<
                     return FernOpenapiIr.ResponseWithExample.json(value);
                 case "text":
                     return FernOpenapiIr.ResponseWithExample.text(value);
+                case "streamingSse":
+                    return FernOpenapiIr.ResponseWithExample.streamingSse(value);
                 case "streamingText":
                     return FernOpenapiIr.ResponseWithExample.streamingText(value);
                 case "streamingJson":
@@ -42,6 +45,7 @@ export declare namespace ResponseWithExample {
         | ResponseWithExample.File
         | ResponseWithExample.Json
         | ResponseWithExample.Text
+        | ResponseWithExample.StreamingSse
         | ResponseWithExample.StreamingText
         | ResponseWithExample.StreamingJson;
 
@@ -57,6 +61,10 @@ export declare namespace ResponseWithExample {
         type: "text";
     }
 
+    interface StreamingSse extends serializers.JsonResponse.Raw {
+        type: "streamingSse";
+    }
+
     interface StreamingText extends serializers.TextResponse.Raw {
         type: "streamingText";
     }

diff --git a/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/streaming.test.ts.snap b/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/streaming.test.ts.snap
@@ -65,6 +65,7 @@ exports[`open api parser streaming simple 1`] = `
           },
           "response-stream": {
             "docs": "",
+            "format": "json",
             "type": "StreamUser",
           },
         },
@@ -127,6 +128,7 @@ exports[`open api parser streaming simple 1`] = `
           },
           "response-stream": {
             "docs": "",
+            "format": "json",
             "type": "StreamUser2",
           },
         },
@@ -188,6 +190,7 @@ exports[`open api parser streaming simple 1`] = `
           },
           "response-stream": {
             "docs": "",
+            "format": "json",
             "type": "UserV3StreamResponse",
           },
         },

diff --git a/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/vellum.test.ts.snap b/packages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/vellum.test.ts.snap
@@ -998,6 +998,7 @@ Executes a deployed Workflow and streams back its results.",
           },
           "response-stream": {
             "docs": "",
+            "format": "json",
             "type": "WorkflowStreamEvent",
           },
           "url": "Predict",
@@ -1121,6 +1122,7 @@ Generate a stream of completions using a previously defined deployment.
           },
           "response-stream": {
             "docs": "",
+            "format": "json",
             "type": "GenerateStreamResponse",
           },
           "url": "Predict",

diff --git a/...penapi-ir-to-fern/src/__test__/__snapshots__/x-fern-audiences-with-streaming.test.ts.snap b/...penapi-ir-to-fern/src/__test__/__snapshots__/x-fern-audiences-with-streaming.test.ts.snap
@@ -70,6 +70,7 @@ exports[`x-fern-sdk-group-name-with-streaming x-fern-sdk-group-name-with-streami
             },
             "response-stream": {
               "docs": "",
+              "format": "json",
               "type": "root.StreamUser",
             },
           },

diff --git a/...ages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/x-fern-global-headers.test.ts.snap b/...ages/cli/openapi-ir-to-fern/src/__test__/__snapshots__/x-fern-global-headers.test.ts.snap
@@ -83,6 +83,7 @@ exports[`x-fern-global-headers x-fern-global-headers simple 1`] = `
             },
             "response-stream": {
               "docs": "",
+              "format": "json",
               "type": "root.StreamUser",
             },
           },

diff --git a/...penapi-ir-to-fern/src/__test__/__snapshots__/x-fern-streaming-with-reference.test.ts.snap b/...penapi-ir-to-fern/src/__test__/__snapshots__/x-fern-streaming-with-reference.test.ts.snap
@@ -63,6 +63,7 @@ exports[`x-fern-streaming-with-reference x-fern-streaming-with-reference simple
             },
             "response-stream": {
               "docs": "",
+              "format": "json",
               "type": "root.CompletionChunk",
             },
           },

diff --git a/.../cli/openapi-ir-to-fern/src/__test__/__snapshots__/x-fern-streaming-with-sse.test.ts.snap b/.../cli/openapi-ir-to-fern/src/__test__/__snapshots__/x-fern-streaming-with-sse.test.ts.snap
@@ -0,0 +1,61 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`x-fern-streaming-with-sse x-fern-streaming-with-sse simple 1`] = `
+{
+  "definitionFiles": {
+    "chatCompletions.yml": {
+      "service": {
+        "auth": false,
+        "base-path": "",
+        "endpoints": {
+          "create": {
+            "auth": false,
+            "docs": undefined,
+            "method": "POST",
+            "path": "/completions/chat",
+            "request": {
+              "body": {
+                "properties": {
+                  "prompt": "string",
+                  "stream": "optional<boolean>",
+                },
+              },
+              "headers": undefined,
+              "name": "CreateCompletionRequest",
+              "query-parameters": undefined,
+            },
+            "response-stream": {
+              "docs": "Success!",
+              "format": "sse",
+              "type": "string",
+            },
+          },
+        },
+      },
+    },
+  },
+  "packageMarkerFile": {
+    "types": {
+      "Completion": {
+        "docs": undefined,
+        "properties": {
+          "text": "optional<string>",
+        },
+      },
+      "CompletionChunk": {
+        "docs": undefined,
+        "properties": {
+          "text": "optional<string>",
+        },
+      },
+    },
+  },
+  "rootApiFile": {
+    "display-name": "Test extension \`x-fern-audiences\` alongside \`x-fern-streaming\`.",
+    "error-discrimination": {
+      "strategy": "status-code",
+    },
+    "name": "api",
+  },
+}
+`;
diff --git a/packages/cli/openapi-ir-to-fern/src/__test__/fixtures/x-fern-streaming-with-sse/openapi.yml b/packages/cli/openapi-ir-to-fern/src/__test__/fixtures/x-fern-streaming-with-sse/openapi.yml
@@ -0,0 +1,49 @@
+openapi: 3.1.0
+info:
+  title: Test extension `x-fern-audiences` alongside `x-fern-streaming`.
+  version: 1.0.0
+paths:
+  "/completions/chat":
+    post:
+      x-fern-sdk-group-name: chatCompletions
+      x-fern-sdk-method-name: create
+      x-fern-streaming:
+        format: sse
+        # stream-condition: $request.stream
+        # response:
+        #   $ref: "#/components/schemas/Completion"
+        # response-stream:
+        #   $ref: "#/components/schemas/CompletionChunk"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/CreateCompletionRequest"
+      responses:
+        "200":
+          description: "Success!"
+          content:
+            application/json:
+              schema:
+                type: string
+components:
+  schemas:
+    CreateCompletionRequest: 
+      type: object
+      properties:
+        stream: 
+          type: boolean
+        prompt: 
+          type: string
+      required: 
+        - prompt
+    Completion:
+      type: object
+      properties:
+        text: 
+          type: string 
+    CompletionChunk:
+      type: object
+      properties:
+        text: 
+          type: string
diff --git a/packages/cli/openapi-ir-to-fern/src/__test__/x-fern-streaming-with-sse.test.ts b/packages/cli/openapi-ir-to-fern/src/__test__/x-fern-streaming-with-sse.test.ts
@@ -0,0 +1,5 @@
+import { testConvertOpenAPI } from "./testConvertOpenApi";
+
+describe("x-fern-streaming-with-sse", () => {
+    testConvertOpenAPI("x-fern-streaming-with-sse", "openapi.yml");
+});