@gitbook/react-openapi 1.1.6 → 1.1.8

package/dist/code-samples.js

@@ -10,6 +10,7 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 import { isCSV, isFormData, isFormUrlEncoded, isGraphQL, isPDF, isPlainObject, isText, isXML, } from './contentTypeChecks';
+import { json2xml } from './json2xml';
 import { stringifyOpenAPI } from './stringifyOpenAPI';
 export var codeSampleGenerators = [
     {
@@ -201,7 +202,11 @@ var BodyGenerators = {
         else if (isText(contentType)) {
             body = "--data '".concat(String(body).replace(/"/g, ''), "'");
         }
-        else if (isXML(contentType) || isCSV(contentType)) {
+        else if (isXML(contentType)) {
+            // Convert to XML and ensure proper formatting
+            body = "--data-binary $'".concat(convertBodyToXML(body), "'");
+        }
+        else if (isCSV(contentType)) {
             // We use --data-binary to avoid cURL converting newlines to \r\n
             body = "--data-binary $'".concat(stringifyOpenAPI(body).replace(/"/g, '').replace(/\\n/g, '\n'), "'");
         }
@@ -285,7 +290,8 @@ var BodyGenerators = {
         }
         else if (isXML(contentType)) {
             code += 'const xml = `\n';
-            code += indent(String(body), 4);
+            // Convert JSON to XML if needed
+            code += indent(convertBodyToXML(body), 4);
             code += '`;\n\n';
             body = 'xml';
         }
@@ -319,6 +325,10 @@ var BodyGenerators = {
             code += '}\n\n';
             body = 'files';
         }
+        if (isXML(contentType)) {
+            // Convert JSON to XML if needed
+            body = convertBodyToXML(body);
+        }
         return { body: body, code: code, headers: headers };
     },
     getHTTPBody: function (body, headers) {
@@ -332,14 +342,18 @@ var BodyGenerators = {
                     ? Object.entries(body)
                         .map(function (_a) {
                         var key = _a[0], value = _a[1];
-                        return "".concat(key, "=").concat(String(value));
+                        return "".concat(key, "=").concat(stringifyOpenAPI(value));
                     })
                         .join('&')
-                    : String(body);
-                return "\"".concat(encoded, "\"");
+                    : stringifyOpenAPI(body);
+                return "\"".concat(encoded.replace(/"/g, "'"), "\"");
             },
             text: function () { return "\"".concat(String(body), "\""); },
-            xmlOrCsv: function () { return "\"".concat(stringifyOpenAPI(body).replace(/"/g, ''), "\""); },
+            xml: function () {
+                // Convert JSON to XML if needed
+                return "\"".concat(convertBodyToXML(body), "\"");
+            },
+            csv: function () { return "\"".concat(stringifyOpenAPI(body).replace(/"/g, ''), "\""); },
             default: function () { return "".concat(stringifyOpenAPI(body, null, 2)); },
         };
         if (isPDF(contentType))
@@ -348,9 +362,30 @@ var BodyGenerators = {
             return typeHandlers.formUrlEncoded();
         if (isText(contentType))
             return typeHandlers.text();
-        if (isXML(contentType) || isCSV(contentType)) {
-            return typeHandlers.xmlOrCsv();
-        }
+        if (isXML(contentType))
+            return typeHandlers.xml();
+        if (isCSV(contentType))
+            return typeHandlers.csv();
         return typeHandlers.default();
     },
 };
+/**
+ * Converts a body to XML format
+ */
+function convertBodyToXML(body) {
+    // If body is already a string and looks like XML, return it as is
+    if (typeof body === 'string' && body.trim().startsWith('<')) {
+        return body;
+    }
+    // If body is not an object, try to parse it as JSON
+    if (typeof body !== 'object' || body === null) {
+        try {
+            body = JSON.parse(body);
+        }
+        catch (_a) {
+            // If parsing fails, return the original body
+            return body;
+        }
+    }
+    return json2xml(body).replace(/"/g, '').replace(/\\n/g, '\n').replace(/\\t/g, '\t');
+}

package/dist/decycle.d.ts

@@ -0,0 +1,2 @@
+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/decycle.js

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

package/dist/schemas/OpenAPISchemas.d.ts

@@ -7,5 +7,9 @@ export declare function OpenAPISchemas(props: {
     className?: string;
     data: OpenAPISchemasData;
     context: OpenAPISchemasContextProps;
+    /**
+     * Whether to show the schema directly if there is only one.
+     */
+    grouped?: boolean;
 }): import("react").JSX.Element | null;
 export {};

package/dist/schemas/OpenAPISchemas.jsx

@@ -1,12 +1,12 @@
 import clsx from 'clsx';
 import { OpenAPIDisclosureGroup } from '../OpenAPIDisclosureGroup';
-import { OpenAPIRootSchema } from '../OpenAPISchema';
+import { OpenAPIRootSchema } from '../OpenAPISchemaServer';
 import { Section, SectionBody } from '../StaticSection';
 /**
  * Display OpenAPI Schemas.
  */
 export function OpenAPISchemas(props) {
-    var className = props.className, data = props.data, context = props.context;
+    var className = props.className, data = props.data, context = props.context, grouped = props.grouped;
     var schemas = data.schemas;
     var clientContext = {
         defaultInteractiveOpened: context.defaultInteractiveOpened,
@@ -17,7 +17,7 @@ export function OpenAPISchemas(props) {
         return null;
     }
     return (<div className={clsx('openapi-schemas', className)}>
-            <OpenAPIRootSchemasSchema schemas={schemas} context={clientContext}/>
+            <OpenAPIRootSchemasSchema grouped={grouped} schemas={schemas} context={clientContext}/>
         </div>);
 }
 /**
@@ -26,9 +26,9 @@ export function OpenAPISchemas(props) {
  */
 function OpenAPIRootSchemasSchema(props) {
     var _a;
-    var schemas = props.schemas, context = props.context;
-    // If there is only one model, we show it directly.
-    if (schemas.length === 1) {
+    var schemas = props.schemas, context = props.context, grouped = props.grouped;
+    // If there is only one model and we are not grouping, we show it directly.
+    if (schemas.length === 1 && !grouped) {
         var schema = (_a = schemas === null || schemas === void 0 ? void 0 : schemas[0]) === null || _a === void 0 ? void 0 : _a.schema;
         if (!schema) {
             return null;

package/dist/schemas/resolveOpenAPISchemas.d.ts

@@ -1,5 +1,5 @@
-import { type Filesystem, type OpenAPIV3, type OpenAPIV3_1, type OpenAPIV3xDocument } from '@gitbook/openapi-parser';
-import type { OpenAPISchema, OpenAPISchemasData } from '../types';
+import type { Filesystem, OpenAPIV3xDocument } from '@gitbook/openapi-parser';
+import type { OpenAPISchemasData } from '../types';
 /**
  * Resolve an OpenAPI schemas from a file and compile it to a more usable format.
  * Schemas are extracted from the OpenAPI components.schemas
@@ -7,7 +7,3 @@ import type { OpenAPISchema, OpenAPISchemasData } from '../types';
 export declare function resolveOpenAPISchemas(filesystem: Filesystem<OpenAPIV3xDocument>, options: {
     schemas: string[];
 }): Promise<OpenAPISchemasData | null>;
-/**
- * Extract selected schemas from the OpenAPI document.
- */
-export declare function filterSelectedOpenAPISchemas(schema: OpenAPIV3.Document | OpenAPIV3_1.Document, selectedSchemas: string[]): OpenAPISchema[];

package/dist/schemas/resolveOpenAPISchemas.js

@@ -34,7 +34,7 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
-import { shouldIgnoreEntity, } from '@gitbook/openapi-parser';
+import { filterSelectedOpenAPISchemas } from '@gitbook/openapi-parser';
 import { dereferenceFilesystem } from '../dereference';
 //!!TODO: We should return only the schemas that are used in the block. Still a WIP awaiting future work.
 /**
@@ -60,23 +60,3 @@ export function resolveOpenAPISchemas(filesystem, options) {
         });
     });
 }
-/**
- * Extract selected schemas from the OpenAPI document.
- */
-export function filterSelectedOpenAPISchemas(schema, selectedSchemas) {
-    var _a, _b;
-    var componentsSchemas = (_b = (_a = schema.components) === null || _a === void 0 ? void 0 : _a.schemas) !== null && _b !== void 0 ? _b : {};
-    // Preserve the order of the selected schemas
-    return selectedSchemas
-        .map(function (name) {
-        var schema = componentsSchemas[name];
-        if (schema && !shouldIgnoreEntity(schema)) {
-            return {
-                name: name,
-                schema: schema,
-            };
-        }
-        return null;
-    })
-        .filter(function (schema) { return !!schema; });
-}