Add AMF model expander (#42)

* chore(deps): add amf-json-ld-lib to deps

* chore(deps): update api-model-generator

* feat: expand amf model if it is in flattened form

* chore(test): add flattened api

* test: add test for flattened model assigning

* chore(deps): update deps

* 4.4.0

* chore(deps): update api-model-generator

* fix: expand model manually, keep old flattened model to avoid re-renders

* test: add expanded-api, add deep equal test for flattened model

* chore: remove debugger

* chore: remove console.log

* fix: move oldFlattened check to avoid incorrect setter cut-offs

Author: twoplustwoone

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "@api-components/amf-helper-mixin",
   "description": "A mixin with common functions user by most AMF components to compute AMF values",
-  "version": "4.3.12",
+  "version": "4.4.0",
   "license": "Apache-2.0",
   "main": "index.js",
   "module": "index.js",
@@ -29,20 +29,20 @@
     "email": "[email protected]"
   },
   "devDependencies": {
-    "@api-components/api-model-generator": "^0.2.11",
+    "@api-components/api-model-generator": "^0.2.13",
     "@open-wc/eslint-config": "^4.3.0",
     "@open-wc/testing": "^2.5.33",
     "@web/dev-server": "^0.1.17",
-    "@web/test-runner": "^0.13.5",
+    "@web/test-runner": "^0.13.12",
     "@web/test-runner-playwright": "^0.8.6",
-    "eslint": "^7.28.0",
+    "eslint": "^7.29.0",
     "eslint-config-prettier": "^8.3.0",
     "husky": "^6.0.0",
     "lint-staged": "^11.0.0",
     "lit-element": "^2.5.1",
     "lit-html": "^1.4.1",
     "sinon": "^11.1.1",
-    "typescript": "^4.3.2",
+    "typescript": "^4.3.4",
     "typescript-lit-html-plugin": "^0.9.0"
   },
   "scripts": {
@@ -85,5 +85,8 @@
     "*.js": [
       "eslint --fix"
     ]
+  },
+  "dependencies": {
+    "amf-json-ld-lib": "0.0.13"
   }
 }

package.json

@@ -11,6 +11,8 @@ WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 License for the specific language governing permissions and limitations under
 the License.
 */
+// @ts-ignore
+import { AmfModelExpander, JsonLdOptions, JsonLd } from 'amf-json-ld-lib'
 import { ns } from './Namespace.js';
 
 /** @typedef {import('./Namespace').ns} Namespace */
@@ -78,11 +80,23 @@ export const AmfHelperMixin = (base) => class extends base {
     if (old === value) {
       return;
     }
+    let expanded;
+    if (!value || AmfModelExpander.isInExpandedForm(value)) {
+      this._flattenedAmf = undefined;
+      expanded = value;
+    } else {
+      const oldFlattened = this._flattenedAmf;
+      if (oldFlattened === value) {
+        return;
+      }
+      this._flattenedAmf = value;
+      expanded = this._expand(value);
+    }
     // Cached keys cannot be static as this element can be using in the sane
     // document with different AMF models
     this.__cachedKeys = {};
-    this._amf = value;
-    this.__amfChanged(value);
+    this._amf = expanded;
+    this.__amfChanged(expanded);
     if (this.requestUpdate) {
       this.requestUpdate('amf', old);
     }
@@ -98,6 +112,22 @@ export const AmfHelperMixin = (base) => class extends base {
   /* eslint-disable-next-line no-unused-vars */
   __amfChanged(amf) {}
 
+  /**
+   * Expands flattened AMF model
+   * @param {Object} amf 
+   */
+  _expand(amf) {
+    AmfModelExpander.preprocessLegacyRootNodeId(amf)
+    const linkEmbeddingFilter = key => !key.endsWith("fixPoint")
+    const rootNode = amf['@context'] ? '' : "amf://id";
+    const options = JsonLdOptions.apply()
+      .withEmbeddedLinks(linkEmbeddingFilter)
+      .withCompactedIris()
+      .withExpandedStructure()
+      .withRootNode(rootNode)
+    return JsonLd.process(amf, options)
+  }
+
   /**
    * Returns compact model key for given value.
    * @param {string} property AMF original property

src/AmfHelperMixin.js

@@ -1,4 +1,4 @@
-import { assert, fixture, html } from '@open-wc/testing';
+import { assert, fixture, html, nextFrame } from '@open-wc/testing';
 import sinon from 'sinon';
 import { AmfLoader } from './amf-loader.js';
 import './test-element.js';
@@ -2466,6 +2466,38 @@ describe('AmfHelperMixin', () => {
           assert.deepEqual(element.__cachedKeys, {});
         });
       });
+
+      describe('Expander', async () => {
+        const flattenedApi = 'flattened-api'
+        const expandedApi = 'expanded-api'
+        let flattenedModel;
+        let expandedModel;
+
+        before(async () => {
+          flattenedModel = await AmfLoader.load(compact, flattenedApi);
+          expandedModel = await AmfLoader.load(compact, expandedApi);
+        });
+
+        beforeEach(async () => {
+          element = await basicFixture();
+        });
+
+        it('should not call __amfChanged again if same flattened model is set', async () => {
+          element.amf = flattenedModel;
+          await nextFrame();
+          const spy = sinon.spy(element, '__amfChanged');
+          element.amf = flattenedModel;
+          await nextFrame();
+          assert.isTrue(spy.notCalled);
+        });
+
+        it('should create same object for flattened as originial expanded', async () => {
+          const expandedElement = await modelFixture(expandedModel);
+          element.amf = flattenedModel;
+          await nextFrame();
+          assert.deepEqual(element.amf, expandedElement.amf)
+        });
+      });
     });
   });
 });

test/amf-helper-mixin.test.js

@@ -3,6 +3,8 @@
   "SE-12957/SE-12957.json": "OAS 2.0",
   "multiple-servers/multiple-servers.yaml": { "type": "OAS 3.0", "mime": "application/yaml" },
   "async-api/async-api.yaml": "ASYNC 2.0",
+  "flattened-api/flattened-api.raml": { "type": "RAML 1.0", "mime": "application/yaml", "flattened": true },
+  "expanded-api/expanded-api.raml": { "type": "RAML 1.0", "mime": "application/yaml", "flattened": false },
   "src": "test",
   "dest": "test"
 }

test/apis.json

@@ -0,0 +1,8 @@
+#%RAML 1.0
+title: Simple API
+
+/people:
+  get:
+  post:
+  put:
+  patch:

test/expanded-api/expanded-api.raml

@@ -0,0 +1,8 @@
+#%RAML 1.0
+title: Simple API
+
+/people:
+  get:
+  post:
+  put:
+  patch: