@gitbook/react-openapi 1.4.2 → 1.5.1

package/src/context.ts

@@ -1,99 +0,0 @@
-import { type Translation, type TranslationLocale, translations } from './translations';
-
-export interface OpenAPIClientContext {
-    /**
-     * The translation language to use.
-     */
-    translation: Translation;
-
-    /**
-     * Icons used in the block.
-     */
-    icons: {
-        chevronDown: React.ReactNode;
-        chevronRight: React.ReactNode;
-        plus: React.ReactNode;
-    };
-
-    /**
-     * Force all sections to be opened by default.
-     * @default false
-     */
-    defaultInteractiveOpened?: boolean;
-
-    /**
-     * The key of the block
-     */
-    blockKey?: string;
-
-    /**
-     * Optional id attached to the heading and used as an anchor.
-     */
-    id?: string;
-
-    /**
-     * Mark the context as a client context.
-     */
-    $$isClientContext$$: true;
-}
-
-export interface OpenAPIContext extends Omit<OpenAPIClientContext, '$$isClientContext$$'> {
-    /**
-     * Render a code block.
-     */
-    renderCodeBlock: (props: { code: string; syntax: string }) => React.ReactNode;
-
-    /**
-     * Render the heading of the operation.
-     */
-    renderHeading: (props: {
-        deprecated: boolean;
-        title: string;
-        stability?: string;
-    }) => React.ReactNode;
-
-    /**
-     * Render the document of the operation.
-     */
-    renderDocument: (props: { document: object }) => React.ReactNode;
-
-    /**
-     * Specification URL.
-     */
-    specUrl: string;
-}
-
-export type OpenAPIUniversalContext = OpenAPIClientContext | OpenAPIContext;
-
-export interface OpenAPIContextInput extends Omit<OpenAPIContext, 'translation'> {
-    /**
-     * The translation language to use.
-     * @default 'en'
-     */
-    locale?: TranslationLocale | undefined;
-}
-
-/**
- * Resolve OpenAPI context from the input.
- */
-export function resolveOpenAPIContext(context: OpenAPIContextInput): OpenAPIContext {
-    const { locale, ...rest } = context;
-    return {
-        ...rest,
-        translation: translations[locale ?? 'en'],
-    };
-}
-
-/**
- * Get the client context from the OpenAPI context.
- */
-export function getOpenAPIClientContext(context: OpenAPIUniversalContext): OpenAPIClientContext {
-    return {
-        translation: context.translation,
-        icons: context.icons,
-        defaultInteractiveOpened: context.defaultInteractiveOpened,
-        blockKey: context.blockKey,
-        id: context.id,
-        $$isClientContext$$: true,
-    };
-}

package/src/decycle.ts

@@ -1,68 +0,0 @@
-// 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/dereference.ts

@@ -1,29 +0,0 @@
-import { type Filesystem, type OpenAPIV3xDocument, dereference } from '@gitbook/openapi-parser';
-
-const dereferenceCache = new WeakMap<Filesystem, Promise<OpenAPIV3xDocument>>();
-
-/**
- * Memoized version of `dereferenceSchema`.
- */
-export function dereferenceFilesystem(filesystem: Filesystem): Promise<OpenAPIV3xDocument> {
-    if (dereferenceCache.has(filesystem)) {
-        return dereferenceCache.get(filesystem) as Promise<OpenAPIV3xDocument>;
-    }
-
-    const promise = baseDereferenceFilesystem(filesystem);
-    dereferenceCache.set(filesystem, promise);
-    return promise;
-}
-
-/**
- * Dereference an OpenAPI schema.
- */
-async function baseDereferenceFilesystem(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;
-}