oas-toolkit 0.10.4 → 0.12.0

package/cli/bin.js

@@ -5,8 +5,14 @@ const { hideBin } = require("yargs/helpers");
 
 yargs(hideBin(process.argv))
   .command(
-    "merge <openapi> <...more.yaml>",
+    "merge <openapi...>",
     "merge the provided OpenAPI files",
+    (yargs) => {
+      yargs.option("move-path-to-operation", {
+        demandOption: false,
+        type: "boolean",
+      });
+    },
     require("./commands/merge")
   )
   .command(
@@ -73,4 +79,16 @@ yargs(hideBin(process.argv))
     },
     require("./commands/canonical-server")
   )
+  .command(
+    "expand-allof <openapi>",
+    "Remove allOf from a schema by merging them in to a single entity",
+    (yargs) => {
+      yargs.positional("openapi", {
+        require: true,
+        describe: "the OpenAPI file to rewrite",
+        type: "string",
+      });
+    },
+    require("./commands/expand-allof")
+  )
   .parse();

package/cli/commands/expand-allof.js

@@ -0,0 +1,14 @@
+const fs = require("fs");
+const yaml = require("js-yaml");
+
+module.exports = async function (argv) {
+  try {
+    const expand = require("../../expand-allof");
+    let oas = yaml.load(fs.readFileSync(argv.openapi));
+    oas = expand(oas);
+    console.log(yaml.dump(oas));
+  } catch (e) {
+    console.error(`ERROR: ${e.message}`);
+    process.exit(1);
+  }
+};

package/cli/commands/merge.js

@@ -1,20 +1,22 @@
 const fs = require("fs");
 const yaml = require("js-yaml");
 
-module.exports = function ({ argv }) {
+module.exports = function (argv, b, c) {
   try {
-    const oasFiles = argv._.slice(1);
-    if (oasFiles.length < 2) {
-      return;
-    }
+    const oasFiles = argv.openapi;
 
     const merger = require("../../merger");
+    const canonical = require("../../canonical-server");
 
-    const oas = [];
+    let oas = [];
     for (let f of oasFiles) {
       oas.push(yaml.load(fs.readFileSync(f)));
     }
 
+    if (argv.movePathToOperation) {
+      oas = oas.map((o) => canonical.run(o));
+    }
+
     const combined = merger(oas, argv);
     console.log(yaml.dump(combined));
   } catch (e) {

package/expand-allof.js

@@ -0,0 +1,27 @@
+const traverse = require("traverse");
+const mergician = require("mergician");
+const { dereferenceSync } = require("dereference-json-schema");
+
+module.exports = function (oas) {
+  // We only want to dereference in oas.components
+  const componentsOnly = {
+    components: oas.components,
+  };
+
+  oas.components = dereferenceSync(componentsOnly).components;
+  oas = traverse(oas).clone();
+
+  oas = traverse(oas).map(function (x) {
+    const path = this.path.join(".");
+    if (!path.startsWith("components")) {
+      return;
+    }
+    if (!this.node || !this.node["allOf"]) {
+      return;
+    }
+
+    return mergician({}, ...this.node["allOf"]);
+  });
+
+  return oas;
+};

package/expand-allof.test.js

@@ -0,0 +1,187 @@
+const expand = require("./expand-allof");
+
+it("merges allOf in to a single entity", () => {
+  const result = expand({
+    components: {
+      schemas: {
+        User: {
+          allOf: [
+            {
+              type: "object",
+              properties: {
+                name: {
+                  type: "string",
+                },
+              },
+            },
+            {
+              type: "object",
+              properties: {
+                age: {
+                  type: "number",
+                },
+              },
+            },
+          ],
+        },
+      },
+    },
+  });
+  expect(result).toEqual({
+    components: {
+      schemas: {
+        User: {
+          type: "object",
+          properties: {
+            name: {
+              type: "string",
+            },
+            age: {
+              type: "number",
+            },
+          },
+        },
+      },
+    },
+  });
+});
+
+it("dereferences before merging allOf", () => {
+  const result = expand({
+    components: {
+      schemas: {
+        User: {
+          allOf: [
+            {
+              $ref: "#/components/schemas/Name",
+            },
+            {
+              type: "object",
+              properties: {
+                age: {
+                  type: "number",
+                },
+              },
+            },
+          ],
+        },
+        Name: {
+          type: "object",
+          properties: {
+            name: {
+              type: "string",
+            },
+          },
+        },
+      },
+    },
+  });
+
+  expect(result).toEqual({
+    components: {
+      schemas: {
+        User: {
+          type: "object",
+          properties: {
+            name: {
+              type: "string",
+            },
+            age: {
+              type: "number",
+            },
+          },
+        },
+        Name: {
+          type: "object",
+          properties: {
+            name: {
+              type: "string",
+            },
+          },
+        },
+      },
+    },
+  });
+});
+
+it("allows for required field overrides", () => {
+  const result = expand({
+    components: {
+      schemas: {
+        User: {
+          type: "object",
+          properties: {
+            name: {
+              type: "string",
+            },
+            age: {
+              type: "number",
+            },
+          },
+        },
+        CreateUserRequest: {
+          allOf: [
+            {
+              $ref: "#/components/schemas/User",
+            },
+            {
+              required: ["name"],
+            },
+          ],
+        },
+        UserResponse: {
+          allOf: [
+            {
+              $ref: "#/components/schemas/User",
+            },
+            {
+              required: ["name", "age"],
+            },
+          ],
+        },
+      },
+    },
+  });
+
+  expect(result).toEqual({
+    components: {
+      schemas: {
+        User: {
+          type: "object",
+          properties: {
+            name: {
+              type: "string",
+            },
+            age: {
+              type: "number",
+            },
+          },
+        },
+        CreateUserRequest: {
+          type: "object",
+          properties: {
+            name: {
+              type: "string",
+            },
+            age: {
+              type: "number",
+            },
+          },
+          required: ["name"],
+        },
+        UserResponse: {
+          type: "object",
+          properties: {
+            name: {
+              type: "string",
+            },
+            age: {
+              type: "number",
+            },
+          },
+          required: ["name", "age"],
+        },
+      },
+    },
+  });
+});

package/index.js

@@ -1,6 +1,9 @@
 module.exports = {
+  canonicalServer: require("./canonical-server"),
   components: require("./components"),
+  expandAllOf: require("./expand-allof"),
   merger: require("./merger"),
+  removeWithAnnotation: require("./remove-with-annotation"),
+  rewritePath: require("./rewrite-path"),
   tags: require("./tags"),
-  canonicalServer: require("./canonical-server"),
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oas-toolkit",
-  "version": "0.10.4",
+  "version": "0.12.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -17,6 +17,7 @@
   },
   "dependencies": {
     "debug": "^4.3.4",
+    "dereference-json-schema": "^0.2.1",
     "js-yaml": "^4.1.0",
     "jsonpath-plus": "^7.2.0",
     "lodash.difference": "^4.5.0",