@gitbook/react-openapi 1.4.3 → 1.5.2

package/dist/common/OpenAPIColumnSpec.jsx

@@ -1,20 +0,0 @@
-import { OpenAPISpec } from '../OpenAPISpec';
-import { getOpenAPIClientContext } from '../context';
-import { t } from '../translate';
-import { OpenAPIOperationDescription } from './OpenAPIOperationDescription';
-export function OpenAPIColumnSpec(props) {
-    var data = props.data, context = props.context;
-    var operation = data.operation;
-    var clientContext = getOpenAPIClientContext(context);
-    return (<div className="openapi-column-spec">
-            {operation['x-deprecated-sunset'] ? (<div className="openapi-deprecated-sunset openapi-description openapi-markdown">
-                    {t(context.translation, 'deprecated_and_sunset_on', [
-                <span key="date" className="openapi-deprecated-sunset-date">
-                            {operation['x-deprecated-sunset']}
-                        </span>,
-            ])}
-                </div>) : null}
-            <OpenAPIOperationDescription operation={operation} context={context}/>
-            <OpenAPISpec data={data} context={clientContext}/>
-        </div>);
-}

package/dist/common/OpenAPIOperationDescription.d.ts

@@ -1,6 +0,0 @@
-import type { OpenAPICustomOperationProperties, OpenAPIV3 } from '@gitbook/openapi-parser';
-import type { OpenAPIContext } from '../context';
-export declare function OpenAPIOperationDescription(props: {
-    operation: OpenAPIV3.OperationObject<OpenAPICustomOperationProperties>;
-    context: OpenAPIContext;
-}): import("react").JSX.Element | null;

package/dist/common/OpenAPIOperationDescription.jsx

@@ -1,19 +0,0 @@
-import { Markdown } from '../Markdown';
-import { resolveDescription } from '../utils';
-export function OpenAPIOperationDescription(props) {
-    var operation = props.operation;
-    if (operation['x-gitbook-description-document']) {
-        return (<div className="openapi-intro">
-                {props.context.renderDocument({
-                document: operation['x-gitbook-description-document'],
-            })}
-            </div>);
-    }
-    var description = resolveDescription(operation);
-    if (!description) {
-        return null;
-    }
-    return (<div className="openapi-intro">
-            <Markdown className="openapi-description" source={description}/>
-        </div>);
-}

package/dist/common/OpenAPIStability.d.ts

@@ -1,4 +0,0 @@
-import type { OpenAPIStability as OpenAPIStabilityType } from '@gitbook/openapi-parser';
-export declare function OpenAPIStability(props: {
-    stability: OpenAPIStabilityType;
-}): import("react").JSX.Element | null;

package/dist/common/OpenAPIStability.jsx

@@ -1,15 +0,0 @@
-var stabilityEnum = {
-    experimental: 'Experimental',
-    alpha: 'Alpha',
-    beta: 'Beta',
-};
-export function OpenAPIStability(props) {
-    var stability = props.stability;
-    var foundStability = stabilityEnum[stability];
-    if (!foundStability) {
-        return null;
-    }
-    return (<div className={"openapi-stability openapi-stability-".concat(foundStability.toLowerCase())}>
-            {foundStability}
-        </div>);
-}

package/dist/common/OpenAPISummary.d.ts

@@ -1,6 +0,0 @@
-import type { OpenAPIContext } from '../context';
-import type { OpenAPIOperationData, OpenAPIWebhookData } from '../types';
-export declare function OpenAPISummary(props: {
-    data: OpenAPIOperationData | OpenAPIWebhookData;
-    context: OpenAPIContext;
-}): import("react").JSX.Element;

package/dist/common/OpenAPISummary.jsx

@@ -1,30 +0,0 @@
-import { OpenAPIPath } from '../OpenAPIPath';
-import { OpenAPIStability } from './OpenAPIStability';
-export function OpenAPISummary(props) {
-    var _a;
-    var data = props.data, context = props.context;
-    var operation = data.operation;
-    var title = (function () {
-        if (operation.summary) {
-            return operation.summary;
-        }
-        if ('name' in data) {
-            return data.name;
-        }
-        return undefined;
-    })();
-    return (<div className="openapi-summary" id={operation.summary ? undefined : context.id}>
-            {(operation.deprecated || operation['x-stability']) && (<div className="openapi-summary-tags">
-                    {operation.deprecated && <div className="openapi-deprecated">Deprecated</div>}
-                    {operation['x-stability'] && (<OpenAPIStability stability={operation['x-stability']}/>)}
-                </div>)}
-            {title
-            ? context.renderHeading({
-                deprecated: (_a = operation.deprecated) !== null && _a !== void 0 ? _a : false,
-                stability: operation['x-stability'],
-                title: title,
-            })
-            : null}
-            {'path' in data ? <OpenAPIPath data={data} context={context}/> : null}
-        </div>);
-}

package/dist/contentTypeChecks.d.ts

@@ -1,10 +0,0 @@
-export declare function isJSON(contentType?: string): boolean;
-export declare function isXML(contentType?: string): boolean;
-export declare function isYAML(contentType?: string): boolean;
-export declare function isGraphQL(contentType?: string): boolean;
-export declare function isCSV(contentType?: string): boolean;
-export declare function isPDF(contentType?: string): boolean;
-export declare function isText(contentType?: string): boolean;
-export declare function isFormUrlEncoded(contentType?: string): boolean;
-export declare function isFormData(contentType?: string): boolean;
-export declare function isPlainObject(value: unknown): boolean;

package/dist/decycle.d.ts

@@ -1,2 +0,0 @@
-export declare const decycle: () => (this: any, key: string | symbol, value: any) => any;
-export declare function retrocycle(): (this: object, key: string | symbol, value: any) => any;

package/dist/dereference.d.ts

@@ -1,5 +0,0 @@
-import { type Filesystem, type OpenAPIV3xDocument } from '@gitbook/openapi-parser';
-/**
- * Memoized version of `dereferenceSchema`.
- */
-export declare function dereferenceFilesystem(filesystem: Filesystem): Promise<OpenAPIV3xDocument>;

package/dist/generateSchemaExample.d.ts

@@ -1,45 +0,0 @@
-import type { OpenAPIV3 } from '@gitbook/openapi-parser';
-type JSONValue = string | number | boolean | null | JSONValue[] | {
-    [key: string]: JSONValue;
-};
-type ScalarGetExampleFromSchemaOptions = NonNullable<Parameters<typeof getExampleFromSchema>[1]>;
-type GenerateSchemaExampleOptions = Pick<ScalarGetExampleFromSchemaOptions, 'xml' | 'omitEmptyAndOptionalProperties' | 'mode'>;
-/**
- * Generate a JSON example from a schema
- */
-export declare function generateSchemaExample(schema: OpenAPIV3.SchemaObject, options?: GenerateSchemaExampleOptions): JSONValue | undefined;
-/**
- * Generate an example for a media type.
- */
-export declare function generateMediaTypeExamples(mediaType: OpenAPIV3.MediaTypeObject, options?: GenerateSchemaExampleOptions): OpenAPIV3.ExampleObject[];
-/**
- * This function takes an OpenAPI schema and generates an example from it
- * Forked from : https://github.com/scalar/scalar/blob/main/packages/oas-utils/src/spec-getters/getExampleFromSchema.ts
- */
-declare const getExampleFromSchema: (schema: Record<string, any>, options?: {
-    /**
-     * The fallback string for empty string values.
-     * @default ''
-     */
-    emptyString?: string;
-    /**
-     * Whether to use the XML tag names as keys
-     * @default false
-     */
-    xml?: boolean;
-    /**
-     * Whether to show read-only/write-only properties. Otherwise all properties are shown.
-     * @default undefined
-     */
-    mode?: "read" | "write";
-    /**
-     * Dynamic values to add to the example.
-     */
-    variables?: Record<string, any>;
-    /**
-     * Whether to omit empty and optional properties.
-     * @default false
-     */
-    omitEmptyAndOptionalProperties?: boolean;
-}, level?: number, parentSchema?: Record<string, any>, name?: string, resultCache?: WeakMap<Record<string, any>, any>) => any;
-export {};

package/dist/getDisclosureLabel.d.ts

@@ -1,7 +0,0 @@
-import type { OpenAPIV3 } from '@gitbook/openapi-parser';
-import type { OpenAPIClientContext } from './context';
-export declare function getDisclosureLabel(props: {
-    schema: OpenAPIV3.SchemaObject;
-    isExpanded: boolean;
-    context: OpenAPIClientContext;
-}): string;

package/dist/getOrCreateStoreByKey.d.ts

@@ -1,10 +0,0 @@
-type Key = string | number;
-type State = {
-    key: Key | null;
-};
-type Actions = {
-    setKey: (key: Key | null) => void;
-};
-export type Store = State & Actions;
-export declare const getOrCreateStoreByKey: (storeKey: string, initialKey?: Key) => import("zustand").StoreApi<Store>;
-export {};

package/dist/json2xml.d.ts

@@ -1,4 +0,0 @@
-/**
- * This function converts an object to XML.
- */
-export declare function json2xml(data: Record<string, any>): string;

package/dist/schemas/OpenAPISchemaItem.d.ts

@@ -1,7 +0,0 @@
-import type { OpenAPIV3 } from '@gitbook/openapi-parser';
-import type { OpenAPIClientContext } from '../context';
-export declare function OpenAPISchemaItem(props: {
-    name: string;
-    schema: OpenAPIV3.SchemaObject;
-    context: OpenAPIClientContext;
-}): import("react").JSX.Element;

package/dist/schemas/OpenAPISchemaItem.jsx

@@ -1,16 +0,0 @@
-'use client';
-import { SectionBody } from '../StaticSection';
-import { OpenAPIDisclosure } from '../OpenAPIDisclosure';
-import { OpenAPIRootSchema } from '../OpenAPISchemaServer';
-import { Section } from '../StaticSection';
-import { getDisclosureLabel } from '../getDisclosureLabel';
-export function OpenAPISchemaItem(props) {
-    var schema = props.schema, context = props.context, name = props.name;
-    return (<OpenAPIDisclosure className="openapi-schemas-disclosure" key={name} icon={context.icons.plus} header={name} label={function (isExpanded) { return getDisclosureLabel({ schema: schema, isExpanded: isExpanded, context: context }); }}>
-            <Section className="openapi-section-schemas">
-                <SectionBody>
-                    <OpenAPIRootSchema schema={schema} context={context}/>
-                </SectionBody>
-            </Section>
-        </OpenAPIDisclosure>);
-}

package/dist/schemas/OpenAPISchemas.jsx

@@ -1,59 +0,0 @@
-import clsx from 'clsx';
-import { OpenAPIExample } from '../OpenAPIExample';
-import { OpenAPIRootSchema } from '../OpenAPISchemaServer';
-import { StaticSection } from '../StaticSection';
-import { getOpenAPIClientContext, resolveOpenAPIContext, } from '../context';
-import { t } from '../translate';
-import { getExampleFromSchema } from '../util/example';
-import { OpenAPISchemaItem } from './OpenAPISchemaItem';
-/**
- * OpenAPI Schemas component.
- */
-export function OpenAPISchemas(props) {
-    var schemas = props.schemas, contextInput = props.context, grouped = props.grouped, className = props.className;
-    var firstSchema = schemas[0];
-    if (!firstSchema) {
-        return null;
-    }
-    var context = resolveOpenAPIContext(contextInput);
-    var clientContext = getOpenAPIClientContext(context);
-    // If there is only one model and we are not grouping, we show it directly.
-    if (schemas.length === 1 && !grouped) {
-        var title = "The ".concat(firstSchema.name, " object");
-        return (<div className={clsx('openapi-schemas', className)}>
-                <div className="openapi-summary" id={context.id}>
-                    {context.renderHeading({
-                title: title,
-                deprecated: Boolean(firstSchema.schema.deprecated),
-                stability: firstSchema.schema['x-stability'],
-            })}
-                </div>
-                <div className="openapi-columns">
-                    <div className="openapi-column-spec">
-                        <StaticSection className="openapi-parameters" header={t(context.translation, 'attributes')}>
-                            <OpenAPIRootSchema schema={firstSchema.schema} context={clientContext}/>
-                        </StaticSection>
-                    </div>
-                    <div className="openapi-column-preview">
-                        <div className="openapi-column-preview-body">
-                            <div className="openapi-panel">
-                                <h4 className="openapi-panel-heading">{title}</h4>
-                                <div className="openapi-panel-body">
-                                    <OpenAPIExample example={getExampleFromSchema({
-                schema: firstSchema.schema,
-            })} context={context} syntax="json"/>
-                                </div>
-                            </div>
-                        </div>
-                    </div>
-                </div>
-            </div>);
-    }
-    // If there are multiple schemas, we use a disclosure group to show them all.
-    return (<div className={clsx('openapi-schemas', className)}>
-            {schemas.map(function (_a) {
-            var name = _a.name, schema = _a.schema;
-            return (<OpenAPISchemaItem key={name} name={name} context={clientContext} schema={schema}/>);
-        })}
-        </div>);
-}

package/dist/schemas/index.d.ts

@@ -1,2 +0,0 @@
-export * from './OpenAPISchemas';
-export * from './resolveOpenAPISchemas';

package/dist/schemas/index.js

@@ -1,2 +0,0 @@
-export * from './OpenAPISchemas';
-export * from './resolveOpenAPISchemas';

package/dist/stringifyOpenAPI.d.ts

@@ -1,4 +0,0 @@
-/**
- * Stringify an OpenAPI object. Same API as JSON.stringify.
- */
-export declare function stringifyOpenAPI(value: any, replacer?: ((this: any, key: string, value: any) => any) | null, space?: string | number): string;

package/dist/translate.d.ts

@@ -1,10 +0,0 @@
-import React from 'react';
-import type { Translation, TranslationKey } from './translations';
-/**
- * Translate a string.
- */
-export declare function t(translation: Translation, id: TranslationKey, ...args: React.ReactNode[]): React.ReactNode;
-/**
- * Version of `t` that returns a string.
- */
-export declare function tString(translation: Translation, id: TranslationKey, ...args: React.ReactNode[]): string;

package/dist/translate.jsx

@@ -1,75 +0,0 @@
-var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
-    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
-        if (ar || !(i in from)) {
-            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
-            ar[i] = from[i];
-        }
-    }
-    return to.concat(ar || Array.prototype.slice.call(from));
-};
-import React from 'react';
-/**
- * Translate a string.
- */
-export function t(translation, id) {
-    var args = [];
-    for (var _i = 2; _i < arguments.length; _i++) {
-        args[_i - 2] = arguments[_i];
-    }
-    var string = translation[id];
-    if (!string) {
-        throw new Error("Translation not found for \"".concat(id, "\""));
-    }
-    // Now we are going to replace the arguments
-    // but we want to return a string as long as it's possible
-    // (eg. if there isn't any argument that is a ReactNode)
-    var parts = [];
-    var currentStringToReplace = string;
-    args.forEach(function (arg, i) {
-        if (typeof arg === 'string') {
-            currentStringToReplace = currentStringToReplace.replace("${".concat(i + 1, "}"), arg);
-        }
-        else {
-            var _a = currentStringToReplace.split("${".concat(i + 1, "}")), partToPush = _a[0], partToReplace = _a[1];
-            if (partToPush === undefined || partToReplace === undefined) {
-                throw new Error("Invalid translation \"".concat(id, "\""));
-            }
-            parts.push(<React.Fragment key={"string-".concat(i)}>{partToPush}</React.Fragment>);
-            parts.push(<React.Fragment key={"arg-".concat(i)}>{arg}</React.Fragment>);
-            currentStringToReplace = partToReplace;
-        }
-    });
-    if (!parts.length) {
-        return currentStringToReplace;
-    }
-    return (<>
-            {parts}
-            {currentStringToReplace}
-        </>);
-}
-/**
- * Version of `t` that returns a string.
- */
-export function tString(translation, id) {
-    var args = [];
-    for (var _i = 2; _i < arguments.length; _i++) {
-        args[_i - 2] = arguments[_i];
-    }
-    var result = t.apply(void 0, __spreadArray([translation, id], args, false));
-    return reactToString(result);
-}
-function reactToString(el) {
-    if (typeof el === 'string' || typeof el === 'number' || typeof el === 'boolean') {
-        return "".concat(el);
-    }
-    if (el === null || el === undefined) {
-        return '';
-    }
-    if (Array.isArray(el)) {
-        return el.map(reactToString).join('');
-    }
-    if (typeof el === 'object' && 'props' in el) {
-        return el.props.children.map(reactToString).join('');
-    }
-    throw new Error("Unsupported type ".concat(typeof el));
-}

package/dist/translations/de.d.ts

@@ -1,43 +0,0 @@
-export declare const de: {
-    required: string;
-    deprecated: string;
-    deprecated_and_sunset_on: string;
-    stability_experimental: string;
-    stability_alpha: string;
-    stability_beta: string;
-    copy_to_clipboard: string;
-    copied: string;
-    no_content: string;
-    unresolved_reference: string;
-    circular_reference: string;
-    read_only: string;
-    write_only: string;
-    optional: string;
-    min: string;
-    max: string;
-    nullable: string;
-    body: string;
-    payload: string;
-    headers: string;
-    header: string;
-    authorizations: string;
-    responses: string;
-    response: string;
-    path_parameters: string;
-    query_parameters: string;
-    header_parameters: string;
-    attributes: string;
-    test_it: string;
-    information: string;
-    success: string;
-    redirect: string;
-    error: string;
-    show: string;
-    hide: string;
-    available_items: string;
-    available_scopes: string;
-    properties: string;
-    or: string;
-    and: string;
-    possible_values: string;
-};

package/dist/translations/es.d.ts

@@ -1,43 +0,0 @@
-export declare const es: {
-    required: string;
-    deprecated: string;
-    deprecated_and_sunset_on: string;
-    stability_experimental: string;
-    stability_alpha: string;
-    stability_beta: string;
-    copy_to_clipboard: string;
-    copied: string;
-    no_content: string;
-    unresolved_reference: string;
-    circular_reference: string;
-    read_only: string;
-    write_only: string;
-    optional: string;
-    min: string;
-    max: string;
-    nullable: string;
-    body: string;
-    payload: string;
-    headers: string;
-    header: string;
-    authorizations: string;
-    responses: string;
-    response: string;
-    path_parameters: string;
-    query_parameters: string;
-    header_parameters: string;
-    attributes: string;
-    test_it: string;
-    information: string;
-    success: string;
-    redirect: string;
-    error: string;
-    show: string;
-    hide: string;
-    available_items: string;
-    available_scopes: string;
-    properties: string;
-    or: string;
-    and: string;
-    possible_values: string;
-};

package/dist/translations/fr.d.ts

@@ -1,43 +0,0 @@
-export declare const fr: {
-    required: string;
-    deprecated: string;
-    deprecated_and_sunset_on: string;
-    stability_experimental: string;
-    stability_alpha: string;
-    stability_beta: string;
-    copy_to_clipboard: string;
-    copied: string;
-    no_content: string;
-    unresolved_reference: string;
-    circular_reference: string;
-    read_only: string;
-    write_only: string;
-    optional: string;
-    min: string;
-    max: string;
-    nullable: string;
-    body: string;
-    payload: string;
-    headers: string;
-    header: string;
-    authorizations: string;
-    responses: string;
-    response: string;
-    path_parameters: string;
-    query_parameters: string;
-    header_parameters: string;
-    attributes: string;
-    test_it: string;
-    information: string;
-    success: string;
-    redirect: string;
-    error: string;
-    show: string;
-    hide: string;
-    available_items: string;
-    available_scopes: string;
-    properties: string;
-    or: string;
-    and: string;
-    possible_values: string;
-};

package/dist/translations/ja.d.ts

@@ -1,43 +0,0 @@
-export declare const ja: {
-    required: string;
-    deprecated: string;
-    deprecated_and_sunset_on: string;
-    stability_experimental: string;
-    stability_alpha: string;
-    stability_beta: string;
-    copy_to_clipboard: string;
-    copied: string;
-    no_content: string;
-    unresolved_reference: string;
-    circular_reference: string;
-    read_only: string;
-    write_only: string;
-    optional: string;
-    min: string;
-    max: string;
-    nullable: string;
-    body: string;
-    payload: string;
-    headers: string;
-    header: string;
-    authorizations: string;
-    responses: string;
-    response: string;
-    path_parameters: string;
-    query_parameters: string;
-    header_parameters: string;
-    attributes: string;
-    test_it: string;
-    information: string;
-    success: string;
-    redirect: string;
-    error: string;
-    show: string;
-    hide: string;
-    available_items: string;
-    available_scopes: string;
-    properties: string;
-    or: string;
-    and: string;
-    possible_values: string;
-};

package/dist/translations/nl.d.ts

@@ -1,43 +0,0 @@
-export declare const nl: {
-    required: string;
-    deprecated: string;
-    deprecated_and_sunset_on: string;
-    stability_experimental: string;
-    stability_alpha: string;
-    stability_beta: string;
-    copy_to_clipboard: string;
-    copied: string;
-    no_content: string;
-    unresolved_reference: string;
-    circular_reference: string;
-    read_only: string;
-    write_only: string;
-    optional: string;
-    min: string;
-    max: string;
-    nullable: string;
-    body: string;
-    payload: string;
-    headers: string;
-    header: string;
-    authorizations: string;
-    responses: string;
-    response: string;
-    path_parameters: string;
-    query_parameters: string;
-    header_parameters: string;
-    attributes: string;
-    test_it: string;
-    information: string;
-    success: string;
-    redirect: string;
-    error: string;
-    show: string;
-    hide: string;
-    available_items: string;
-    available_scopes: string;
-    properties: string;
-    or: string;
-    and: string;
-    possible_values: string;
-};

package/dist/translations/no.d.ts

@@ -1,43 +0,0 @@
-export declare const no: {
-    required: string;
-    deprecated: string;
-    deprecated_and_sunset_on: string;
-    stability_experimental: string;
-    stability_alpha: string;
-    stability_beta: string;
-    copy_to_clipboard: string;
-    copied: string;
-    no_content: string;
-    unresolved_reference: string;
-    circular_reference: string;
-    read_only: string;
-    write_only: string;
-    optional: string;
-    min: string;
-    max: string;
-    nullable: string;
-    body: string;
-    payload: string;
-    headers: string;
-    header: string;
-    authorizations: string;
-    responses: string;
-    response: string;
-    path_parameters: string;
-    query_parameters: string;
-    header_parameters: string;
-    attributes: string;
-    test_it: string;
-    information: string;
-    success: string;
-    redirect: string;
-    error: string;
-    show: string;
-    hide: string;
-    available_items: string;
-    available_scopes: string;
-    properties: string;
-    or: string;
-    and: string;
-    possible_values: string;
-};