implement dereferenced openapi schema

clients/apps/web/src/app/docs/api-reference/[...endpoint]/APIContainer.tsx

@@ -2,7 +2,6 @@
 
 import { CONFIG } from '@/utils/config'
 import { ContentPasteOutlined } from '@mui/icons-material'
-import openapiSchema from '@polar-sh/sdk/openapi'
 import { OpenAPIV3_1 } from 'openapi-types'
 import Button from 'polarkit/components/ui/atoms/button'
 import {
@@ -13,23 +12,13 @@ import {
 } from 'polarkit/components/ui/atoms/tabs'
 import { useCallback, useMemo } from 'react'
 
-const resolveSchema = (schemaName: string) => {
-  return (openapiSchema as unknown as OpenAPIV3_1.Document).components
-    ?.schemas?.[schemaName]
-}
-
 export const requestBodyParameters = (
   endpointMethod: OpenAPIV3_1.OperationObject,
 ) => {
   if (endpointMethod.requestBody && !('content' in endpointMethod.requestBody))
     return undefined
 
-  return resolveSchema(
-    // @ts-ignore
-    endpointMethod.requestBody?.content['application/json'].schema?.['$ref']
-      .split('/')
-      .pop(),
-  )
+  return endpointMethod.requestBody?.content['application/json'].schema
 }
 
 export const APIContainer = ({
@@ -49,8 +38,13 @@ export const APIContainer = ({
       url: string,
       endpoint: OpenAPIV3_1.OperationObject,
     ) => {
-      const requiredBodyParameters = requestBodyParameters(endpoint)?.properties
-        ? Object.entries(requestBodyParameters(endpoint)?.properties ?? {})
+      const requiredBodyParameters = endpoint.requestBody?.content?.[
+        'application/json'
+      ].schema.properties
+        ? Object.entries(
+            endpoint.requestBody?.content?.['application/json'].schema
+              .properties ?? {},
+          )
             .map(([key]) => ({
               [key]: `<${key}>`,
             }))

clients/apps/web/src/app/docs/api-reference/[...endpoint]/ResponseContainer.tsx

@@ -1,4 +1,3 @@
-import openapiSchema from '@polar-sh/sdk/openapi'
 import { OpenAPIV3_1 } from 'openapi-types'
 import {
   Tabs,
@@ -7,18 +6,6 @@ import {
   TabsTrigger,
 } from 'polarkit/components/ui/atoms/tabs'
 
-export const resolveSchema = (schemaName: string) => {
-  return (openapiSchema as unknown as OpenAPIV3_1.Document).components
-    ?.schemas?.[schemaName]
-}
-
-export const getResponseSchema = (response: OpenAPIV3_1.ResponseObject) => {
-  return resolveSchema(
-    // @ts-ignore
-    response.content?.['application/json'].schema?.['$ref'].split('/').pop(),
-  )
-}
-
 export const ResponseContainer = ({
   responses,
 }: {
@@ -49,8 +36,7 @@ export const ResponseContainer = ({
           <TabsContent key={statusCode} value={statusCode} className="p-2 py-0">
             <pre className="dark:text-polar-50 max-h-72 select-text overflow-auto p-4 font-mono text-xs leading-normal text-gray-900">
               {JSON.stringify(
-                getResponseSchema(response as OpenAPIV3_1.ResponseObject)
-                  ?.properties,
+                response.content?.['application/json'].schema,
                 null,
                 2,
               )}

clients/apps/web/src/app/docs/api-reference/[...endpoint]/page.tsx

@@ -1,6 +1,6 @@
 import openapiSchema from '@polar-sh/sdk/openapi'
 import { OpenAPIV3_1 } from 'openapi-types'
-import { PropsWithChildren, useCallback, useMemo } from 'react'
+import { PropsWithChildren, useMemo } from 'react'
 import { SchemaPathKey } from '../../APINavigation'
 import { APIContainer } from './APIContainer'
 import { ResponseContainer } from './ResponseContainer'
@@ -19,25 +19,14 @@ export default function Page({
     method
   ] as OpenAPIV3_1.OperationObject
 
-  const resolveSchema = useCallback((schemaName: string) => {
-    return (openapiSchema as unknown as OpenAPIV3_1.Document).components
-      ?.schemas?.[schemaName]
-  }, [])
-
   const requestBodyParameters = useMemo(() => {
     if (
       endpointMethod.requestBody &&
       !('content' in endpointMethod.requestBody)
     )
       return undefined
-
-    return resolveSchema(
-      // @ts-ignore
-      endpointMethod.requestBody?.content['application/json'].schema?.['$ref']
-        .split('/')
-        .pop(),
-    )
-  }, [endpointMethod, resolveSchema])
+    return endpointMethod.requestBody?.content['application/json'].schema
+  }, [endpointMethod])
 
   if (!endpointMethod) return null
 

clients/packages/sdk/package.json

@@ -15,10 +15,11 @@
   "scripts": {
     "download": "node scripts/generate-schema.js http://127.0.0.1:8000/openapi.json openapi/source.json openapi/updated.json",
     "generate": "pnpm download && ./generate",
-    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "build": "tsup src/index.ts --format cjs,esm --dts && cp -r openapi dist/openapi && node scripts/dereference-schema.js dist/openapi/source.json",
     "prepublishOnly": "pnpm run build"
   },
   "devDependencies": {
+    "@stoplight/json-ref-resolver": "^3.1.6",
     "tsconfig": "workspace:*",
     "tsup": "^7.2.0",
     "typescript": "5.3.3"

clients/packages/sdk/scripts/dereference-schema.js

@@ -0,0 +1,39 @@
+import refResolver from '@stoplight/json-ref-resolver'
+import fs from 'fs'
+
+
+const resolveRefs = async (schema) => {
+    const resolver = new refResolver.Resolver()
+    return await resolver.resolve(schema)
+}
+
+const getOpenAPISchema = async (schemaPath) => {
+    return new Promise((resolve, reject) => {
+        fs.readFile(schemaPath, 'utf8', (err, data) => {
+            if (err) {
+                reject(err)
+            }
+            resolve(JSON.parse(data))
+        })
+
+    })
+  }
+
+  const save = (filename, schema) => {
+    const asJson = JSON.stringify(schema, null, 4)
+    const written = fs.writeFileSync(filename, asJson)
+    return written
+  }
+
+  const main = async (schemaPath) => {
+    let schema = await getOpenAPISchema(schemaPath)
+    schema = (await resolveRefs(schema)).result
+    save(schemaPath, schema)
+  }
+
+  const argv = process.argv.slice(2)
+  if (argv.length !== 1) {
+    throw new Error('Args: <schemaPath>')
+  }
+  main(argv[0])
+