oas-toolkit 0.4.0 → 0.5.0

package/cli/bin.js

@@ -14,4 +14,9 @@ yargs(hideBin(process.argv))
     "check for conflicting components, paths, tags, and security schemes",
     require("./commands/check-conflicts")
   )
+  .command(
+    "remove-unused-components <openapi.yaml>",
+    "remove unused components from the provided OpenAPI file",
+    require("./commands/remove-unused-components")
+  )
   .parse();

package/cli/commands/remove-unused-components.js

@@ -0,0 +1,25 @@
+const fs = require("fs");
+const yaml = require("js-yaml");
+
+module.exports = async function ({ argv }) {
+  try {
+    const oasFiles = argv._.slice(1);
+    if (oasFiles.length !== 1) {
+      return;
+    }
+
+    const components = require("../../components");
+    let oas = yaml.load(fs.readFileSync(oasFiles[0]));
+
+    const used = components.getReferencedComponents(oas);
+    const defined = components.getDefinedComponents(oas);
+    const unused = components.getUnusedComponents(defined, used);
+
+    oas = components.removeComponents(oas, unused);
+
+    fs.writeFileSync(oasFiles[0], oas);
+  } catch (e) {
+    console.error(`ERROR: ${e.message}`);
+    process.exit(1);
+  }
+};

package/components.js

@@ -0,0 +1,51 @@
+const traverse = require("traverse");
+const get = require("lodash.get");
+const difference = require("lodash.difference");
+
+function removeComponents(oas, unused) {
+  oas = traverse(oas).clone();
+  return traverse(oas).forEach(function (x) {
+    const path = this.path.join(".");
+    if (unused.includes(path)) {
+      this.remove();
+      if (Object.keys(this.parent.node).length === 0) {
+        this.parent.remove();
+      }
+    }
+  });
+}
+
+function getReferencedComponents(oas) {
+  return traverse(oas).reduce(function (acc, x) {
+    if (this.isLeaf && this.key == "$ref") {
+      acc.push(x.replace("#/", "").replace(/\//g, "."));
+    }
+    return acc;
+  }, []);
+}
+
+function getDefinedComponents(oas) {
+  return traverse(oas).reduce(function (acc, x) {
+    if (this.path[0] !== "components") {
+      return acc;
+    }
+
+    // We're at a schema definition
+    if (this.path.length == 3) {
+      acc.push(this.path.join("."));
+    }
+
+    return acc;
+  }, []);
+}
+
+function getUnusedComponents(all, referenced) {
+  return difference(all, referenced);
+}
+
+module.exports = {
+  getReferencedComponents,
+  getDefinedComponents,
+  getUnusedComponents,
+  removeComponents,
+};

package/components.test.js

@@ -0,0 +1,148 @@
+const c = require("./components");
+
+const components = {
+  schemas: {
+    Foo: {
+      type: "object",
+      properties: {
+        bar: { type: "string" },
+        created_at: { type: "string" },
+      },
+    },
+    Baz: {
+      type: "object",
+      properties: {
+        bee: { type: "string" },
+      },
+    },
+  },
+  requestBodies: {
+    CreateFoo: {
+      content: {
+        "application/json": {
+          schema: {
+            type: "object",
+            properties: {
+              bar: { type: "string" },
+            },
+          },
+        },
+      },
+    },
+  },
+};
+
+const oas = {
+  info: { title: "One" },
+  paths: {
+    "/foo": {
+      post: {
+        requestBody: {
+          $ref: "#/components/requestBodies/CreateFoo",
+        },
+        responses: {
+          201: {
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: "#/components/schemas/Foo",
+                },
+              },
+            },
+          },
+        },
+      },
+    },
+  },
+  components,
+};
+
+describe("#components", () => {
+  it("extracts referenced components", () => {
+    expect(c.getReferencedComponents(oas)).toEqual([
+      "components.requestBodies.CreateFoo",
+      "components.schemas.Foo",
+    ]);
+  });
+
+  it("returns unused components (without unused)", () => {
+    expect(
+      c.getUnusedComponents(
+        ["components.schemas.Foo", "components.schemas.Baz"],
+        ["components.schemas.Baz", "components.schemas.Foo"]
+      )
+    ).toEqual([]);
+  });
+
+  it("returns unused components (with unused)", () => {
+    expect(
+      c.getUnusedComponents(
+        ["components.schemas.Foo", "components.schemas.Baz"],
+        ["components.schemas.Baz"]
+      )
+    ).toEqual(["components.schemas.Foo"]);
+  });
+
+  it("returns all defined components)", () => {
+    expect(c.getDefinedComponents(oas)).toEqual([
+      "components.schemas.Foo",
+      "components.schemas.Baz",
+      "components.requestBodies.CreateFoo",
+    ]);
+  });
+
+  it("removed unused components including parent", () => {
+    expect(
+      c.removeComponents({ components }, ["components.requestBodies.CreateFoo"])
+    ).toEqual({
+      components: {
+        schemas: {
+          Foo: {
+            properties: {
+              bar: { type: "string" },
+              created_at: { type: "string" },
+            },
+            type: "object",
+          },
+          Baz: {
+            type: "object",
+            properties: {
+              bee: { type: "string" },
+            },
+          },
+        },
+      },
+    });
+  });
+
+  it("removed unused components but leaves the parent", () => {
+    expect(
+      c.removeComponents({ components }, ["components.schemas.Foo"])
+    ).toEqual({
+      components: {
+        schemas: {
+          Baz: {
+            type: "object",
+            properties: {
+              bee: { type: "string" },
+            },
+          },
+        },
+        requestBodies: {
+          CreateFoo: {
+            content: {
+              "application/json": {
+                schema: {
+                  type: "object",
+                  properties: {
+                    bar: { type: "string" },
+                  },
+                },
+              },
+            },
+          },
+        },
+      },
+    });
+  });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oas-toolkit",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "",
   "main": "index.js",
   "bin": {
@@ -19,9 +19,12 @@
     "debug": "^4.3.4",
     "js-yaml": "^4.1.0",
     "jsonpath-plus": "^7.2.0",
+    "lodash.difference": "^4.5.0",
+    "lodash.get": "^4.4.2",
     "lodash.isequal": "^4.5.0",
     "lodash.uniqwith": "^4.5.0",
     "mergician": "^1.1.0",
+    "traverse": "^0.6.7",
     "yargs": "^17.7.1"
   }
 }