Add flattened config option (#6)

* feat: add flattened option to config

* test: add test for flattened model

* chore(deps): upgrading deps

* 0.2.12

Author: twoplustwoone

index.js

@@ -20,9 +20,10 @@ amf.plugins.features.AMFValidation.register();
  * @param {string} type
  * @param {string} destPath
  * @param {string} resolution
+ * @param {boolean} flattened
  * @return {Promise<void>}
  */
-async function processFile(doc, file, type, destPath, resolution) {
+async function processFile(doc, file, type, destPath, resolution, flattened) {
   let validateProfile;
   switch (type) {
     case 'RAML 1.0': validateProfile = amf.ProfileNames.RAML; break;
@@ -63,13 +64,19 @@ async function processFile(doc, file, type, destPath, resolution) {
   const compactFile = path.join(destPath, compactDest);
 
   // @ts-ignore
-  const fullOpts = amf.render.RenderOptions().withSourceMaps;
+  let fullOpts = amf.render.RenderOptions().withSourceMaps;
+  if (flattened) {
+    fullOpts = fullOpts.withFlattenedJsonLd;
+  }
   const fullData = await generator.generateString(doc, fullOpts);
   await fs.ensureFile(fullFile);
   await fs.writeFile(fullFile, fullData, 'utf8');
 
   // @ts-ignore
-  const compactOpts = amf.render.RenderOptions().withSourceMaps.withCompactUris;
+  let compactOpts = amf.render.RenderOptions().withSourceMaps.withCompactUris;
+  if (flattened) {
+    compactOpts = fullOpts.withFlattenedJsonLd;
+  }
   // withRawSourceMaps.
   const compactData = await generator.generateString(doc, compactOpts);
   await fs.ensureFile(compactFile);
@@ -83,9 +90,9 @@ async function processFile(doc, file, type, destPath, resolution) {
  */
 function normalizeOptions(input) {
   if (Array.isArray(input)) {
-    const [type, mime, resolution] = input;
+    const [type, mime, resolution, flattened] = input;
     // @ts-ignore
-    return { type, mime, resolution };
+    return { type, mime, resolution, flattened };
   }
   if (typeof input === 'object') {
     return input;
@@ -111,10 +118,10 @@ async function parseFile(file, cnf, opts) {
   if (!dest.endsWith('/')) {
     dest += '/';
   }
-  const { type, mime='application/yaml', resolution='editing' } = normalizeOptions(cnf);
+  const { type, mime='application/yaml', resolution='editing', flattened = false } = normalizeOptions(cnf);
   const parser = amf.Core.parser(type, mime);
   const doc = await parser.parseFileAsync(`file://${src}${file}`);
-  return processFile(doc, file, type, dest, resolution);
+  return processFile(doc, file, type, dest, resolution, flattened);
 }
 
 /**

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@api-components/api-model-generator",
-  "version": "0.2.11",
+  "version": "0.2.12",
   "description": "AMF model generator for API components",
   "main": "index.js",
   "scripts": {
@@ -12,7 +12,7 @@
     "email": "arc@mulesoft.com"
   },
   "dependencies": {
-    "amf-client-js": "^4.7.3-1",
+    "amf-client-js": "^4.7.4",
     "fs-extra": "^10.0.0"
   },
   "devDependencies": {
@@ -21,11 +21,11 @@
     "@types/fs-extra": "^9.0.11",
     "@types/mocha": "^8.2.2",
     "chai": "^4.3.4",
-    "eslint": "^7.27.0",
+    "eslint": "^7.29.0",
     "eslint-config-google": "^0.14.0",
     "eslint-config-node": "^4.1.0",
     "eslint-plugin-babel": "^5.3.1",
-    "eslint-plugin-import": "^2.23.3",
+    "eslint-plugin-import": "^2.23.4",
     "eslint-plugin-no-only-tests": "^2.6.0",
     "husky": "^6.0.0",
     "lint-staged": "^11.0.0",

package.json

@@ -154,6 +154,7 @@ describe('API generation', () => {
   describe('Api list config file with options', () => {
     const modelFile = path.join(dest, 'raml1.json');
     const compactModelFile = path.join(dest, 'raml1-compact.json');
+    const flattenedModelFile = path.join(dest, 'flattenedApi-compact.json');
     const configFile = path.join('test', 'apis-options.json');
 
     afterEach(() => fs.remove(dest));
@@ -167,6 +168,16 @@ describe('API generation', () => {
     }));
 
     it('Generates data model for compact model', () => generator(configFile)
+    .then(() => fs.pathExists(flattenedModelFile))
+    .then((exists) => assert.isTrue(exists))
+    .then(() => fs.readJson(flattenedModelFile))
+    .then((data) => {
+      const graph = data['@graph'];
+      assert.isDefined(graph);
+    }));
+
+
+    it('Generates flattened data model', () => generator(configFile)
     .then(() => fs.pathExists(compactModelFile))
     .then((exists) => assert.isTrue(exists))
     .then(() => fs.readJson(compactModelFile))

test/api-generation.test.js

@@ -1,5 +1,6 @@
 {
   "apis/raml1.raml": "RAML 1.0",
+  "apis/flattenedApi.raml": { "type": "RAML 1.0", "flattened": true },
   "src": "test/",
   "dest": "test/playground/"
 }

test/apis-options.json

@@ -0,0 +1,18 @@
+#%RAML 1.0
+title: API body demo
+version: v1
+baseUri: http://domain.com/
+
+/endpoint:
+  post:
+    headers:
+      x-header: string
+    queryParameters:
+      param1: number
+    responses:
+      200:
+        headers:
+          x-response: integer
+        body:
+          application/json:
+            type: object

test/apis/flattenedApi.raml

@@ -15,6 +15,11 @@ export declare interface ApiConfiguration {
    * @default editing
    */
   resolution?: string;
+  /**
+   * Whether to apply flattened to render options
+   * @default false
+   */
+  flattened?: boolean;
 }
 
 export declare interface ApiGenerationOptions {