@stainless-api/docs 0.1.0-beta.91 → 0.1.0-beta.92

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @stainless-api/docs
 
+## 0.1.0-beta.92
+
+### Patch Changes
+
+- 61ba36f: add support for form data bodies
+- Updated dependencies [61ba36f]
+  - @stainless-api/docs-ui@0.1.0-beta.69
+  - @stainless-api/docs-search@0.1.0-beta.22
+
 ## 0.1.0-beta.91
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stainless-api/docs",
-  "version": "0.1.0-beta.91",
+  "version": "0.1.0-beta.92",
   "publishConfig": {
     "access": "public"
   },
@@ -56,8 +56,8 @@
     "vite-plugin-prebundle-workers": "^0.2.0",
     "web-worker": "^1.5.0",
     "yaml": "^2.8.2",
-    "@stainless-api/docs-search": "0.1.0-beta.21",
-    "@stainless-api/docs-ui": "0.1.0-beta.68",
+    "@stainless-api/docs-search": "0.1.0-beta.22",
+    "@stainless-api/docs-ui": "0.1.0-beta.69",
     "@stainless-api/ui-primitives": "0.1.0-beta.47"
   },
   "devDependencies": {

package/plugin/components/RequestBuilder/index.tsx

@@ -1,7 +1,7 @@
 import { ReactNode } from 'react';
 import * as SDKJSON from '@stainless/sdk-json';
 import { useSpec } from '@stainless-api/docs-ui/contexts';
-import { extractParams } from './spec-helpers';
+import { extractParams, Param } from './spec-helpers';
 import type { SnippetStainlessIslandProps } from './props';
 
 /** Load and process the spec on the server side to avoid inflating client bundle */
@@ -14,9 +14,15 @@ export function RequestBuilder({
   children: ReactNode;
   method: SDKJSON.Method;
 }) {
+  let params: Param[];
   const spec = useSpec();
-  if (!spec) throw new Error('Spec is required for RequestBuilder');
-  const params = spec && extractParams(spec, method);
+  try {
+    if (!spec) throw new Error('Spec is required for RequestBuilder');
+    params = spec && extractParams(spec, method);
+  } catch (e) {
+    console.warn(e);
+    return <div className={className}>{children}</div>;
+  }
   const [httpMethod, path] = method.endpoint.split(' ') as [string, string];
 
   return (

package/plugin/components/RequestBuilder/spec-helpers.ts

@@ -1,6 +1,7 @@
 import type * as SDKJSON from '@stainless/sdk-json';
 import { printer } from '@stainless-api/docs-ui/markdown';
 import z from 'zod';
+import { getBodyParams } from '@stainless-api/docs-ui/utils';
 
 export const ParamSchema = z.object({
   stainlessPath: z.string(),
@@ -20,14 +21,10 @@ export function extractParams(spec: SDKJSON.Spec | undefined, method: SDKJSON.Me
       'expected HttpDeclFunction at stainlessPath "' + method.stainlessPath + '", got ' + decl?.kind,
     );
   }
-  const bodyTypes = Object.keys(decl.bodyParamsChildren ?? {});
-  if (bodyTypes.length > 0 && !bodyTypes.includes('application/json')) {
-    throw new Error('TODO: support non-json body params');
-  }
-  const bodyParams = decl.bodyParamsChildren?.['application/json'];
+  const bodyParams = getBodyParams(decl);
   const params = [
     ...Object.entries(decl.paramsChildren ?? {}).map(([location, children]) => ({ location, children })),
-    ...(bodyParams ? [{ location: 'body', children: bodyParams }] : []),
+    ...(bodyParams ? [{ location: 'body', children: bodyParams.params }] : []),
   ]
     .filter((e) => e.children.length)
     .flatMap(({ location, children }) =>

package/styles/code.css

@@ -170,10 +170,15 @@
 }
 
 .stldocs-snippet .stldocs-snippet-footer.try-it-footer {
-  display: flex;
+  display: none;
   justify-content: flex-end;
   gap: 0.5rem;
 
+  /* only show footer if RequestBuilder was rendered successfully */
+  stl-island[component='SnippetStainlessIsland'] & {
+    display: flex;
+  }
+
   .try-it-button,
   .send-button {
     width: 7rem;