752 in schema diagram and documentation view use smarter type descriptions (#753)

* show names for enums with title as type descriptions

* show name of array item node as type description in parent attribute list

* apply formatting changes

* remove PR from triggers of npm test

---------

Co-authored-by: Logende <[email protected]>

Author: Logende

.github/workflows/npm-test.yml

@@ -1,6 +1,6 @@
 name: Node.js CI
 
-on: [push, workflow_dispatch, pull_request]
+on: [push, workflow_dispatch]
 
 jobs:
   build:

meta_configurator/src/schema/graph-representation/__tests__/schemaGraphConstructorArrays.test.ts

@@ -175,8 +175,8 @@ describe('test schema graph constructor with objects and attributes, without adv
     expect(attrPropArraySimple.typeDescription).toEqual('boolean[]');
 
     const attrPropArrayComplex = rootNode.attributes[1];
-    // array to inlined object. Because object has no custom title, we refer to it as just object
-    expect(attrPropArrayComplex.typeDescription).toEqual('object[]');
+    // array to inlined object.
+    expect(attrPropArrayComplex.typeDescription).toEqual('propertyArrayToComplex entry[]');
 
     const attrPropArrayRefSimple = rootNode.attributes[2];
     // array to ref of simple type

meta_configurator/src/schema/graph-representation/schemaGraphConstructor.ts

@@ -1,6 +1,10 @@
 import type {JsonSchemaObjectType, JsonSchemaType, TopLevelSchema} from '@/schema/jsonSchemaType';
 import type {Path} from '@/utility/path';
-import {getTypeDescription, isSubSchemaDefinedInDefinitions} from '@/schema/schemaReadingUtils';
+import {
+  doesSchemaHaveType,
+  getTypeDescription,
+  isSubSchemaDefinedInDefinitions,
+} from '@/schema/schemaReadingUtils';
 import {jsonPointerToPath, pathToString} from '@/utility/pathUtils';
 import {useSettings} from '@/settings/useSettings';
 import {mergeAllOfs} from '@/schema/mergeAllOfs';
@@ -369,11 +373,19 @@ export function generateAttributeTypeDescription(
     if (arrayItemObject) {
       if (arrayItemObject.schema.title) {
         typeDescription = arrayItemObject.title + '[]';
+      } else if (
+        doesSchemaHaveType(arrayItemObject.schema, 'object', true) ||
+        doesSchemaHaveType(arrayItemObject.schema, 'array', true)
+      ) {
+        // if the array item is of type object or array, use the fallback display name
+        typeDescription = arrayItemObject.fallbackDisplayName + '[]';
       } else {
+        // otherwise, use the type description of the array item
         typeDescription = getTypeDescription(arrayItemObject.schema) + '[]';
       }
     } else {
       if (isObjectSchema(schema.items)) {
+        // if there is no corresponding node for the array item, use the type description of the items
         typeDescription = getTypeDescription(schema.items as JsonSchemaObjectType) + '[]';
       }
     }
@@ -392,6 +404,14 @@ export function generateAttributeTypeDescription(
     }
   }
 
+  // if data type is an enum, overwrite with title of the enum if existing
+  // else, leave the type description as is
+  if (isEnumSchema(schema)) {
+    if (schema.title && schema.title.length > 0) {
+      typeDescription = schema.title;
+    }
+  }
+
   return typeDescription;
 }
 

meta_configurator/src/utility/documentation/__tests__/samples/arrays.expected.md

@@ -6,15 +6,15 @@
     - [nestedArraysAndObjectsProperty entry](#%2Fproperties%2FnestedArraysAndObjectsProperty%2Fitems)
 
 ---
-### <a id="root"></a>[My Schema](#root)
+### [My Schema](#root)
 #### Properties
 
 | Name | Type | Required | Description |
 |------|------|------|------|
-| <a id="%2Fproperties%2FnumberArrayProperty%2Fitems"></a>numberArrayProperty | number\[\] | <span style="color:salmon">false</span> | \- |
-| objectArrayProperty | <u>[object\[\]](#%2Fproperties%2FobjectArrayProperty%2Fitems)</u> | <span style="color:salmon">false</span> | \- |
-| <a id="%2Fproperties%2FnestedArraysProperty%2Fitems%2Fitems%2Fitems"></a>nestedArraysProperty | array\[\] | <span style="color:salmon">false</span> | \- |
-| nestedArraysAndObjectsProperty | <u>[object\[\]](#%2Fproperties%2FnestedArraysAndObjectsProperty%2Fitems)</u> | <span style="color:salmon">false</span> | \- |
+| numberArrayProperty | number\[\] | false | \- |
+| objectArrayProperty | [objectArrayProperty entry\[\]](#%2Fproperties%2FobjectArrayProperty%2Fitems) | false | \- |
+| nestedArraysProperty | nestedArraysProperty entry\[\] | false | \- |
+| nestedArraysAndObjectsProperty | [nestedArraysAndObjectsProperty entry\[\]](#%2Fproperties%2FnestedArraysAndObjectsProperty%2Fitems) | false | \- |
 
 #### Example
 
@@ -45,12 +45,12 @@
 }
 ```
 ---
-### <a id="%2Fproperties%2FobjectArrayProperty%2Fitems"></a>[objectArrayProperty entry](#%2Fproperties%2FobjectArrayProperty%2Fitems)
+### [objectArrayProperty entry](#%2Fproperties%2FobjectArrayProperty%2Fitems)
 #### Properties
 
 | Name | Type | Required | Description |
 |------|------|------|------|
-| <a id="%2Fproperties%2FobjectArrayProperty%2Fitems%2Fproperties%2FbooleanProperty"></a>booleanProperty | boolean | <span style="color:salmon">false</span> | \- |
+| booleanProperty | boolean | false | \- |
 
 #### Example
 
@@ -60,12 +60,12 @@
 }
 ```
 ---
-### <a id="%2Fproperties%2FnestedArraysAndObjectsProperty%2Fitems"></a>[nestedArraysAndObjectsProperty entry](#%2Fproperties%2FnestedArraysAndObjectsProperty%2Fitems)
+### [nestedArraysAndObjectsProperty entry](#%2Fproperties%2FnestedArraysAndObjectsProperty%2Fitems)
 #### Properties
 
 | Name | Type | Required | Description |
 |------|------|------|------|
-| <a id="%2Fproperties%2FnestedArraysAndObjectsProperty%2Fitems%2Fproperties%2FarrayProp%2Fitems"></a>arrayProp | string\[\] | <span style="color:salmon">false</span> | \- |
+| arrayProp | string\[\] | false | \- |
 
 #### Example
 

meta_configurator/src/utility/documentation/__tests__/samples/composition.expected.md

@@ -51,7 +51,7 @@ Option 2
 
 | Name | Type | Required | Description |
 |------|------|------|------|
-| type | [enum](#%2Fproperties%2FPerson%2FoneOf%2F0%2Fproperties%2Ftype) | false | \- |
+| type | [type](#%2Fproperties%2FPerson%2FoneOf%2F0%2Fproperties%2Ftype) | false | \- |
 | currentSemester | integer | false | \- |
 
 #### Example
@@ -73,7 +73,7 @@ Option 2
 
 | Name | Type | Required | Description |
 |------|------|------|------|
-| type | [enum](#%2Fproperties%2FPerson%2FoneOf%2F1%2Fproperties%2Ftype) | false | \- |
+| type | [type](#%2Fproperties%2FPerson%2FoneOf%2F1%2Fproperties%2Ftype) | false | \- |
 | avgGrade | number | false | \- |
 
 #### Example

meta_configurator/src/utility/documentation/__tests__/samples/enumeration.expected.md

@@ -6,13 +6,13 @@
     - [diet](#%2Fproperties%2Fdiet)
 
 ---
-### <a id="root"></a>[root](#root)
+### [root](#root)
 #### Properties
 
 | Name | Type | Required | Description |
 |------|------|------|------|
-| country | <u>[enum](#%2Fproperties%2Fcountry)</u> | <span style="color:lightblue">true</span> | \- |
-| diet | <u>[enum](#%2Fproperties%2Fdiet)</u> | <span style="color:lightblue">true</span> | \- |
+| country | [country](#%2Fproperties%2Fcountry) | true | \- |
+| diet | [diet](#%2Fproperties%2Fdiet) | true | \- |
 
 #### Example
 
@@ -23,9 +23,9 @@
 }
 ```
 ---
-### <a id="%2Fproperties%2Fcountry"></a>[country](#%2Fproperties%2Fcountry)
-<details>
-<summary>Enumeration Values</summary>
+### [country](#%2Fproperties%2Fcountry)
+
+Enumeration Values
 - `United States`
 - `Canada`
 - `Mexico`
@@ -46,11 +46,11 @@
 - `Russia`
 - `Saudi Arabia`
 - `United Arab Emirates`
-</details>
+
 
 ---
-### <a id="%2Fproperties%2Fdiet"></a>[diet](#%2Fproperties%2Fdiet)
+### [diet](#%2Fproperties%2Fdiet)
 #### Enumeration Values
 - `herbivore`
 - `carnivore`
-- `omnivore`
+- `omnivore`

meta_configurator/src/utility/documentation/__tests__/samples/featureTesting.expected.md

@@ -160,7 +160,7 @@ Conditionals
 |------|------|------|------|------|
 | city | string | false | City name | - |
 | zipCode | string | false | Zip code | "12345" |
-| country | [enum](#%2Fproperties%2Faddress%2Fproperties%2Fcountry) | false | Country name | - |
+| country | [country](#%2Fproperties%2Faddress%2Fproperties%2Fcountry) | false | Country name | - |
 | moreInfo | [moreInfo](#%2Fproperties%2Faddress%2Fproperties%2FmoreInfo) | false | More info about the address | - |
 | street | string | false | Street name | "Main Street" |
 | number | number | false | \- | - |
@@ -259,10 +259,10 @@ Conditionals
 |------|------|------|------|
 | info | string | false | Some info |
 | neighborhood | string | false | Neighborhood name |
-| timeZone | [enum](#%2Fproperties%2Faddress%2Fproperties%2FmoreInfo%2Fproperties%2FtimeZone) | false | Time zone |
+| timeZone | [timeZone](#%2Fproperties%2Faddress%2Fproperties%2FmoreInfo%2Fproperties%2FtimeZone) | false | Time zone |
 | booleanArray | boolean\[\] | false | Boolean array |
 | numbers | number\[\] | false | Numbers |
-| objects | [object\[\]](#%2Fproperties%2Faddress%2Fproperties%2FmoreInfo%2Fproperties%2Fobjects%2Fitems) | false | Objects |
+| objects | [objects entry\[\]](#%2Fproperties%2Faddress%2Fproperties%2FmoreInfo%2Fproperties%2Fobjects%2Fitems) | false | Objects |
 
 #### Example
 

meta_configurator/src/utility/documentation/__tests__/samples/typeDescriptionsSpecialCases.expected.md

@@ -0,0 +1,67 @@
+# Untitled schema
+### Table of Contents
+
+- [root](#root)
+    - [inlinedArray entry](#%2Fproperties%2FinlinedArray%2Fitems)
+    - [ABC](#%2Fproperties%2Fenum)
+    - [enumInDefs](#%2F%24defs%2FenumInDefs)
+    - [constantValue](#%2Fproperties%2FconstantValue)
+
+---
+### [root](#root)
+#### Properties
+
+| Name | Type | Required | Description |
+|------|------|------|------|
+| inlinedArray | [inlinedArray entry\[\]](#%2Fproperties%2FinlinedArray%2Fitems) | false | \- |
+| enum | [ABC](#%2Fproperties%2Fenum) | false | \- |
+| referenceToEnumInDefs | [enumInDefs](#%2F%24defs%2FenumInDefs) | false | \- |
+| constantValue | [constantValue](#%2Fproperties%2FconstantValue) | false | \- |
+
+#### Example
+
+```json
+{
+  "inlinedArray": [
+    {
+      "name": "{string}"
+    }
+  ],
+  "enum": "{string}",
+  "referenceToEnumInDefs": "{integer}",
+  "constantValue": "myConstant"
+}
+```
+---
+### [inlinedArray entry](#%2Fproperties%2FinlinedArray%2Fitems)
+#### Properties
+
+| Name | Type | Required | Description |
+|------|------|------|------|
+| name | string | false | \- |
+
+#### Example
+
+```json
+{
+  "name": "{string}"
+}
+```
+---
+### [ABC](#%2Fproperties%2Fenum)
+#### Enumeration Values
+- `A`
+- `B`
+- `C`
+
+---
+### [enumInDefs](#%2F%24defs%2FenumInDefs)
+#### Enumeration Values
+- `1`
+- `3`
+- `5`
+
+---
+### [constantValue](#%2Fproperties%2FconstantValue)
+#### Enumeration Values
+- `myConstant`

meta_configurator/src/utility/documentation/__tests__/samples/typeDescriptionsSpecialCases.schema.json

@@ -0,0 +1,34 @@
+{
+  "type": "object",
+  "$defs": {
+    "enumInDefs": {
+      "type": "integer",
+      "enum": [1, 3, 5]
+    }
+  },
+  "properties": {
+    "inlinedArray": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string"
+          }
+        }
+      }
+    },
+    "enum": {
+      "title": "ABC",
+      "type": "string",
+      "enum": ["A", "B", "C"]
+    },
+    "referenceToEnumInDefs": {
+      "$ref": "#/$defs/enumInDefs"
+    },
+    "constantValue": {
+      "type": "string",
+      "enum": ["myConstant"]
+    }
+  }
+}