@gitbook/react-openapi 1.1.5 → 1.1.7

package/src/code-samples.test.ts

@@ -110,6 +110,23 @@ describe('curL code sample generator', () => {
         );
     });
 
+    it('should convert json to xml body properly', () => {
+        const input: CodeSampleInput = {
+            method: 'GET',
+            url: 'https://example.com/path',
+            headers: {
+                'Content-Type': 'application/xml',
+            },
+            body: '{ "key": "value" }',
+        };
+
+        const output = generator?.generate(input);
+
+        expect(output).toBe(
+            "curl -L \\\n  --url 'https://example.com/path' \\\n  --header 'Content-Type: application/xml' \\\n  --data-binary $'<?xml version=1.0?>\n  <key>value</key>\n  '"
+        );
+    });
+
     it('should format application/graphql body properly', () => {
         const input: CodeSampleInput = {
             method: 'GET',
@@ -258,6 +275,23 @@ describe('javascript code sample generator', () => {
         );
     });
 
+    it('should convert json to xml body properly', () => {
+        const input: CodeSampleInput = {
+            method: 'GET',
+            url: 'https://example.com/path',
+            headers: {
+                'Content-Type': 'application/xml',
+            },
+            body: '{ "key": "value" }',
+        };
+
+        const output = generator?.generate(input);
+
+        expect(output).toBe(
+            'const xml = `\n    <?xml version=1.0?>\n    <key>value</key>\n`;\n\nconst response = await fetch(\'https://example.com/path\', {\n    method: \'GET\',\n    headers: {\n      "Content-Type": "application/xml"\n    },\n    body: xml\n});\n\nconst data = await response.json();'
+        );
+    });
+
     it('should format application/graphql body properly', () => {
         const input: CodeSampleInput = {
             method: 'GET',
@@ -406,6 +440,23 @@ describe('python code sample generator', () => {
         );
     });
 
+    it('should convert json to xml body properly', () => {
+        const input: CodeSampleInput = {
+            method: 'GET',
+            url: 'https://example.com/path',
+            headers: {
+                'Content-Type': 'application/xml',
+            },
+            body: '{ "key": "value" }',
+        };
+
+        const output = generator?.generate(input);
+
+        expect(output).toBe(
+            'import requests\n\nresponse = requests.get(\n    "https://example.com/path",\n    headers={"Content-Type":"application/xml"},\n    data="<?xml version=1.0?>\\n<key>value</key>\\n"\n)\n\ndata = response.json()'
+        );
+    });
+
     it('should format application/graphql body properly', () => {
         const input: CodeSampleInput = {
             method: 'GET',
@@ -514,7 +565,7 @@ describe('http code sample generator', () => {
         const output = generator?.generate(input);
 
         expect(output).toBe(
-            'GET /path HTTP/1.1\nHost: example.com\nContent-Type: application/x-www-form-urlencoded\nContent-Length: 15\nAccept: */*\n\n"key=value"'
+            'GET /path HTTP/1.1\nHost: example.com\nContent-Type: application/x-www-form-urlencoded\nContent-Length: 15\nAccept: */*\n\n"key=\'value\'"'
         );
     });
 
@@ -554,6 +605,23 @@ describe('http code sample generator', () => {
         );
     });
 
+    it('should convert json to xml body properly', () => {
+        const input: CodeSampleInput = {
+            method: 'GET',
+            url: 'https://example.com/path',
+            headers: {
+                'Content-Type': 'application/xml',
+            },
+            body: '{ "key": "value" }',
+        };
+
+        const output = generator?.generate(input);
+
+        expect(output).toBe(
+            'GET /path HTTP/1.1\nHost: example.com\nContent-Type: application/xml\nContent-Length: 24\nAccept: */*\n\n"<?xml version=1.0?>\n<key>value</key>\n"'
+        );
+    });
+
     it('should format application/graphql body properly', () => {
         const input: CodeSampleInput = {
             method: 'GET',

package/src/code-samples.ts

@@ -8,6 +8,7 @@ import {
     isText,
     isXML,
 } from './contentTypeChecks';
+import { json2xml } from './json2xml';
 import { stringifyOpenAPI } from './stringifyOpenAPI';
 
 export interface CodeSampleInput {
@@ -17,7 +18,7 @@ export interface CodeSampleInput {
     body?: any;
 }
 
-interface CodeSampleGenerator {
+export interface CodeSampleGenerator {
     id: string;
     label: string;
     syntax: string;
@@ -238,9 +239,12 @@ const BodyGenerators = {
                 : String(body);
         } else if (isText(contentType)) {
             body = `--data '${String(body).replace(/"/g, '')}'`;
-        } else if (isXML(contentType) || isCSV(contentType)) {
+        } else if (isXML(contentType)) {
+            // Convert to XML and ensure proper formatting
+            body = `--data-binary $'${convertBodyToXML(body)}'`;
+        } else if (isCSV(contentType)) {
             // We use --data-binary to avoid cURL converting newlines to \r\n
-            body = `--data-binary $'${stringifyOpenAPI(body).replace(/"/g, '')}'`;
+            body = `--data-binary $'${stringifyOpenAPI(body).replace(/"/g, '').replace(/\\n/g, '\n')}'`;
         } else if (isGraphQL(contentType)) {
             body = `--data '${stringifyOpenAPI(body)}'`;
             // Set Content-Type to application/json for GraphQL, recommended by GraphQL spec
@@ -249,7 +253,7 @@ const BodyGenerators = {
             // We use --data-binary to avoid cURL converting newlines to \r\n
             body = `--data-binary '@${String(body)}'`;
         } else {
-            body = `--data '${stringifyOpenAPI(body, null, 2)}'`;
+            body = `--data '${stringifyOpenAPI(body, null, 2).replace(/\\n/g, '\n')}'`;
         }
 
         return {
@@ -312,7 +316,9 @@ const BodyGenerators = {
             body = 'formData';
         } 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';
         } else if (isText(contentType)) {
@@ -346,6 +352,11 @@ const BodyGenerators = {
             body = 'files';
         }
 
+        if (isXML(contentType)) {
+            // Convert JSON to XML if needed
+            body = convertBodyToXML(body);
+        }
+
         return { body, code, headers };
     },
     getHTTPBody: (body: any, headers?: Record<string, string>) => {
@@ -358,23 +369,48 @@ const BodyGenerators = {
             formUrlEncoded: () => {
                 const encoded = isPlainObject(body)
                     ? Object.entries(body)
-                          .map(([key, value]) => `${key}=${String(value)}`)
+                          .map(([key, value]) => `${key}=${stringifyOpenAPI(value)}`)
                           .join('&')
-                    : String(body);
-                return `"${encoded}"`;
+                    : stringifyOpenAPI(body);
+                return `"${encoded.replace(/"/g, "'")}"`;
             },
             text: () => `"${String(body)}"`,
-            xmlOrCsv: () => `"${stringifyOpenAPI(body).replace(/"/g, '')}"`,
+            xml: () => {
+                // Convert JSON to XML if needed
+                return `"${convertBodyToXML(body)}"`;
+            },
+            csv: () => `"${stringifyOpenAPI(body).replace(/"/g, '')}"`,
             default: () => `${stringifyOpenAPI(body, null, 2)}`,
         };
 
         if (isPDF(contentType)) return typeHandlers.pdf();
         if (isFormUrlEncoded(contentType)) 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: any): string {
+    // 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 {
+            // If parsing fails, return the original body
+            return body;
+        }
+    }
+
+    return json2xml(body).replace(/"/g, '').replace(/\\n/g, '\n').replace(/\\t/g, '\t');
+}

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;
+    };
+}