Refactor before review

Author: nolannbiron

packages/react-openapi/src/OpenAPISchema.tsx

@@ -166,7 +166,7 @@ function OpenAPISchemaAlternative(props: {
 /**
  * Render a circular reference to a schema.
  */
-export function OpenAPISchemaCircularRef(props: { id: string; schema: OpenAPIV3.SchemaObject }) {
+function OpenAPISchemaCircularRef(props: { id: string; schema: OpenAPIV3.SchemaObject }) {
     const { id, schema } = props;
 
     return (
@@ -180,7 +180,7 @@ export function OpenAPISchemaCircularRef(props: { id: string; schema: OpenAPIV3.
 /**
  * Render the enum value for a schema.
  */
-export function OpenAPISchemaEnum(props: { enumValues: any[] }) {
+function OpenAPISchemaEnum(props: { enumValues: any[] }) {
     const { enumValues } = props;
 
     return (
@@ -198,7 +198,10 @@ export function OpenAPISchemaEnum(props: { enumValues: any[] }) {
     );
 }
 
-export function OpenAPISchemaPresentation(props: { property: OpenAPISchemaPropertyEntry }) {
+/**
+ * Render the top row of a schema. e.g: name, type, and required status.
+ */
+function OpenAPISchemaPresentation(props: { property: OpenAPISchemaPropertyEntry }) {
     const {
         property: { schema, propertyName, required },
     } = props;
@@ -245,9 +248,7 @@ export function OpenAPISchemaPresentation(props: { property: OpenAPISchemaProper
 /**
  * Get the sub-properties of a schema.
  */
-export function getSchemaProperties(
-    schema: OpenAPIV3.SchemaObject
-): null | OpenAPISchemaPropertyEntry[] {
+function getSchemaProperties(schema: OpenAPIV3.SchemaObject): null | OpenAPISchemaPropertyEntry[] {
     // check array AND schema.items as this is sometimes null despite what the type indicates
     if (schema.type === 'array' && schema.items && !checkIsReference(schema.items)) {
         const items = schema.items;
@@ -360,7 +361,7 @@ function flattenAlternatives(
     }, []);
 }
 
-export function getSchemaTitle(schema: OpenAPIV3.SchemaObject): string {
+function getSchemaTitle(schema: OpenAPIV3.SchemaObject): string {
     // Otherwise try to infer a nice title
     let type = 'any';
 

packages/react-openapi/src/index.ts

@@ -1,5 +1,5 @@
 export * from './models';
 export * from './OpenAPIOperation';
 export * from './OpenAPIOperationContext';
-export { resolveOpenAPIOperation } from './resolveOpenAPIOperation';
+export * from './resolveOpenAPIOperation';
 export type { OpenAPIModelsData, OpenAPIOperationData } from './types';

packages/react-openapi/src/memoDereferenceFilesystem.ts

@@ -0,0 +1,29 @@
+import { type Filesystem, type OpenAPIV3xDocument, dereference } from '@gitbook/openapi-parser';
+
+const dereferenceCache = new WeakMap<Filesystem, Promise<OpenAPIV3xDocument>>();
+
+/**
+ * Memoized version of `dereferenceSchema`.
+ */
+export function memoDereferenceFilesystem(filesystem: Filesystem): Promise<OpenAPIV3xDocument> {
+    if (dereferenceCache.has(filesystem)) {
+        return dereferenceCache.get(filesystem) as Promise<OpenAPIV3xDocument>;
+    }
+
+    const promise = dereferenceFilesystem(filesystem);
+    dereferenceCache.set(filesystem, promise);
+    return promise;
+}
+
+/**
+ * Dereference an OpenAPI schema.
+ */
+async function dereferenceFilesystem(filesystem: Filesystem): Promise<OpenAPIV3xDocument> {
+    const result = await dereference(filesystem);
+
+    if (!result.schema) {
+        throw new Error('Failed to dereference OpenAPI document');
+    }
+
+    return result.schema as OpenAPIV3xDocument;
+}

packages/react-openapi/src/models/index.ts

@@ -1,2 +1,2 @@
-export { OpenAPIModels } from './OpenAPIModels';
+export * from './OpenAPIModels';
 export * from './resolveOpenAPIModels';

packages/react-openapi/src/models/resolveOpenAPIModels.ts

@@ -5,7 +5,7 @@ import {
     type OpenAPIV3xDocument,
     shouldIgnoreEntity,
 } from '@gitbook/openapi-parser';
-import { memoDereferenceFilesystem } from '../resolveOpenAPIOperation';
+import { memoDereferenceFilesystem } from '../memoDereferenceFilesystem';
 import type { OpenAPIModelsData } from '../types';
 
 //!!TODO: We should return only the models that are used in the block. Still a WIP awaiting future work.

packages/react-openapi/src/resolveOpenAPIOperation.ts

@@ -1,12 +1,12 @@
 import { fromJSON, toJSON } from 'flatted';
 
-import {
-    type Filesystem,
-    type OpenAPIV3,
-    type OpenAPIV3_1,
-    type OpenAPIV3xDocument,
-    dereference,
+import type {
+    Filesystem,
+    OpenAPIV3,
+    OpenAPIV3_1,
+    OpenAPIV3xDocument,
 } from '@gitbook/openapi-parser';
+import { memoDereferenceFilesystem } from './memoDereferenceFilesystem';
 import type { OpenAPIOperationData } from './types';
 import { checkIsReference } from './utils';
 
@@ -69,34 +69,6 @@ export async function resolveOpenAPIOperation(
     };
 }
 
-const dereferenceCache = new WeakMap<Filesystem, Promise<OpenAPIV3xDocument>>();
-
-/**
- * Memoized version of `dereferenceSchema`.
- */
-export function memoDereferenceFilesystem(filesystem: Filesystem): Promise<OpenAPIV3xDocument> {
-    if (dereferenceCache.has(filesystem)) {
-        return dereferenceCache.get(filesystem) as Promise<OpenAPIV3xDocument>;
-    }
-
-    const promise = dereferenceFilesystem(filesystem);
-    dereferenceCache.set(filesystem, promise);
-    return promise;
-}
-
-/**
- * Dereference an OpenAPI schema.
- */
-async function dereferenceFilesystem(filesystem: Filesystem): Promise<OpenAPIV3xDocument> {
-    const result = await dereference(filesystem);
-
-    if (!result.schema) {
-        throw new Error('Failed to dereference OpenAPI document');
-    }
-
-    return result.schema as OpenAPIV3xDocument;
-}
-
 /**
  * Get a path object from its path.
  */