Merge pull request #72 from advanced-rest-client/fix/W-12428173/type-recursion

[W-12428173] Type recursion

Author: carowright

demo/W-12428173/W-12428173.raml

@@ -0,0 +1,9 @@
+#%RAML 1.0 Library
+usage:
+
+# see https://canda.leanix.net/canda/factsheet/DataObject/ad2b18a7-e768-411d-af15-f0fa5df689cd
+
+types:
+  valueAddedServiceMapping:
+    type: !include ref/value-added-service-mapping-schema.json
+    example: !include ref/value-added-service-mapping-example.json

demo/W-12428173/ref/value-added-service-mapping-example.json

@@ -0,0 +1,3 @@
+{
+		"seasVasLocation" : "SEAS"
+}

demo/W-12428173/ref/value-added-service-mapping-schema.json

@@ -0,0 +1,23 @@
+{
+	"$schema": "http://json-schema.org/draft-04/schema",
+	"description": "Represents data from MPTH70 Value Added Service Mapping For SAP ERP",
+	"type": "object",
+	"properties": {
+		"seasVasLocation": {
+			"type": "string",
+			"description": "VAS Location in case of SEAS where this Value added service will be executed. @since 2023.1",
+			"see" : "https://canda-services.atlassian.net/browse/CARA-75",
+			"anyOf" : [
+                {
+                    "type": "string",
+                    "enum": [ "SEAS", "DC" ]
+                },
+                {
+                    "type": "string",
+                    "description" : "accept any unknown value to be extendable",
+                    "see" : "https://canda-services.atlassian.net/wiki/spaces/IETKB/pages/1390149835/Web+API+Guideline#Versioning"
+                }
+            ]
+		}
+	}
+}

demo/apis.json

@@ -16,6 +16,7 @@
   "array-type/array-type.raml": "RAML 1.0",
   "W-11858334/W-11858334.raml": "RAML 1.0",
   "W-12137562/W-12137562.raml": "RAML 1.0",
+  "W-12428173/W-12428173.raml": "RAML 1.0",
   "APIC-429/APIC-429.yaml": { "type": "OAS 3.0", "mime": "application/yaml" },
   "SE-17897/SE-17897.yaml": { "type": "OAS 3.0", "mime": "application/yaml" },
   "new-oas3-types/new-oas3-types.yaml": { "type": "OAS 3.0", "mime": "application/yaml" },

demo/index.js

@@ -115,6 +115,7 @@ class ApiDemo extends ApiDemoPage {
       ['array-type', 'array-type'],
       ['W-11858334', 'W-11858334'],
       ['W-12137562', 'W-12137562'],
+      ['W-12428173', 'W-12428173'],
     ].map(
       ([file, label]) => html` <anypoint-item data-src="${file}-compact.json"
           >${label} - compact model</anypoint-item

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "@api-components/api-type-document",
   "description": "A documentation table for type (resource) properties. Works with AMF data model",
-  "version": "4.2.22",
+  "version": "4.2.23",
   "license": "Apache-2.0",
   "main": "index.js",
   "module": "index.js",
@@ -45,7 +45,7 @@
     "@open-wc/testing": "^2.5.15",
     "@web/dev-server": "^0.1.24",
     "@web/test-runner": "^0.13.18",
-    "@web/test-runner-playwright": "^0.8.8",
+    "@web/test-runner-playwright": "0.8.10",
     "eslint": "^7.32.0",
     "eslint-config-prettier": "^8.1.0",
     "husky": "^7.0.2",

package.json

@@ -388,6 +388,11 @@ export class ApiTypeDocument extends PropertyDocumentMixin(LitElement) {
         isOneOf = true;
         key = this._getAmfKey(this.ns.w3.shacl.xone);
         this.oneOfTypes = this._computeTypes(type, key);
+      } else if (this._hasProperty(type, this.ns.w3.shacl.or)) {
+        isScalar = false;
+        isAnyOf = true;
+        key = this._getAmfKey(this.ns.w3.shacl.or);
+        this.anyOfTypes = this._computeTypes(type, key);
       }
     } else if (
       this._hasType(type, this.ns.aml.vocabularies.shapes.UnionShape)

src/ApiTypeDocument.js

@@ -0,0 +1,47 @@
+/* eslint-disable prefer-destructuring */
+import {fixture, assert, aTimeout} from '@open-wc/testing'
+import { AmfLoader } from './amf-loader.js';
+import '../api-type-document.js';
+
+/** @typedef {import('..').ApiTypeDocument} ApiTypeDocument */
+/** @typedef {import('..').PropertyShapeDocument} PropertyShapeDocument */
+/** @typedef {import('@api-components/amf-helper-mixin').AmfDocument} AmfDocument */
+
+describe('<api-type-document>', () => {
+  const file = 'W-12428173';
+
+  /**
+   * @returns {Promise<ApiTypeDocument>}
+   */
+  async function basicFixture() {
+    return fixture(`<api-type-document></api-type-document>`);
+  }
+
+  [
+    ['Regular model', false],
+    ['Compact model', true],
+  ].forEach((item) => {
+    describe(String(item[0]), () => {
+      let element = /** @type ApiTypeDocument */ (null);
+      beforeEach(async () => {
+        element = await basicFixture();
+      });
+
+      it('renders complex element', async () => {
+        const data = await AmfLoader.loadType('valueAddedServiceMapping', item[1], file);
+        element.amf = data[0];
+        element.type = data[1];
+        await aTimeout(0);
+
+        const shape = element.shadowRoot.querySelector('property-shape-document')
+        assert.ok(shape);
+
+        /** @type HTMLElement */ (shape.shadowRoot.querySelector('.complex-toggle')).click();
+        await aTimeout(0);
+        await aTimeout(0);
+
+        assert.ok(shape.shadowRoot.querySelector('api-type-document.children.complex'));
+      });
+    });
+  });
+});