feat: add support xml samples

Author: AlexVarchuk

package-lock.json

@@ -67,6 +67,7 @@
   },
   "dependencies": {
     "@types/json-schema": "^7.0.7",
+    "fast-xml-parser": "^4.5.0",
     "json-pointer": "0.6.2"
   },
   "overrides": {

package.json

@@ -1,5 +1,13 @@
 import { traverse, clearCache } from './traverse';
 import { sampleArray, sampleBoolean, sampleNumber, sampleObject, sampleString } from './samplers/index';
+import { XMLBuilder } from 'fast-xml-parser';
+
+const builder = new XMLBuilder({
+  ignoreAttributes : false,
+  format: true,
+  attributeNamePrefix: '$',
+  textNodeName: '#text',
+});
 
 export var _samplers = {};
 
@@ -11,7 +19,14 @@ const defaults = {
 export function sample(schema, options, spec) {
   let opts = Object.assign({}, defaults, options);
   clearCache();
-  return traverse(schema, opts, spec).value;
+  let result = traverse(schema, opts, spec).value;
+  if (opts.format === 'xml') {
+    if (Object.keys(result).length > 1) {
+      result = { [schema?.xml?.name || 'root']: result };
+    }
+    return builder.build(result);
+  }
+  return result;
 };
 
 export function _registerSampler(type, sampler) {

src/openapi-sampler.js

@@ -1,4 +1,6 @@
 import { traverse } from '../traverse';
+import { applyXMLAttributes } from '../utils';
+
 export function sampleArray(schema, options = {}, spec, context) {
   const depth = (context && context.depth || 1);
 
@@ -22,7 +24,19 @@ export function sampleArray(schema, options = {}, spec, context) {
   for (let i = 0; i < arrayLength; i++) {
     let itemSchema = itemSchemaGetter(i);
     let { value: sample } = traverse(itemSchema, options, spec, {depth: depth + 1});
-    res.push(sample);
+    if (options?.format === 'xml') {
+      const { value, propertyName } = applyXMLAttributes({value: sample}, itemSchema);
+      if (propertyName) {
+        if (!res?.[propertyName]) {
+          res = { ...res, [propertyName]: [] };
+        }
+        res[propertyName].push(value);
+      } else {
+        res.push(sample);
+      }
+    } else {
+      res.push(sample);
+    }
   }
   return res;
 }

src/samplers/array.js

@@ -1,4 +1,6 @@
 import { traverse } from '../traverse';
+import { applyXMLAttributes } from '../utils';
+
 export function sampleObject(schema, options = {}, spec, context) {
   let res = {};
   const depth = (context && context.depth || 1);
@@ -27,7 +29,17 @@ export function sampleObject(schema, options = {}, spec, context) {
       if (options.skipWriteOnly && sample.writeOnly) {
         return;
       }
-      res[propertyName] = sample.value;
+
+      if (options?.format === 'xml') {
+        const { propertyName: newPropertyName, value } = applyXMLAttributes(sample, schema.properties[propertyName], {propertyName});
+        if (newPropertyName) {
+          res[newPropertyName] = value;
+        } else {
+          res = { ...res, ...value };
+        }
+      } else {
+        res[sample.propertyName] = sample.value;
+      }
     });
   }
 

src/samplers/object.js

@@ -71,6 +71,59 @@ export function popSchemaStack(seenSchemasStack, context) {
   if (context) seenSchemasStack.pop();
 }
 
+export function getXMLAttributes(schema) {
+  return {
+    name: schema?.xml?.name || '',
+    prefix: schema?.xml?.prefix || '',
+    namespace: schema?.xml?.namespace || null,
+    attribute: schema?.xml?.attribute ?? false,
+    wrapped: schema?.xml?.wrapped ?? false,
+  };
+}
+
+export function applyXMLAttributes(result, schema, context) {
+  const { value: oldValue } = result;
+  const { propertyName: oldPropertyName } = context || {};
+  const { name, prefix, namespace, attribute, wrapped } =
+    getXMLAttributes(schema);
+  let propertyName = name || oldPropertyName ? `${prefix ? prefix + ':' : ''}${name || oldPropertyName}` : null;
+
+  let value = typeof oldValue === 'object'
+    ? Array.isArray(oldValue)
+    ? [...oldValue]
+    : { ...oldValue }
+    : oldValue;
+
+  if (attribute && propertyName) {
+    propertyName = `$${propertyName}`;
+  }
+
+  if (namespace) {
+    if (typeof value === 'object') {
+      value[`$xmlns${prefix ? ':' + prefix : ''}`] = namespace;
+    } else {
+      value = { [`$xmlns${prefix ? ':' + prefix : ''}`]: namespace, ['#text']: value };
+    }
+  }
+
+  if (schema.type === 'array') {
+    if (wrapped && Array.isArray(value)) {
+      value = { [propertyName]: [...value] };
+    } else if (!wrapped) {
+      propertyName = null;
+    }
+
+    if (schema.example !== undefined && !wrapped) {
+      propertyName = schema.items.xml?.name || propertyName;
+    }
+  }
+
+  return {
+    propertyName,
+    value,
+  };
+}
+
 function hashCode(str) {
   var hash = 0;
   if (str.length == 0) return hash;