chore: centralize openrpc wrapped requests (#2650)

Author: dsinghvi

packages/fdr-sdk/src/api-definition/index.ts

@@ -14,3 +14,4 @@ export * from "./types";
 export * from "./unwrap";
 export * from "./url";
 export * from "./snippets/backfill";
+export * from "./wrapOpenRPCRequest";

packages/fdr-sdk/src/api-definition/snippets/curl.ts

@@ -9,6 +9,7 @@ import {
 } from "@fern-api/ui-core-utils";
 
 import type * as Latest from "../latest";
+import { wrapOpenRPCRequest } from "../wrapOpenRPCRequest";
 import {
   SnippetHttpRequest,
   SnippetHttpRequestBodyFormValue,
@@ -91,16 +92,7 @@ function getBodyJsonString(
   protocol?: Latest.Protocol
 ): string[] {
   if (protocol?.type === "openrpc") {
-    let params = [];
-    if (value && typeof value === "object") {
-      params = Object.values(value);
-    }
-    const payload = {
-      id: 1,
-      jsonrpc: "2.0",
-      method: protocol.methodName,
-      params: params,
-    };
+    const payload = wrapOpenRPCRequest(value, protocol.methodName);
     const stringifiedValue = JSON.stringify(payload, null, 2).replace(
       /'/g,
       "\\'"

packages/fdr-sdk/src/api-definition/wrapOpenRPCRequest.ts

@@ -0,0 +1,27 @@
+/**
+ * Wraps a request body in the OpenRPC format.
+ *
+ * @param body - The request body to wrap
+ * @param methodName - The OpenRPC method name
+ * @returns The wrapped request body in OpenRPC format
+ */
+export function wrapOpenRPCRequest(
+  body: unknown,
+  methodName: string
+): {
+  jsonrpc: string;
+  method: string;
+  params: unknown[];
+  id: number;
+} {
+  let params: unknown[] = [];
+  if (body && typeof body === "object") {
+    params = Object.values(body);
+  }
+  return {
+    jsonrpc: "2.0",
+    method: methodName,
+    params,
+    id: 1,
+  };
+}

packages/fern-docs/bundle/src/components/playground/code-snippets/builders/types.ts

@@ -1,5 +1,8 @@
 import type { EndpointContext } from "@fern-api/fdr-sdk/api-definition";
-import { buildEndpointUrl } from "@fern-api/fdr-sdk/api-definition";
+import {
+  buildEndpointUrl,
+  wrapOpenRPCRequest,
+} from "@fern-api/fdr-sdk/api-definition";
 
 import {
   PlaygroundAuthState,
@@ -26,16 +29,10 @@ export abstract class PlaygroundCodeSnippetBuilder {
 
   protected maybeWrapJsonBody(body: unknown): unknown {
     if (this.context.endpoint.protocol?.type === "openrpc") {
-      let params = [];
-      if (body && typeof body === "object") {
-        params = Object.values(body);
-      }
-      return {
-        jsonrpc: "2.0",
-        method: this.context.endpoint.protocol.methodName,
-        params,
-        id: 1,
-      };
+      return wrapOpenRPCRequest(
+        body,
+        this.context.endpoint.protocol.methodName
+      );
     }
     return body;
   }

packages/fern-docs/bundle/src/components/playground/endpoint/PlaygroundEndpoint.tsx

@@ -137,11 +137,11 @@ export const PlaygroundEndpoint = ({
         }),
         method: endpoint.method,
         headers,
-        body: await serializeFormStateBody(
-          endpoint.requests?.[0]?.body,
-          formState.body,
-          usesApplicationJsonInFormDataValue
-        ),
+        body: await serializeFormStateBody({
+          shape: endpoint.requests?.[0]?.body,
+          body: formState.body,
+          usesApplicationJsonInFormDataValue,
+        }),
       };
       if (endpoint.responses?.[0]?.body.type === "stream") {
         const [res, stream] = await executeProxyStream(req, isProxyDisabled);

packages/fern-docs/bundle/src/components/playground/utils/oauth.ts

@@ -58,11 +58,11 @@ export const oAuthClientCredentialReferencedEndpointLoginFlow = async ({
     }),
     method: endpoint.method,
     headers,
-    body: await serializeFormStateBody(
-      endpoint.requests?.[0]?.body,
-      formState.body,
-      false
-    ),
+    body: await serializeFormStateBody({
+      shape: endpoint.requests?.[0]?.body,
+      body: formState.body,
+      usesApplicationJsonInFormDataValue: false,
+    }),
   };
   const res = await executeProxyRest(req);
 

packages/fern-docs/bundle/src/components/playground/utils/serialize.test.ts

@@ -51,7 +51,11 @@ describe("serializeFormStateBody", () => {
       },
     };
 
-    const result = await serializeFormStateBody(shape, body, true);
+    const result = await serializeFormStateBody({
+      shape,
+      body,
+      usesApplicationJsonInFormDataValue: true,
+    });
 
     expect(result).toEqual({
       type: "form-data",
@@ -93,7 +97,11 @@ describe("serializeFormStateBody", () => {
       },
     };
 
-    const result = await serializeFormStateBody(shape, body, true);
+    const result = await serializeFormStateBody({
+      shape,
+      body,
+      usesApplicationJsonInFormDataValue: true,
+    });
 
     expect(result).toEqual({
       type: "form-data",

packages/fern-docs/bundle/src/components/playground/utils/serialize.ts

@@ -3,6 +3,8 @@ import { compact, flatten } from "es-toolkit/array";
 import {
   FormDataField,
   HttpRequestBodyShape,
+  Protocol,
+  wrapOpenRPCRequest,
 } from "@fern-api/fdr-sdk/api-definition";
 import { assertNever, isNonNullish } from "@fern-api/ui-core-utils";
 
@@ -14,18 +16,32 @@ import {
   SerializableFormDataEntryValue,
 } from "../types";
 
-export async function serializeFormStateBody(
-  shape: HttpRequestBodyShape | undefined,
-  body: PlaygroundFormStateBody | undefined,
-  usesApplicationJsonInFormDataValue: boolean
-): Promise<ProxyRequest.SerializableBody | undefined> {
+export const serializeFormStateBody = async ({
+  shape,
+  body,
+  usesApplicationJsonInFormDataValue,
+  protocol,
+}: {
+  shape: HttpRequestBodyShape | undefined;
+  body: PlaygroundFormStateBody | undefined;
+  usesApplicationJsonInFormDataValue: boolean;
+  protocol?: Protocol;
+}): Promise<ProxyRequest.SerializableBody | undefined> => {
   if (shape == null || body == null) {
     return undefined;
   }
 
   switch (body.type) {
-    case "json":
+    case "json": {
+      if (protocol?.type === "openrpc") {
+        // Wrap the request body in OpenRPC format
+        return {
+          type: "json",
+          value: wrapOpenRPCRequest(body.value, protocol.methodName),
+        };
+      }
       return { type: "json", value: body.value };
+    }
     case "form-data": {
       const formDataValue: Record<string, SerializableFormDataEntryValue> = {};
       for (const [key, value] of Object.entries(body.value)) {
@@ -109,7 +125,7 @@ export async function serializeFormStateBody(
     default:
       assertNever(body);
   }
-}
+};
 
 async function serializeFile(
   file: File | undefined