docusaurus-plugin-generate-schema-docs 1.8.3 → 1.8.5

package/helpers/schema-doc-template.js

@@ -12,6 +12,7 @@ export default function MdxTemplate(data) {
     sourcePath,
     schemaSources,
   } = data;
+  const sourceSchema = schemaSources?.[sourcePath] || schema;
 
   return `---
 title: ${schema.title}
@@ -33,6 +34,9 @@ ${topPartialComponent}
 
 <SchemaViewer
   schema={${JSON.stringify(mergedSchema)}}
+  sourceSchema={${JSON.stringify(sourceSchema)}}
+  sourcePath={${JSON.stringify(sourcePath)}}
+  schemaSources={${JSON.stringify(schemaSources)}}
   ${dataLayerName ? ` dataLayerName={'${dataLayerName}'}` : ''}
 />
 <SchemaJsonViewer

package/helpers/schemaToExamples.js

@@ -1,44 +1,31 @@
 import buildExampleFromSchema from './buildExampleFromSchema';
 import { mergeSchema } from './mergeSchema.js';
+import traversalHelpers from './schemaTraversal.cjs';
 
-const findChoicePoints = (subSchema, path = []) => {
-  if (!subSchema) {
-    return [];
-  }
+const { visitSchemaNodes } = traversalHelpers;
 
-  const choiceType = subSchema.oneOf
-    ? 'oneOf'
-    : subSchema.anyOf
-      ? 'anyOf'
-      : null;
-  const currentChoice = choiceType ? [{ path, schema: subSchema }] : [];
+const findChoicePoints = (schema) => {
+  const choicePoints = [];
 
-  const nestedChoices = subSchema.properties
-    ? Object.entries(subSchema.properties).flatMap(([key, propSchema]) =>
-        findChoicePoints(propSchema, [...path, 'properties', key]),
-      )
-    : [];
+  visitSchemaNodes(schema, (subSchema, context) => {
+    if (subSchema.oneOf || subSchema.anyOf) {
+      choicePoints.push({ path: context.path, schema: subSchema });
+    }
+  });
 
-  return [...currentChoice, ...nestedChoices];
+  return choicePoints;
 };
 
-const findConditionalPoints = (subSchema, path = []) => {
-  if (!subSchema) {
-    return [];
-  }
-
-  const currentConditional =
-    subSchema.if && (subSchema.then || subSchema.else)
-      ? [{ path, schema: subSchema }]
-      : [];
+const findConditionalPoints = (schema) => {
+  const conditionalPoints = [];
 
-  const nestedConditionals = subSchema.properties
-    ? Object.entries(subSchema.properties).flatMap(([key, propSchema]) =>
-        findConditionalPoints(propSchema, [...path, 'properties', key]),
-      )
-    : [];
+  visitSchemaNodes(schema, (subSchema, context) => {
+    if (subSchema.if && (subSchema.then || subSchema.else)) {
+      conditionalPoints.push({ path: context.path, schema: subSchema });
+    }
+  });
 
-  return [...currentConditional, ...nestedConditionals];
+  return conditionalPoints;
 };
 
 const generateExampleForChoice = (rootSchema, path, option) => {
@@ -151,10 +138,17 @@ export function schemaToExamples(rootSchema) {
 
   if (choicePoints.length === 0 && conditionalPoints.length === 0) {
     const example = buildExampleFromSchema(rootSchema);
-    if (example && Object.keys(example).length > 0) {
-      return [
-        { property: 'default', options: [{ title: 'Example', example }] },
-      ];
+    if (typeof example !== 'undefined') {
+      const shouldIncludeObjectExample =
+        typeof example !== 'object' ||
+        example === null ||
+        Object.keys(example).length > 0;
+
+      if (shouldIncludeObjectExample) {
+        return [
+          { property: 'default', options: [{ title: 'Example', example }] },
+        ];
+      }
     }
     return [];
   }