@gitbook/react-openapi 1.1.6 → 1.1.8

package/src/decycle.ts

@@ -0,0 +1,68 @@
+// Forked from: https://github.com/YChebotaev/json-decycle/blob/master/src/index.ts
+// Replaced `$ref` with `$reference` to avoid conflicts with OpenAPI
+
+const isObject = (value: any): value is object =>
+    typeof value === 'object' &&
+    value != null &&
+    !(value instanceof Boolean) &&
+    !(value instanceof Date) &&
+    !(value instanceof Number) &&
+    !(value instanceof RegExp) &&
+    !(value instanceof String);
+
+const toPointer = (parts: string[]) =>
+    `#${parts.map((part) => String(part).replace(/~/g, '~0').replace(/\//g, '~1')).join('/')}`;
+
+export const decycle = () => {
+    const paths = new WeakMap();
+
+    return function replacer(this: any, key: string | symbol, value: any) {
+        if (key !== '$reference' && isObject(value)) {
+            const seen = paths.has(value);
+
+            if (seen) {
+                return { $reference: toPointer(paths.get(value)) };
+            }
+
+            paths.set(value, [...(paths.get(this) ?? []), key]);
+        }
+
+        return value;
+    };
+};
+
+export function retrocycle() {
+    const parents = new WeakMap();
+    const keys = new WeakMap();
+    const refs = new Set();
+
+    function dereference(this: { [k: string]: any }, ref: { $reference: string }) {
+        const parts = ref.$reference.slice(1).split('/');
+        let key: any;
+        let value = this;
+
+        for (let i = 0; i < parts.length; i++) {
+            key = parts[i]?.replace(/~1/g, '/').replace(/~0/g, '~');
+            value = value[key];
+        }
+
+        const parent = parents.get(ref);
+        parent[keys.get(ref)] = value;
+    }
+
+    return function reviver(this: object, key: string | symbol, value: any) {
+        if (key === '$reference') {
+            refs.add(this);
+        } else if (isObject(value)) {
+            const isRoot = key === '' && Object.keys(this).length === 1;
+            if (isRoot) {
+                refs.forEach(dereference as any, this);
+            } else {
+                parents.set(value, this);
+                keys.set(value, key);
+            }
+        }
+
+        return value;
+    };
+}

package/src/schemas/OpenAPISchemas.tsx

@@ -1,6 +1,6 @@
 import clsx from 'clsx';
 import { OpenAPIDisclosureGroup } from '../OpenAPIDisclosureGroup';
-import { OpenAPIRootSchema } from '../OpenAPISchema';
+import { OpenAPIRootSchema } from '../OpenAPISchemaServer';
 import { Section, SectionBody } from '../StaticSection';
 import type { OpenAPIClientContext, OpenAPIContextProps, OpenAPISchemasData } from '../types';
 
@@ -16,8 +16,12 @@ export function OpenAPISchemas(props: {
     className?: string;
     data: OpenAPISchemasData;
     context: OpenAPISchemasContextProps;
+    /**
+     * Whether to show the schema directly if there is only one.
+     */
+    grouped?: boolean;
 }) {
-    const { className, data, context } = props;
+    const { className, data, context, grouped } = props;
     const { schemas } = data;
 
     const clientContext: OpenAPIClientContext = {
@@ -32,7 +36,7 @@ export function OpenAPISchemas(props: {
 
     return (
         <div className={clsx('openapi-schemas', className)}>
-            <OpenAPIRootSchemasSchema schemas={schemas} context={clientContext} />
+            <OpenAPIRootSchemasSchema grouped={grouped} schemas={schemas} context={clientContext} />
         </div>
     );
 }
@@ -44,11 +48,12 @@ export function OpenAPISchemas(props: {
 function OpenAPIRootSchemasSchema(props: {
     schemas: OpenAPISchemasData['schemas'];
     context: OpenAPIClientContext;
+    grouped?: boolean;
 }) {
-    const { schemas, context } = props;
+    const { schemas, context, grouped } = props;
 
-    // If there is only one model, we show it directly.
-    if (schemas.length === 1) {
+    // If there is only one model and we are not grouping, we show it directly.
+    if (schemas.length === 1 && !grouped) {
         const schema = schemas?.[0]?.schema;
 
         if (!schema) {

package/src/schemas/resolveOpenAPISchemas.ts

@@ -1,12 +1,7 @@
-import {
-    type Filesystem,
-    type OpenAPIV3,
-    type OpenAPIV3_1,
-    type OpenAPIV3xDocument,
-    shouldIgnoreEntity,
-} from '@gitbook/openapi-parser';
+import type { Filesystem, OpenAPIV3xDocument } from '@gitbook/openapi-parser';
+import { filterSelectedOpenAPISchemas } from '@gitbook/openapi-parser';
 import { dereferenceFilesystem } from '../dereference';
-import type { OpenAPISchema, OpenAPISchemasData } from '../types';
+import type { OpenAPISchemasData } from '../types';
 
 //!!TODO: We should return only the schemas that are used in the block. Still a WIP awaiting future work.
 
@@ -32,26 +27,3 @@ export async function resolveOpenAPISchemas(
 
     return { schemas };
 }
-/**
- * Extract selected schemas from the OpenAPI document.
- */
-export function filterSelectedOpenAPISchemas(
-    schema: OpenAPIV3.Document | OpenAPIV3_1.Document,
-    selectedSchemas: string[]
-): OpenAPISchema[] {
-    const componentsSchemas = schema.components?.schemas ?? {};
-
-    // Preserve the order of the selected schemas
-    return selectedSchemas
-        .map((name) => {
-            const schema = componentsSchemas[name];
-            if (schema && !shouldIgnoreEntity(schema)) {
-                return {
-                    name,
-                    schema,
-                };
-            }
-            return null;
-        })
-        .filter((schema): schema is OpenAPISchema => !!schema);
-}

package/src/types.ts

@@ -1,6 +1,7 @@
 import type {
     OpenAPICustomOperationProperties,
     OpenAPICustomSpecProperties,
+    OpenAPISchema,
     OpenAPIV3,
 } from '@gitbook/openapi-parser';
 
@@ -12,7 +13,11 @@ export interface OpenAPIContextProps extends OpenAPIClientContext {
     /**
      * Render the heading of the operation.
      */
-    renderHeading: (props: { deprecated: boolean; title: string }) => React.ReactNode;
+    renderHeading: (props: {
+        deprecated: boolean;
+        title: string;
+        stability?: string;
+    }) => React.ReactNode;
     /**
      * Render the document of the operation.
      */
@@ -56,11 +61,6 @@ export interface OpenAPIOperationData extends OpenAPICustomSpecProperties {
     securities: [string, OpenAPIV3.SecuritySchemeObject][];
 }
 
-export type OpenAPISchema = {
-    name: string;
-    schema: OpenAPIV3.SchemaObject;
-};
-
 export interface OpenAPISchemasData {
     /** Components schemas to be used for schemas */
     schemas: OpenAPISchema[];