@scalar/oas-utils 0.2.140 → 0.2.141

package/dist/spec-getters/get-example-from-schema.js

@@ -1,282 +1,220 @@
-/** Hard limit for rendering circular references */
 const MAX_LEVELS_DEEP = 5;
-/** Sets the max number of properties after the third level to prevent exponential horizontal growth */
 const MAX_PROPERTIES = 10;
 const genericExampleValues = {
-    // 'date-time': '1970-01-01T00:00:00Z',
-    'date-time': new Date().toISOString(),
-    // 'date': '1970-01-01',
-    'date': new Date().toISOString().split('T')[0],
-    'email': 'hello@example.com',
-    'hostname': 'example.com',
-    // https://tools.ietf.org/html/rfc6531#section-3.3
-    'idn-email': 'jane.doe@example.com',
-    // https://tools.ietf.org/html/rfc5890#section-2.3.2.3
-    'idn-hostname': 'example.com',
-    'ipv4': '127.0.0.1',
-    'ipv6': '51d4:7fab:bfbf:b7d7:b2cb:d4b4:3dad:d998',
-    'iri-reference': '/entitiy/1',
-    // https://tools.ietf.org/html/rfc3987
-    'iri': 'https://example.com/entity/123',
-    'json-pointer': '/nested/objects',
-    'password': 'super-secret',
-    'regex': '/[a-z]/',
-    // https://tools.ietf.org/html/draft-handrews-relative-json-pointer-01
-    'relative-json-pointer': '1/nested/objects',
-    // full-time in https://tools.ietf.org/html/rfc3339#section-5.6
-    // 'time': '00:00:00Z',
-    'time': new Date().toISOString().split('T')[1].split('.')[0],
-    // either a URI or relative-reference https://tools.ietf.org/html/rfc3986#section-4.1
-    'uri-reference': '../folder',
-    'uri-template': 'https://example.com/{id}',
-    'uri': 'https://example.com',
-    'uuid': '123e4567-e89b-12d3-a456-426614174000',
-    'object-id': '6592008029c8c3e4dc76256c',
+  // 'date-time': '1970-01-01T00:00:00Z',
+  "date-time": (/* @__PURE__ */ new Date()).toISOString(),
+  // 'date': '1970-01-01',
+  "date": (/* @__PURE__ */ new Date()).toISOString().split("T")[0],
+  "email": "hello@example.com",
+  "hostname": "example.com",
+  // https://tools.ietf.org/html/rfc6531#section-3.3
+  "idn-email": "jane.doe@example.com",
+  // https://tools.ietf.org/html/rfc5890#section-2.3.2.3
+  "idn-hostname": "example.com",
+  "ipv4": "127.0.0.1",
+  "ipv6": "51d4:7fab:bfbf:b7d7:b2cb:d4b4:3dad:d998",
+  "iri-reference": "/entitiy/1",
+  // https://tools.ietf.org/html/rfc3987
+  "iri": "https://example.com/entity/123",
+  "json-pointer": "/nested/objects",
+  "password": "super-secret",
+  "regex": "/[a-z]/",
+  // https://tools.ietf.org/html/draft-handrews-relative-json-pointer-01
+  "relative-json-pointer": "1/nested/objects",
+  // full-time in https://tools.ietf.org/html/rfc3339#section-5.6
+  // 'time': '00:00:00Z',
+  "time": (/* @__PURE__ */ new Date()).toISOString().split("T")[1].split(".")[0],
+  // either a URI or relative-reference https://tools.ietf.org/html/rfc3986#section-4.1
+  "uri-reference": "../folder",
+  "uri-template": "https://example.com/{id}",
+  "uri": "https://example.com",
+  "uuid": "123e4567-e89b-12d3-a456-426614174000",
+  "object-id": "6592008029c8c3e4dc76256c"
 };
-/**
- * We can use the `format` to generate some random values.
- */
-function guessFromFormat(schema, fallback = '') {
-    return genericExampleValues[schema.format] ?? fallback;
+function guessFromFormat(schema, fallback = "") {
+  return genericExampleValues[schema.format] ?? fallback;
 }
-/** Map of all the results */
-const resultCache = new WeakMap();
-/** Store result in the cache, and return the result */
+const resultCache = /* @__PURE__ */ new WeakMap();
 function cache(schema, result) {
-    // Avoid unnecessary WeakMap operations for primitive values
-    if (typeof result !== 'object' || result === null) {
-        return result;
-    }
-    resultCache.set(schema, result);
+  if (typeof result !== "object" || result === null) {
     return result;
+  }
+  resultCache.set(schema, result);
+  return result;
 }
-/**
- * This function takes an OpenAPI schema and generates an example from it
- */
 const getExampleFromSchema = (schema, options, level = 0, parentSchema, name) => {
-    // Check if the result is already cached
-    if (resultCache.has(schema)) {
-        return resultCache.get(schema);
-    }
-    // Check whether it’s a circular reference
-    if (level === MAX_LEVELS_DEEP + 1) {
-        try {
-            // Fails if it contains a circular reference
-            JSON.stringify(schema);
-        }
-        catch {
-            return '[Circular Reference]';
-        }
-    }
-    // Sometimes, we just want the structure and no values.
-    // But if `emptyString` is  set, we do want to see some values.
-    const makeUpRandomData = !!options?.emptyString;
-    // If the property is deprecated anyway, we don’t want to show it.
-    if (schema.deprecated) {
-        return undefined;
-    }
-    // Check if the property is read-only/write-only
-    if ((options?.mode === 'write' && schema.readOnly) || (options?.mode === 'read' && schema.writeOnly)) {
-        return undefined;
-    }
-    // Use given variables as values
-    if (schema['x-variable']) {
-        const value = options?.variables?.[schema['x-variable']];
-        // Return the value if it’s defined
-        if (value !== undefined) {
-            // Type-casting
-            if (schema.type === 'number' || schema.type === 'integer') {
-                return Number.parseInt(value, 10);
-            }
-            return cache(schema, value);
-        }
-    }
-    // Use the first example, if there’s an array
-    if (Array.isArray(schema.examples) && schema.examples.length > 0) {
-        return cache(schema, schema.examples[0]);
-    }
-    // Use an example, if there’s one
-    if (schema.example !== undefined) {
-        return cache(schema, schema.example);
-    }
-    // Use a default value, if there’s one
-    if (schema.default !== undefined) {
-        return cache(schema, schema.default);
-    }
-    // enum: [ 'available', 'pending', 'sold' ]
-    if (Array.isArray(schema.enum) && schema.enum.length > 0) {
-        return cache(schema, schema.enum[0]);
-    }
-    // Check if the property is required
-    const isObjectOrArray = schema.type === 'object' ||
-        schema.type === 'array' ||
-        !!schema.allOf?.at?.(0) ||
-        !!schema.anyOf?.at?.(0) ||
-        !!schema.oneOf?.at?.(0);
-    if (!isObjectOrArray && options?.omitEmptyAndOptionalProperties === true) {
-        const isRequired = schema.required === true ||
-            parentSchema?.required === true ||
-            parentSchema?.required?.includes(name ?? schema.name);
-        if (!isRequired) {
-            return undefined;
-        }
-    }
-    // Object
-    if (schema.type === 'object' || schema.properties !== undefined) {
-        const response = {};
-        let propertyCount = 0;
-        // Regular properties
-        if (schema.properties !== undefined) {
-            for (const propertyName in schema.properties) {
-                if (Object.prototype.hasOwnProperty.call(schema.properties, propertyName)) {
-                    // Only apply property limit for nested levels (level > 0)
-                    if (level > 3 && propertyCount >= MAX_PROPERTIES) {
-                        response['...'] = '[Additional Properties Truncated]';
-                        break;
-                    }
-                    const property = schema.properties[propertyName];
-                    const propertyXmlTagName = options?.xml ? property.xml?.name : undefined;
-                    const value = getExampleFromSchema(property, options, level + 1, schema, propertyName);
-                    if (typeof value !== 'undefined') {
-                        response[propertyXmlTagName ?? propertyName] = value;
-                        propertyCount++;
-                    }
-                }
-            }
+  if (resultCache.has(schema)) {
+    return resultCache.get(schema);
+  }
+  if (level === MAX_LEVELS_DEEP + 1) {
+    try {
+      JSON.stringify(schema);
+    } catch {
+      return "[Circular Reference]";
+    }
+  }
+  const makeUpRandomData = !!options?.emptyString;
+  if (schema.deprecated) {
+    return void 0;
+  }
+  if (options?.mode === "write" && schema.readOnly || options?.mode === "read" && schema.writeOnly) {
+    return void 0;
+  }
+  if (schema["x-variable"]) {
+    const value = options?.variables?.[schema["x-variable"]];
+    if (value !== void 0) {
+      if (schema.type === "number" || schema.type === "integer") {
+        return Number.parseInt(value, 10);
+      }
+      return cache(schema, value);
+    }
+  }
+  if (Array.isArray(schema.examples) && schema.examples.length > 0) {
+    return cache(schema, schema.examples[0]);
+  }
+  if (schema.example !== void 0) {
+    return cache(schema, schema.example);
+  }
+  if (schema.default !== void 0) {
+    return cache(schema, schema.default);
+  }
+  if (Array.isArray(schema.enum) && schema.enum.length > 0) {
+    return cache(schema, schema.enum[0]);
+  }
+  const isObjectOrArray = schema.type === "object" || schema.type === "array" || !!schema.allOf?.at?.(0) || !!schema.anyOf?.at?.(0) || !!schema.oneOf?.at?.(0);
+  if (!isObjectOrArray && options?.omitEmptyAndOptionalProperties === true) {
+    const isRequired = schema.required === true || parentSchema?.required === true || parentSchema?.required?.includes(name ?? schema.name);
+    if (!isRequired) {
+      return void 0;
+    }
+  }
+  if (schema.type === "object" || schema.properties !== void 0) {
+    const response = {};
+    let propertyCount = 0;
+    if (schema.properties !== void 0) {
+      for (const propertyName in schema.properties) {
+        if (Object.prototype.hasOwnProperty.call(schema.properties, propertyName)) {
+          if (level > 3 && propertyCount >= MAX_PROPERTIES) {
+            response["..."] = "[Additional Properties Truncated]";
+            break;
+          }
+          const property = schema.properties[propertyName];
+          const propertyXmlTagName = options?.xml ? property.xml?.name : void 0;
+          const value = getExampleFromSchema(property, options, level + 1, schema, propertyName);
+          if (typeof value !== "undefined") {
+            response[propertyXmlTagName ?? propertyName] = value;
+            propertyCount++;
+          }
         }
-        // Pattern properties (regex)
-        if (schema.patternProperties !== undefined) {
-            for (const pattern in schema.patternProperties) {
-                if (Object.prototype.hasOwnProperty.call(schema.patternProperties, pattern)) {
-                    const property = schema.patternProperties[pattern];
-                    // Use the regex pattern as an example key
-                    const exampleKey = pattern;
-                    response[exampleKey] = getExampleFromSchema(property, options, level + 1, schema, exampleKey);
-                }
-            }
+      }
+    }
+    if (schema.patternProperties !== void 0) {
+      for (const pattern in schema.patternProperties) {
+        if (Object.prototype.hasOwnProperty.call(schema.patternProperties, pattern)) {
+          const property = schema.patternProperties[pattern];
+          const exampleKey = pattern;
+          response[exampleKey] = getExampleFromSchema(property, options, level + 1, schema, exampleKey);
         }
-        // Additional properties
-        if (schema.additionalProperties !== undefined) {
-            const anyTypeIsValid = 
-            // true
-            schema.additionalProperties === true ||
-                // or an empty object {}
-                (typeof schema.additionalProperties === 'object' && !Object.keys(schema.additionalProperties).length);
-            if (anyTypeIsValid) {
-                response['ANY_ADDITIONAL_PROPERTY'] = 'anything';
-            }
-            else if (schema.additionalProperties !== false) {
-                response['ANY_ADDITIONAL_PROPERTY'] = getExampleFromSchema(schema.additionalProperties, options, level + 1);
-            }
+      }
+    }
+    if (schema.additionalProperties !== void 0) {
+      const anyTypeIsValid = (
+        // true
+        schema.additionalProperties === true || // or an empty object {}
+        typeof schema.additionalProperties === "object" && !Object.keys(schema.additionalProperties).length
+      );
+      if (anyTypeIsValid) {
+        response["ANY_ADDITIONAL_PROPERTY"] = "anything";
+      } else if (schema.additionalProperties !== false) {
+        response["ANY_ADDITIONAL_PROPERTY"] = getExampleFromSchema(schema.additionalProperties, options, level + 1);
+      }
+    }
+    if (schema.anyOf !== void 0) {
+      Object.assign(response, getExampleFromSchema(schema.anyOf[0], options, level + 1));
+    } else if (schema.oneOf !== void 0) {
+      Object.assign(response, getExampleFromSchema(schema.oneOf[0], options, level + 1));
+    } else if (schema.allOf !== void 0) {
+      Object.assign(
+        response,
+        ...schema.allOf.map((item) => getExampleFromSchema(item, options, level + 1, schema)).filter((item) => item !== void 0)
+      );
+    }
+    return cache(schema, response);
+  }
+  if (schema.type === "array" || schema.items !== void 0) {
+    const itemsXmlTagName = schema?.items?.xml?.name;
+    const wrapItems = !!(options?.xml && schema.xml?.wrapped && itemsXmlTagName);
+    if (schema.example !== void 0) {
+      return cache(schema, wrapItems ? { [itemsXmlTagName]: schema.example } : schema.example);
+    }
+    if (schema.items) {
+      if (schema.items.allOf) {
+        if (schema.items.allOf[0].type === "object") {
+          const mergedExample = getExampleFromSchema(
+            { type: "object", allOf: schema.items.allOf },
+            options,
+            level + 1,
+            schema
+          );
+          return cache(schema, wrapItems ? [{ [itemsXmlTagName]: mergedExample }] : [mergedExample]);
         }
-        if (schema.anyOf !== undefined) {
-            Object.assign(response, getExampleFromSchema(schema.anyOf[0], options, level + 1));
+        const examples = schema.items.allOf.map((item) => getExampleFromSchema(item, options, level + 1, schema)).filter((item) => item !== void 0);
+        return cache(schema, wrapItems ? examples.map((example) => ({ [itemsXmlTagName]: example })) : examples);
+      }
+      const rules = ["anyOf", "oneOf"];
+      for (const rule of rules) {
+        if (!schema.items[rule]) {
+          continue;
         }
-        else if (schema.oneOf !== undefined) {
-            Object.assign(response, getExampleFromSchema(schema.oneOf[0], options, level + 1));
-        }
-        else if (schema.allOf !== undefined) {
-            Object.assign(response, ...schema.allOf
-                .map((item) => getExampleFromSchema(item, options, level + 1, schema))
-                .filter((item) => item !== undefined));
-        }
-        return cache(schema, response);
-    }
-    // Array
-    if (schema.type === 'array' || schema.items !== undefined) {
-        const itemsXmlTagName = schema?.items?.xml?.name;
-        const wrapItems = !!(options?.xml && schema.xml?.wrapped && itemsXmlTagName);
-        if (schema.example !== undefined) {
-            return cache(schema, wrapItems ? { [itemsXmlTagName]: schema.example } : schema.example);
-        }
-        // Check whether the array has a anyOf, oneOf, or allOf rule
-        if (schema.items) {
-            // First handle allOf separately since it needs special handling
-            if (schema.items.allOf) {
-                // If the first item is an object type, merge all schemas
-                if (schema.items.allOf[0].type === 'object') {
-                    const mergedExample = getExampleFromSchema({ type: 'object', allOf: schema.items.allOf }, options, level + 1, schema);
-                    return cache(schema, wrapItems ? [{ [itemsXmlTagName]: mergedExample }] : [mergedExample]);
-                }
-                // For non-objects (like strings), collect all examples
-                const examples = schema.items.allOf
-                    .map((item) => getExampleFromSchema(item, options, level + 1, schema))
-                    .filter((item) => item !== undefined);
-                return cache(schema, wrapItems ? examples.map((example) => ({ [itemsXmlTagName]: example })) : examples);
-            }
-            // Handle other rules (anyOf, oneOf)
-            const rules = ['anyOf', 'oneOf'];
-            for (const rule of rules) {
-                if (!schema.items[rule]) {
-                    continue;
-                }
-                const schemas = schema.items[rule].slice(0, 1);
-                const exampleFromRule = schemas
-                    .map((item) => getExampleFromSchema(item, options, level + 1, schema))
-                    .filter((item) => item !== undefined);
-                return cache(schema, wrapItems ? [{ [itemsXmlTagName]: exampleFromRule }] : exampleFromRule);
-            }
-        }
-        if (schema.items?.type) {
-            const exampleFromSchema = getExampleFromSchema(schema.items, options, level + 1);
-            return wrapItems ? [{ [itemsXmlTagName]: exampleFromSchema }] : [exampleFromSchema];
-        }
-        return [];
-    }
-    const exampleValues = {
-        string: makeUpRandomData ? guessFromFormat(schema, options?.emptyString) : '',
-        boolean: true,
-        integer: schema.min ?? 1,
-        number: schema.min ?? 1,
-        array: [],
-    };
-    if (schema.type !== undefined && exampleValues[schema.type] !== undefined) {
-        return cache(schema, exampleValues[schema.type]);
-    }
-    const discriminateSchema = schema.oneOf || schema.anyOf;
-    // Check if property has the `oneOf` | `anyOf` key
-    if (Array.isArray(discriminateSchema) && discriminateSchema.length > 0) {
-        // Get the first item from the `oneOf` | `anyOf` array
-        const firstOneOfItem = discriminateSchema[0];
-        // Return an example for the first item
-        return getExampleFromSchema(firstOneOfItem, options, level + 1);
-    }
-    // Check if schema has the `allOf` key
-    if (Array.isArray(schema.allOf)) {
-        let example = null;
-        // Loop through all `allOf` schemas
-        schema.allOf.forEach((allOfItem) => {
-            // Return an example from the schema
-            const newExample = getExampleFromSchema(allOfItem, options, level + 1);
-            // Merge or overwrite the example
-            example =
-                typeof newExample === 'object' && typeof example === 'object'
-                    ? {
-                        ...(example ?? {}),
-                        ...newExample,
-                    }
-                    : Array.isArray(newExample) && Array.isArray(example)
-                        ? [...(example ?? {}), ...newExample]
-                        : newExample;
-        });
-        return cache(schema, example);
-    }
-    // Check if schema is a union type
-    if (Array.isArray(schema.type)) {
-        // Return null if the type is nullable
-        if (schema.type.includes('null')) {
-            return null;
-        }
-        // Return an example for the first type in the union
-        const exampleValue = exampleValues[schema.type[0]];
-        if (exampleValue !== undefined) {
-            return cache(schema, exampleValue);
-        }
-    }
-    // Warn if the type is unknown …
-    // console.warn(`[getExampleFromSchema] Unknown property type "${schema.type}".`)
-    // … and just return null for now.
-    return null;
+        const schemas = schema.items[rule].slice(0, 1);
+        const exampleFromRule = schemas.map((item) => getExampleFromSchema(item, options, level + 1, schema)).filter((item) => item !== void 0);
+        return cache(schema, wrapItems ? [{ [itemsXmlTagName]: exampleFromRule }] : exampleFromRule);
+      }
+    }
+    if (schema.items?.type) {
+      const exampleFromSchema = getExampleFromSchema(schema.items, options, level + 1);
+      return wrapItems ? [{ [itemsXmlTagName]: exampleFromSchema }] : [exampleFromSchema];
+    }
+    return [];
+  }
+  const exampleValues = {
+    string: makeUpRandomData ? guessFromFormat(schema, options?.emptyString) : "",
+    boolean: true,
+    integer: schema.min ?? 1,
+    number: schema.min ?? 1,
+    array: []
+  };
+  if (schema.type !== void 0 && exampleValues[schema.type] !== void 0) {
+    return cache(schema, exampleValues[schema.type]);
+  }
+  const discriminateSchema = schema.oneOf || schema.anyOf;
+  if (Array.isArray(discriminateSchema) && discriminateSchema.length > 0) {
+    const firstOneOfItem = discriminateSchema[0];
+    return getExampleFromSchema(firstOneOfItem, options, level + 1);
+  }
+  if (Array.isArray(schema.allOf)) {
+    let example = null;
+    schema.allOf.forEach((allOfItem) => {
+      const newExample = getExampleFromSchema(allOfItem, options, level + 1);
+      example = typeof newExample === "object" && typeof example === "object" ? {
+        ...example ?? {},
+        ...newExample
+      } : Array.isArray(newExample) && Array.isArray(example) ? [...example ?? {}, ...newExample] : newExample;
+    });
+    return cache(schema, example);
+  }
+  if (Array.isArray(schema.type)) {
+    if (schema.type.includes("null")) {
+      return null;
+    }
+    const exampleValue = exampleValues[schema.type[0]];
+    if (exampleValue !== void 0) {
+      return cache(schema, exampleValue);
+    }
+  }
+  return null;
+};
+export {
+  getExampleFromSchema
 };
-
-export { getExampleFromSchema };
+//# sourceMappingURL=get-example-from-schema.js.map

package/dist/spec-getters/get-example-from-schema.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/spec-getters/get-example-from-schema.ts"],
+  "sourcesContent": ["/** Hard limit for rendering circular references */\nconst MAX_LEVELS_DEEP = 5\n/** Sets the max number of properties after the third level to prevent exponential horizontal growth */\nconst MAX_PROPERTIES = 10\n\nconst genericExampleValues: Record<string, string> = {\n  // 'date-time': '1970-01-01T00:00:00Z',\n  'date-time': new Date().toISOString(),\n  // 'date': '1970-01-01',\n  'date': new Date().toISOString().split('T')[0]!,\n  'email': 'hello@example.com',\n  'hostname': 'example.com',\n  // https://tools.ietf.org/html/rfc6531#section-3.3\n  'idn-email': 'jane.doe@example.com',\n  // https://tools.ietf.org/html/rfc5890#section-2.3.2.3\n  'idn-hostname': 'example.com',\n  'ipv4': '127.0.0.1',\n  'ipv6': '51d4:7fab:bfbf:b7d7:b2cb:d4b4:3dad:d998',\n  'iri-reference': '/entitiy/1',\n  // https://tools.ietf.org/html/rfc3987\n  'iri': 'https://example.com/entity/123',\n  'json-pointer': '/nested/objects',\n  'password': 'super-secret',\n  'regex': '/[a-z]/',\n  // https://tools.ietf.org/html/draft-handrews-relative-json-pointer-01\n  'relative-json-pointer': '1/nested/objects',\n  // full-time in https://tools.ietf.org/html/rfc3339#section-5.6\n  // 'time': '00:00:00Z',\n  'time': new Date().toISOString().split('T')[1]!.split('.')[0]!,\n  // either a URI or relative-reference https://tools.ietf.org/html/rfc3986#section-4.1\n  'uri-reference': '../folder',\n  'uri-template': 'https://example.com/{id}',\n  'uri': 'https://example.com',\n  'uuid': '123e4567-e89b-12d3-a456-426614174000',\n  'object-id': '6592008029c8c3e4dc76256c',\n}\n\n/**\n * We can use the `format` to generate some random values.\n */\nfunction guessFromFormat(schema: Record<string, any>, fallback: string = '') {\n  return genericExampleValues[schema.format] ?? fallback\n}\n\n/** Map of all the results */\nconst resultCache = new WeakMap<Record<string, any>, any>()\n\n/** Store result in the cache, and return the result */\nfunction cache(schema: Record<string, any>, result: unknown) {\n  // Avoid unnecessary WeakMap operations for primitive values\n  if (typeof result !== 'object' || result === null) {\n    return result\n  }\n\n  resultCache.set(schema, result)\n\n  return result\n}\n\n/**\n * This function takes an OpenAPI schema and generates an example from it\n */\nexport const getExampleFromSchema = (\n  schema: Record<string, any>,\n  options?: {\n    /**\n     * The fallback string for empty string values.\n     * @default ''\n     */\n    emptyString?: string\n    /**\n     * Whether to use the XML tag names as keys\n     * @default false\n     */\n    xml?: boolean\n    /**\n     * Whether to show read-only/write-only properties. Otherwise all properties are shown.\n     * @default undefined\n     */\n    mode?: 'read' | 'write'\n    /**\n     * Dynamic values to add to the example.\n     */\n    variables?: Record<string, any>\n    /**\n     * Whether to omit empty and optional properties.\n     * @default false\n     */\n    omitEmptyAndOptionalProperties?: boolean\n  },\n  level: number = 0,\n  parentSchema?: Record<string, any>,\n  name?: string,\n): any => {\n  // Check if the result is already cached\n  if (resultCache.has(schema)) {\n    return resultCache.get(schema)\n  }\n\n  // Check whether it\u2019s a circular reference\n  if (level === MAX_LEVELS_DEEP + 1) {\n    try {\n      // Fails if it contains a circular reference\n      JSON.stringify(schema)\n    } catch {\n      return '[Circular Reference]'\n    }\n  }\n\n  // Sometimes, we just want the structure and no values.\n  // But if `emptyString` is  set, we do want to see some values.\n  const makeUpRandomData = !!options?.emptyString\n\n  // If the property is deprecated anyway, we don\u2019t want to show it.\n  if (schema.deprecated) {\n    return undefined\n  }\n\n  // Check if the property is read-only/write-only\n  if ((options?.mode === 'write' && schema.readOnly) || (options?.mode === 'read' && schema.writeOnly)) {\n    return undefined\n  }\n\n  // Use given variables as values\n  if (schema['x-variable']) {\n    const value = options?.variables?.[schema['x-variable']]\n\n    // Return the value if it\u2019s defined\n    if (value !== undefined) {\n      // Type-casting\n      if (schema.type === 'number' || schema.type === 'integer') {\n        return Number.parseInt(value, 10)\n      }\n\n      return cache(schema, value)\n    }\n  }\n\n  // Use the first example, if there\u2019s an array\n  if (Array.isArray(schema.examples) && schema.examples.length > 0) {\n    return cache(schema, schema.examples[0])\n  }\n\n  // Use an example, if there\u2019s one\n  if (schema.example !== undefined) {\n    return cache(schema, schema.example)\n  }\n\n  // Use a default value, if there\u2019s one\n  if (schema.default !== undefined) {\n    return cache(schema, schema.default)\n  }\n\n  // enum: [ 'available', 'pending', 'sold' ]\n  if (Array.isArray(schema.enum) && schema.enum.length > 0) {\n    return cache(schema, schema.enum[0])\n  }\n\n  // Check if the property is required\n  const isObjectOrArray =\n    schema.type === 'object' ||\n    schema.type === 'array' ||\n    !!schema.allOf?.at?.(0) ||\n    !!schema.anyOf?.at?.(0) ||\n    !!schema.oneOf?.at?.(0)\n  if (!isObjectOrArray && options?.omitEmptyAndOptionalProperties === true) {\n    const isRequired =\n      schema.required === true ||\n      parentSchema?.required === true ||\n      parentSchema?.required?.includes(name ?? schema.name)\n\n    if (!isRequired) {\n      return undefined\n    }\n  }\n\n  // Object\n  if (schema.type === 'object' || schema.properties !== undefined) {\n    const response: Record<string, any> = {}\n    let propertyCount = 0\n\n    // Regular properties\n    if (schema.properties !== undefined) {\n      for (const propertyName in schema.properties) {\n        if (Object.prototype.hasOwnProperty.call(schema.properties, propertyName)) {\n          // Only apply property limit for nested levels (level > 0)\n          if (level > 3 && propertyCount >= MAX_PROPERTIES) {\n            response['...'] = '[Additional Properties Truncated]'\n            break\n          }\n\n          const property = schema.properties[propertyName]\n          const propertyXmlTagName = options?.xml ? property.xml?.name : undefined\n\n          const value = getExampleFromSchema(property, options, level + 1, schema, propertyName)\n\n          if (typeof value !== 'undefined') {\n            response[propertyXmlTagName ?? propertyName] = value\n            propertyCount++\n          }\n        }\n      }\n    }\n\n    // Pattern properties (regex)\n    if (schema.patternProperties !== undefined) {\n      for (const pattern in schema.patternProperties) {\n        if (Object.prototype.hasOwnProperty.call(schema.patternProperties, pattern)) {\n          const property = schema.patternProperties[pattern]\n\n          // Use the regex pattern as an example key\n          const exampleKey = pattern\n\n          response[exampleKey] = getExampleFromSchema(property, options, level + 1, schema, exampleKey)\n        }\n      }\n    }\n\n    // Additional properties\n    if (schema.additionalProperties !== undefined) {\n      const anyTypeIsValid =\n        // true\n        schema.additionalProperties === true ||\n        // or an empty object {}\n        (typeof schema.additionalProperties === 'object' && !Object.keys(schema.additionalProperties).length)\n\n      if (anyTypeIsValid) {\n        response['ANY_ADDITIONAL_PROPERTY'] = 'anything'\n      } else if (schema.additionalProperties !== false) {\n        response['ANY_ADDITIONAL_PROPERTY'] = getExampleFromSchema(schema.additionalProperties, options, level + 1)\n      }\n    }\n\n    if (schema.anyOf !== undefined) {\n      Object.assign(response, getExampleFromSchema(schema.anyOf[0], options, level + 1))\n    } else if (schema.oneOf !== undefined) {\n      Object.assign(response, getExampleFromSchema(schema.oneOf[0], options, level + 1))\n    } else if (schema.allOf !== undefined) {\n      Object.assign(\n        response,\n        ...schema.allOf\n          .map((item: Record<string, any>) => getExampleFromSchema(item, options, level + 1, schema))\n          .filter((item: any) => item !== undefined),\n      )\n    }\n\n    return cache(schema, response)\n  }\n\n  // Array\n  if (schema.type === 'array' || schema.items !== undefined) {\n    const itemsXmlTagName = schema?.items?.xml?.name\n    const wrapItems = !!(options?.xml && schema.xml?.wrapped && itemsXmlTagName)\n\n    if (schema.example !== undefined) {\n      return cache(schema, wrapItems ? { [itemsXmlTagName]: schema.example } : schema.example)\n    }\n\n    // Check whether the array has a anyOf, oneOf, or allOf rule\n    if (schema.items) {\n      // First handle allOf separately since it needs special handling\n      if (schema.items.allOf) {\n        // If the first item is an object type, merge all schemas\n        if (schema.items.allOf[0].type === 'object') {\n          const mergedExample = getExampleFromSchema(\n            { type: 'object', allOf: schema.items.allOf },\n            options,\n            level + 1,\n            schema,\n          )\n\n          return cache(schema, wrapItems ? [{ [itemsXmlTagName]: mergedExample }] : [mergedExample])\n        }\n        // For non-objects (like strings), collect all examples\n        const examples = schema.items.allOf\n          .map((item: Record<string, any>) => getExampleFromSchema(item, options, level + 1, schema))\n          .filter((item: any) => item !== undefined)\n\n        return cache(schema, wrapItems ? examples.map((example: any) => ({ [itemsXmlTagName]: example })) : examples)\n      }\n\n      // Handle other rules (anyOf, oneOf)\n      const rules = ['anyOf', 'oneOf']\n      for (const rule of rules) {\n        if (!schema.items[rule]) {\n          continue\n        }\n\n        const schemas = schema.items[rule].slice(0, 1)\n        const exampleFromRule = schemas\n          .map((item: Record<string, any>) => getExampleFromSchema(item, options, level + 1, schema))\n          .filter((item: any) => item !== undefined)\n\n        return cache(schema, wrapItems ? [{ [itemsXmlTagName]: exampleFromRule }] : exampleFromRule)\n      }\n    }\n\n    if (schema.items?.type) {\n      const exampleFromSchema = getExampleFromSchema(schema.items, options, level + 1)\n\n      return wrapItems ? [{ [itemsXmlTagName]: exampleFromSchema }] : [exampleFromSchema]\n    }\n\n    return []\n  }\n\n  const exampleValues: Record<any, any> = {\n    string: makeUpRandomData ? guessFromFormat(schema, options?.emptyString) : '',\n    boolean: true,\n    integer: schema.min ?? 1,\n    number: schema.min ?? 1,\n    array: [],\n  }\n\n  if (schema.type !== undefined && exampleValues[schema.type] !== undefined) {\n    return cache(schema, exampleValues[schema.type])\n  }\n\n  const discriminateSchema = schema.oneOf || schema.anyOf\n  // Check if property has the `oneOf` | `anyOf` key\n  if (Array.isArray(discriminateSchema) && discriminateSchema.length > 0) {\n    // Get the first item from the `oneOf` | `anyOf` array\n    const firstOneOfItem = discriminateSchema[0]\n\n    // Return an example for the first item\n    return getExampleFromSchema(firstOneOfItem, options, level + 1)\n  }\n\n  // Check if schema has the `allOf` key\n  if (Array.isArray(schema.allOf)) {\n    let example: any = null\n\n    // Loop through all `allOf` schemas\n    schema.allOf.forEach((allOfItem: Record<string, any>) => {\n      // Return an example from the schema\n      const newExample = getExampleFromSchema(allOfItem, options, level + 1)\n\n      // Merge or overwrite the example\n      example =\n        typeof newExample === 'object' && typeof example === 'object'\n          ? {\n              ...(example ?? {}),\n              ...newExample,\n            }\n          : Array.isArray(newExample) && Array.isArray(example)\n            ? [...(example ?? {}), ...newExample]\n            : newExample\n    })\n\n    return cache(schema, example)\n  }\n\n  // Check if schema is a union type\n  if (Array.isArray(schema.type)) {\n    // Return null if the type is nullable\n    if (schema.type.includes('null')) {\n      return null\n    }\n    // Return an example for the first type in the union\n    const exampleValue = exampleValues[schema.type[0]]\n    if (exampleValue !== undefined) {\n      return cache(schema, exampleValue)\n    }\n  }\n\n  // Warn if the type is unknown \u2026\n  // console.warn(`[getExampleFromSchema] Unknown property type \"${schema.type}\".`)\n\n  // \u2026 and just return null for now.\n  return null\n}\n"],
+  "mappings": "AACA,MAAM,kBAAkB;AAExB,MAAM,iBAAiB;AAEvB,MAAM,uBAA+C;AAAA;AAAA,EAEnD,cAAa,oBAAI,KAAK,GAAE,YAAY;AAAA;AAAA,EAEpC,SAAQ,oBAAI,KAAK,GAAE,YAAY,EAAE,MAAM,GAAG,EAAE,CAAC;AAAA,EAC7C,SAAS;AAAA,EACT,YAAY;AAAA;AAAA,EAEZ,aAAa;AAAA;AAAA,EAEb,gBAAgB;AAAA,EAChB,QAAQ;AAAA,EACR,QAAQ;AAAA,EACR,iBAAiB;AAAA;AAAA,EAEjB,OAAO;AAAA,EACP,gBAAgB;AAAA,EAChB,YAAY;AAAA,EACZ,SAAS;AAAA;AAAA,EAET,yBAAyB;AAAA;AAAA;AAAA,EAGzB,SAAQ,oBAAI,KAAK,GAAE,YAAY,EAAE,MAAM,GAAG,EAAE,CAAC,EAAG,MAAM,GAAG,EAAE,CAAC;AAAA;AAAA,EAE5D,iBAAiB;AAAA,EACjB,gBAAgB;AAAA,EAChB,OAAO;AAAA,EACP,QAAQ;AAAA,EACR,aAAa;AACf;AAKA,SAAS,gBAAgB,QAA6B,WAAmB,IAAI;AAC3E,SAAO,qBAAqB,OAAO,MAAM,KAAK;AAChD;AAGA,MAAM,cAAc,oBAAI,QAAkC;AAG1D,SAAS,MAAM,QAA6B,QAAiB;AAE3D,MAAI,OAAO,WAAW,YAAY,WAAW,MAAM;AACjD,WAAO;AAAA,EACT;AAEA,cAAY,IAAI,QAAQ,MAAM;AAE9B,SAAO;AACT;AAKO,MAAM,uBAAuB,CAClC,QACA,SA0BA,QAAgB,GAChB,cACA,SACQ;AAER,MAAI,YAAY,IAAI,MAAM,GAAG;AAC3B,WAAO,YAAY,IAAI,MAAM;AAAA,EAC/B;AAGA,MAAI,UAAU,kBAAkB,GAAG;AACjC,QAAI;AAEF,WAAK,UAAU,MAAM;AAAA,IACvB,QAAQ;AACN,aAAO;AAAA,IACT;AAAA,EACF;AAIA,QAAM,mBAAmB,CAAC,CAAC,SAAS;AAGpC,MAAI,OAAO,YAAY;AACrB,WAAO;AAAA,EACT;AAGA,MAAK,SAAS,SAAS,WAAW,OAAO,YAAc,SAAS,SAAS,UAAU,OAAO,WAAY;AACpG,WAAO;AAAA,EACT;AAGA,MAAI,OAAO,YAAY,GAAG;AACxB,UAAM,QAAQ,SAAS,YAAY,OAAO,YAAY,CAAC;AAGvD,QAAI,UAAU,QAAW;AAEvB,UAAI,OAAO,SAAS,YAAY,OAAO,SAAS,WAAW;AACzD,eAAO,OAAO,SAAS,OAAO,EAAE;AAAA,MAClC;AAEA,aAAO,MAAM,QAAQ,KAAK;AAAA,IAC5B;AAAA,EACF;AAGA,MAAI,MAAM,QAAQ,OAAO,QAAQ,KAAK,OAAO,SAAS,SAAS,GAAG;AAChE,WAAO,MAAM,QAAQ,OAAO,SAAS,CAAC,CAAC;AAAA,EACzC;AAGA,MAAI,OAAO,YAAY,QAAW;AAChC,WAAO,MAAM,QAAQ,OAAO,OAAO;AAAA,EACrC;AAGA,MAAI,OAAO,YAAY,QAAW;AAChC,WAAO,MAAM,QAAQ,OAAO,OAAO;AAAA,EACrC;AAGA,MAAI,MAAM,QAAQ,OAAO,IAAI,KAAK,OAAO,KAAK,SAAS,GAAG;AACxD,WAAO,MAAM,QAAQ,OAAO,KAAK,CAAC,CAAC;AAAA,EACrC;AAGA,QAAM,kBACJ,OAAO,SAAS,YAChB,OAAO,SAAS,WAChB,CAAC,CAAC,OAAO,OAAO,KAAK,CAAC,KACtB,CAAC,CAAC,OAAO,OAAO,KAAK,CAAC,KACtB,CAAC,CAAC,OAAO,OAAO,KAAK,CAAC;AACxB,MAAI,CAAC,mBAAmB,SAAS,mCAAmC,MAAM;AACxE,UAAM,aACJ,OAAO,aAAa,QACpB,cAAc,aAAa,QAC3B,cAAc,UAAU,SAAS,QAAQ,OAAO,IAAI;AAEtD,QAAI,CAAC,YAAY;AACf,aAAO;AAAA,IACT;AAAA,EACF;AAGA,MAAI,OAAO,SAAS,YAAY,OAAO,eAAe,QAAW;AAC/D,UAAM,WAAgC,CAAC;AACvC,QAAI,gBAAgB;AAGpB,QAAI,OAAO,eAAe,QAAW;AACnC,iBAAW,gBAAgB,OAAO,YAAY;AAC5C,YAAI,OAAO,UAAU,eAAe,KAAK,OAAO,YAAY,YAAY,GAAG;AAEzE,cAAI,QAAQ,KAAK,iBAAiB,gBAAgB;AAChD,qBAAS,KAAK,IAAI;AAClB;AAAA,UACF;AAEA,gBAAM,WAAW,OAAO,WAAW,YAAY;AAC/C,gBAAM,qBAAqB,SAAS,MAAM,SAAS,KAAK,OAAO;AAE/D,gBAAM,QAAQ,qBAAqB,UAAU,SAAS,QAAQ,GAAG,QAAQ,YAAY;AAErF,cAAI,OAAO,UAAU,aAAa;AAChC,qBAAS,sBAAsB,YAAY,IAAI;AAC/C;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAGA,QAAI,OAAO,sBAAsB,QAAW;AAC1C,iBAAW,WAAW,OAAO,mBAAmB;AAC9C,YAAI,OAAO,UAAU,eAAe,KAAK,OAAO,mBAAmB,OAAO,GAAG;AAC3E,gBAAM,WAAW,OAAO,kBAAkB,OAAO;AAGjD,gBAAM,aAAa;AAEnB,mBAAS,UAAU,IAAI,qBAAqB,UAAU,SAAS,QAAQ,GAAG,QAAQ,UAAU;AAAA,QAC9F;AAAA,MACF;AAAA,IACF;AAGA,QAAI,OAAO,yBAAyB,QAAW;AAC7C,YAAM;AAAA;AAAA,QAEJ,OAAO,yBAAyB;AAAA,QAE/B,OAAO,OAAO,yBAAyB,YAAY,CAAC,OAAO,KAAK,OAAO,oBAAoB,EAAE;AAAA;AAEhG,UAAI,gBAAgB;AAClB,iBAAS,yBAAyB,IAAI;AAAA,MACxC,WAAW,OAAO,yBAAyB,OAAO;AAChD,iBAAS,yBAAyB,IAAI,qBAAqB,OAAO,sBAAsB,SAAS,QAAQ,CAAC;AAAA,MAC5G;AAAA,IACF;AAEA,QAAI,OAAO,UAAU,QAAW;AAC9B,aAAO,OAAO,UAAU,qBAAqB,OAAO,MAAM,CAAC,GAAG,SAAS,QAAQ,CAAC,CAAC;AAAA,IACnF,WAAW,OAAO,UAAU,QAAW;AACrC,aAAO,OAAO,UAAU,qBAAqB,OAAO,MAAM,CAAC,GAAG,SAAS,QAAQ,CAAC,CAAC;AAAA,IACnF,WAAW,OAAO,UAAU,QAAW;AACrC,aAAO;AAAA,QACL;AAAA,QACA,GAAG,OAAO,MACP,IAAI,CAAC,SAA8B,qBAAqB,MAAM,SAAS,QAAQ,GAAG,MAAM,CAAC,EACzF,OAAO,CAAC,SAAc,SAAS,MAAS;AAAA,MAC7C;AAAA,IACF;AAEA,WAAO,MAAM,QAAQ,QAAQ;AAAA,EAC/B;AAGA,MAAI,OAAO,SAAS,WAAW,OAAO,UAAU,QAAW;AACzD,UAAM,kBAAkB,QAAQ,OAAO,KAAK;AAC5C,UAAM,YAAY,CAAC,EAAE,SAAS,OAAO,OAAO,KAAK,WAAW;AAE5D,QAAI,OAAO,YAAY,QAAW;AAChC,aAAO,MAAM,QAAQ,YAAY,EAAE,CAAC,eAAe,GAAG,OAAO,QAAQ,IAAI,OAAO,OAAO;AAAA,IACzF;AAGA,QAAI,OAAO,OAAO;AAEhB,UAAI,OAAO,MAAM,OAAO;AAEtB,YAAI,OAAO,MAAM,MAAM,CAAC,EAAE,SAAS,UAAU;AAC3C,gBAAM,gBAAgB;AAAA,YACpB,EAAE,MAAM,UAAU,OAAO,OAAO,MAAM,MAAM;AAAA,YAC5C;AAAA,YACA,QAAQ;AAAA,YACR;AAAA,UACF;AAEA,iBAAO,MAAM,QAAQ,YAAY,CAAC,EAAE,CAAC,eAAe,GAAG,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC;AAAA,QAC3F;AAEA,cAAM,WAAW,OAAO,MAAM,MAC3B,IAAI,CAAC,SAA8B,qBAAqB,MAAM,SAAS,QAAQ,GAAG,MAAM,CAAC,EACzF,OAAO,CAAC,SAAc,SAAS,MAAS;AAE3C,eAAO,MAAM,QAAQ,YAAY,SAAS,IAAI,CAAC,aAAkB,EAAE,CAAC,eAAe,GAAG,QAAQ,EAAE,IAAI,QAAQ;AAAA,MAC9G;AAGA,YAAM,QAAQ,CAAC,SAAS,OAAO;AAC/B,iBAAW,QAAQ,OAAO;AACxB,YAAI,CAAC,OAAO,MAAM,IAAI,GAAG;AACvB;AAAA,QACF;AAEA,cAAM,UAAU,OAAO,MAAM,IAAI,EAAE,MAAM,GAAG,CAAC;AAC7C,cAAM,kBAAkB,QACrB,IAAI,CAAC,SAA8B,qBAAqB,MAAM,SAAS,QAAQ,GAAG,MAAM,CAAC,EACzF,OAAO,CAAC,SAAc,SAAS,MAAS;AAE3C,eAAO,MAAM,QAAQ,YAAY,CAAC,EAAE,CAAC,eAAe,GAAG,gBAAgB,CAAC,IAAI,eAAe;AAAA,MAC7F;AAAA,IACF;AAEA,QAAI,OAAO,OAAO,MAAM;AACtB,YAAM,oBAAoB,qBAAqB,OAAO,OAAO,SAAS,QAAQ,CAAC;AAE/E,aAAO,YAAY,CAAC,EAAE,CAAC,eAAe,GAAG,kBAAkB,CAAC,IAAI,CAAC,iBAAiB;AAAA,IACpF;AAEA,WAAO,CAAC;AAAA,EACV;AAEA,QAAM,gBAAkC;AAAA,IACtC,QAAQ,mBAAmB,gBAAgB,QAAQ,SAAS,WAAW,IAAI;AAAA,IAC3E,SAAS;AAAA,IACT,SAAS,OAAO,OAAO;AAAA,IACvB,QAAQ,OAAO,OAAO;AAAA,IACtB,OAAO,CAAC;AAAA,EACV;AAEA,MAAI,OAAO,SAAS,UAAa,cAAc,OAAO,IAAI,MAAM,QAAW;AACzE,WAAO,MAAM,QAAQ,cAAc,OAAO,IAAI,CAAC;AAAA,EACjD;AAEA,QAAM,qBAAqB,OAAO,SAAS,OAAO;AAElD,MAAI,MAAM,QAAQ,kBAAkB,KAAK,mBAAmB,SAAS,GAAG;AAEtE,UAAM,iBAAiB,mBAAmB,CAAC;AAG3C,WAAO,qBAAqB,gBAAgB,SAAS,QAAQ,CAAC;AAAA,EAChE;AAGA,MAAI,MAAM,QAAQ,OAAO,KAAK,GAAG;AAC/B,QAAI,UAAe;AAGnB,WAAO,MAAM,QAAQ,CAAC,cAAmC;AAEvD,YAAM,aAAa,qBAAqB,WAAW,SAAS,QAAQ,CAAC;AAGrE,gBACE,OAAO,eAAe,YAAY,OAAO,YAAY,WACjD;AAAA,QACE,GAAI,WAAW,CAAC;AAAA,QAChB,GAAG;AAAA,MACL,IACA,MAAM,QAAQ,UAAU,KAAK,MAAM,QAAQ,OAAO,IAChD,CAAC,GAAI,WAAW,CAAC,GAAI,GAAG,UAAU,IAClC;AAAA,IACV,CAAC;AAED,WAAO,MAAM,QAAQ,OAAO;AAAA,EAC9B;AAGA,MAAI,MAAM,QAAQ,OAAO,IAAI,GAAG;AAE9B,QAAI,OAAO,KAAK,SAAS,MAAM,GAAG;AAChC,aAAO;AAAA,IACT;AAEA,UAAM,eAAe,cAAc,OAAO,KAAK,CAAC,CAAC;AACjD,QAAI,iBAAiB,QAAW;AAC9B,aAAO,MAAM,QAAQ,YAAY;AAAA,IACnC;AAAA,EACF;AAMA,SAAO;AACT;",
+  "names": []
+}