fix: add schema expansion level (#1868)

* feat: add schemaExpansionLevel
Redocly · Jan 25, 2022 · 250d53a · 250d53a
1 parent 35418b1
commit 250d53a
Show file tree

Hide file tree

Showing 6 changed files with 49 additions and 17 deletions.
diff --git a/src/components/Fields/Field.tsx b/src/components/Fields/Field.tsx
@@ -32,7 +32,7 @@ export interface FieldProps extends SchemaOptions {
 export class Field extends React.Component<FieldProps> {
   toggle = () => {
     if (this.props.field.expanded === undefined && this.props.expandByDefault) {
-      this.props.field.expanded = false;
+      this.props.field.collapse();
     } else {
       this.props.field.toggle();
     }
@@ -94,6 +94,7 @@ export class Field extends React.Component<FieldProps> {
                   skipReadOnly={this.props.skipReadOnly}
                   skipWriteOnly={this.props.skipWriteOnly}
                   showTitle={this.props.showTitle}
+                  level={this.props.level}
                 />
               </InnerPropertiesWrap>
             </PropertyCellWithInner>

diff --git a/src/components/Schema/ObjectSchema.tsx b/src/components/Schema/ObjectSchema.tsx
@@ -25,8 +25,10 @@ export const ObjectSchema = observer(
     discriminator,
     skipReadOnly,
     skipWriteOnly,
+    level,
   }: ObjectSchemaProps) => {
-    const { expandSingleSchemaField, showObjectSchemaExamples } = React.useContext(OptionsContext);
+    const { expandSingleSchemaField, showObjectSchemaExamples, schemaExpansionLevel } =
+      React.useContext(OptionsContext);
 
     const filteredFields = React.useMemo(
       () =>
@@ -42,7 +44,8 @@ export const ObjectSchema = observer(
       [skipReadOnly, skipWriteOnly, fields],
     );
 
-    const expandByDefault = expandSingleSchemaField && filteredFields.length === 1;
+    const expandByDefault =
+      (expandSingleSchemaField && filteredFields.length === 1) || schemaExpansionLevel >= level!;
 
     return (
       <PropertiesTable>
@@ -70,6 +73,7 @@ export const ObjectSchema = observer(
                 skipReadOnly={skipReadOnly}
                 skipWriteOnly={skipWriteOnly}
                 showTitle={showTitle}
+                level={level}
               />
             );
           })}

diff --git a/src/components/Schema/Schema.tsx b/src/components/Schema/Schema.tsx
@@ -16,6 +16,7 @@ export interface SchemaOptions {
   showTitle?: boolean;
   skipReadOnly?: boolean;
   skipWriteOnly?: boolean;
+  level?: number;
 }
 
 export interface SchemaProps extends SchemaOptions {
@@ -25,7 +26,9 @@ export interface SchemaProps extends SchemaOptions {
 @observer
 export class Schema extends React.Component<Partial<SchemaProps>> {
   render() {
-    const { schema } = this.props;
+    const { schema, ...rest } = this.props;
+    const level = (rest.level || 0) + 1;
+
     if (!schema) {
       return <em> Schema not provided </em>;
     }
@@ -50,7 +53,9 @@ export class Schema extends React.Component<Partial<SchemaProps>> {
       }
       return (
         <ObjectSchema
-          {...{ ...this.props, schema: oneOf![schema.activeOneOf] }}
+          {...rest}
+          level={level}
+          schema={oneOf![schema.activeOneOf]}
           discriminator={{
             fieldName: discriminatorProp,
             parentSchema: schema,
@@ -60,16 +65,16 @@ export class Schema extends React.Component<Partial<SchemaProps>> {
     }
 
     if (oneOf !== undefined) {
-      return <OneOfSchema schema={schema} {...this.props} />;
+      return <OneOfSchema schema={schema} {...rest} />;
     }
 
     const types = Array.isArray(type) ? type : [type];
     if (types.includes('object')) {
       if (schema.fields?.length) {
-        return <ObjectSchema {...(this.props as any)} />;
+        return <ObjectSchema {...(this.props as any)} level={level} />;
       }
     } else if (types.includes('array')) {
-      return <ArraySchema {...(this.props as any)} />;
+      return <ArraySchema {...(this.props as any)} level={level} />;
     }
 
     // TODO: maybe adjust FieldDetails to accept schema

diff --git a/src/components/__tests__/__snapshots__/DiscriminatorDropdown.test.tsx.snap b/src/components/__tests__/__snapshots__/DiscriminatorDropdown.test.tsx.snap
@@ -46,7 +46,6 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
                 "deprecated": false,
                 "description": "",
                 "example": undefined,
-                "expanded": false,
                 "explode": false,
                 "in": undefined,
                 "kind": "field",
@@ -94,6 +93,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
                     "pathInMiddlePanel": false,
                     "payloadSampleIdx": 0,
                     "requiredPropsFirst": false,
+                    "schemaExpansionLevel": 0,
                     "scrollYOffset": [Function],
                     "showExtensions": false,
                     "showObjectSchemaExamples": false,
@@ -285,7 +285,6 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
                 "deprecated": false,
                 "description": "",
                 "example": undefined,
-                "expanded": false,
                 "explode": false,
                 "in": undefined,
                 "kind": "field",
@@ -333,6 +332,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
                     "pathInMiddlePanel": false,
                     "payloadSampleIdx": 0,
                     "requiredPropsFirst": false,
+                    "schemaExpansionLevel": 0,
                     "scrollYOffset": [Function],
                     "showExtensions": false,
                     "showObjectSchemaExamples": false,
@@ -548,6 +548,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
               "pathInMiddlePanel": false,
               "payloadSampleIdx": 0,
               "requiredPropsFirst": false,
+              "schemaExpansionLevel": 0,
               "scrollYOffset": [Function],
               "showExtensions": false,
               "showObjectSchemaExamples": false,
@@ -780,7 +781,6 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
                 "deprecated": false,
                 "description": "",
                 "example": undefined,
-                "expanded": false,
                 "explode": false,
                 "in": undefined,
                 "kind": "field",
@@ -828,6 +828,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
                     "pathInMiddlePanel": false,
                     "payloadSampleIdx": 0,
                     "requiredPropsFirst": false,
+                    "schemaExpansionLevel": 0,
                     "scrollYOffset": [Function],
                     "showExtensions": false,
                     "showObjectSchemaExamples": false,
@@ -1019,7 +1020,6 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
                 "deprecated": false,
                 "description": "",
                 "example": undefined,
-                "expanded": false,
                 "explode": false,
                 "in": undefined,
                 "kind": "field",
@@ -1067,6 +1067,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
                     "pathInMiddlePanel": false,
                     "payloadSampleIdx": 0,
                     "requiredPropsFirst": false,
+                    "schemaExpansionLevel": 0,
                     "scrollYOffset": [Function],
                     "showExtensions": false,
                     "showObjectSchemaExamples": false,
@@ -1282,6 +1283,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
               "pathInMiddlePanel": false,
               "payloadSampleIdx": 0,
               "requiredPropsFirst": false,
+              "schemaExpansionLevel": 0,
               "scrollYOffset": [Function],
               "showExtensions": false,
               "showObjectSchemaExamples": false,
@@ -1520,6 +1522,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
           "pathInMiddlePanel": false,
           "payloadSampleIdx": 0,
           "requiredPropsFirst": false,
+          "schemaExpansionLevel": 0,
           "scrollYOffset": [Function],
           "showExtensions": false,
           "showObjectSchemaExamples": false,
@@ -1727,6 +1730,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
       },
     }
   }
+  level={1}
   schema={
     SchemaModel {
       "activeOneOf": 0,
@@ -1748,7 +1752,6 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
           "deprecated": false,
           "description": "",
           "example": undefined,
-          "expanded": false,
           "explode": false,
           "in": undefined,
           "kind": "field",
@@ -1796,6 +1799,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
               "pathInMiddlePanel": false,
               "payloadSampleIdx": 0,
               "requiredPropsFirst": false,
+              "schemaExpansionLevel": 0,
               "scrollYOffset": [Function],
               "showExtensions": false,
               "showObjectSchemaExamples": false,
@@ -1987,7 +1991,6 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
           "deprecated": false,
           "description": "",
           "example": undefined,
-          "expanded": false,
           "explode": false,
           "in": undefined,
           "kind": "field",
@@ -2035,6 +2038,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
               "pathInMiddlePanel": false,
               "payloadSampleIdx": 0,
               "requiredPropsFirst": false,
+              "schemaExpansionLevel": 0,
               "scrollYOffset": [Function],
               "showExtensions": false,
               "showObjectSchemaExamples": false,
@@ -2250,6 +2254,7 @@ exports[`Components SchemaView discriminator should correctly render SchemaView
         "pathInMiddlePanel": false,
         "payloadSampleIdx": 0,
         "requiredPropsFirst": false,
+        "schemaExpansionLevel": 0,
         "scrollYOffset": [Function],
         "showExtensions": false,
         "showObjectSchemaExamples": false,
@@ -2477,7 +2482,6 @@ exports[`Components SchemaView discriminator should correctly render discriminat
           "deprecated": false,
           "description": "",
           "example": undefined,
-          "expanded": false,
           "explode": false,
           "in": undefined,
           "kind": "field",
@@ -2533,7 +2537,6 @@ exports[`Components SchemaView discriminator should correctly render discriminat
           "deprecated": false,
           "description": "",
           "example": undefined,
-          "expanded": false,
           "explode": false,
           "in": undefined,
           "kind": "field",

diff --git a/src/services/RedocNormalizedOptions.ts b/src/services/RedocNormalizedOptions.ts
@@ -37,6 +37,7 @@ export interface RedocRawOptions {
   simpleOneOfTypeLabel?: boolean | string;
   payloadSampleIdx?: number;
   expandSingleSchemaField?: boolean | string;
+  schemaExpansionLevel?: number | string | 'all';
   showObjectSchemaExamples?: boolean | string;
 
   unstable_ignoreMimeParameters?: boolean;
@@ -74,6 +75,12 @@ function argValueToNumber(value: number | string | undefined): number | undefine
   }
 }
 
+function argValueToExpandLevel(value?: number | string | undefined, defaultValue = 0): number {
+  if (value === 'all') return Infinity;
+
+  return argValueToNumber(value) || defaultValue;
+}
+
 export class RedocNormalizedOptions {
   static normalizeExpandResponses(value: RedocRawOptions['expandResponses']) {
     if (value === 'all') {
@@ -225,6 +232,7 @@ export class RedocNormalizedOptions {
   simpleOneOfTypeLabel: boolean;
   payloadSampleIdx: number;
   expandSingleSchemaField: boolean;
+  schemaExpansionLevel: number;
   showObjectSchemaExamples: boolean;
 
   /* tslint:disable-next-line */
@@ -289,6 +297,7 @@ export class RedocNormalizedOptions {
     this.simpleOneOfTypeLabel = argValueToBoolean(raw.simpleOneOfTypeLabel);
     this.payloadSampleIdx = RedocNormalizedOptions.normalizePayloadSampleIdx(raw.payloadSampleIdx);
     this.expandSingleSchemaField = argValueToBoolean(raw.expandSingleSchemaField);
+    this.schemaExpansionLevel = argValueToExpandLevel(raw.schemaExpansionLevel);
     this.showObjectSchemaExamples = argValueToBoolean(raw.showObjectSchemaExamples);
 
     this.unstable_ignoreMimeParameters = argValueToBoolean(raw.unstable_ignoreMimeParameters);

diff --git a/src/services/models/Field.ts b/src/services/models/Field.ts
@@ -41,7 +41,7 @@ const DEFAULT_SERIALIZATION: Record<
  */
 export class FieldModel {
   @observable
-  expanded: boolean | undefined = false;
+  expanded: boolean | undefined;
 
   schema: SchemaModel;
   name: string;
@@ -120,4 +120,14 @@ export class FieldModel {
   toggle() {
     this.expanded = !this.expanded;
   }
+
+  @action
+  collapse(): void {
+    this.expanded = false;
+  }
+
+  @action
+  expand(): void {
+    this.expanded = true;
+  }
 }