oas-toolkit 0.5.0 → 0.5.2

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

@@ -10,14 +10,8 @@ module.exports = async function ({ argv }) {
 
     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);
+    oas = components.removeUnusedComponents(oas);
+    console.log(yaml.dump(oas));
   } catch (e) {
     console.error(`ERROR: ${e.message}`);
     process.exit(1);

package/components.js

@@ -2,7 +2,15 @@ const traverse = require("traverse");
 const get = require("lodash.get");
 const difference = require("lodash.difference");
 
-function removeComponents(oas, unused) {
+function removeUnusedComponents(oas) {
+  const used = getReferencedComponents(oas);
+  const defined = getDefinedComponents(oas);
+  const unused = getUnusedComponents(defined, used);
+
+  return removeSpecifiedComponents(oas, unused);
+}
+
+function removeSpecifiedComponents(oas, unused) {
   oas = traverse(oas).clone();
   return traverse(oas).forEach(function (x) {
     const path = this.path.join(".");
@@ -16,12 +24,23 @@ function removeComponents(oas, unused) {
 }
 
 function getReferencedComponents(oas) {
-  return traverse(oas).reduce(function (acc, x) {
+  const components = traverse(oas).reduce(function (acc, x) {
     if (this.isLeaf && this.key == "$ref") {
       acc.push(x.replace("#/", "").replace(/\//g, "."));
     }
     return acc;
   }, []);
+
+  // Add security schemes
+  if (oas.security){
+    for (let item of oas.security){
+      for (let key of Object.keys(item)){
+        components.push(`components.securitySchemes.${key}`)
+      }
+    }
+  }
+
+  return components;
 }
 
 function getDefinedComponents(oas) {
@@ -47,5 +66,6 @@ module.exports = {
   getReferencedComponents,
   getDefinedComponents,
   getUnusedComponents,
-  removeComponents,
+  removeSpecifiedComponents,
+  removeUnusedComponents,
 };

package/components.test.js

@@ -1,6 +1,12 @@
 const c = require("./components");
 
 const components = {
+  securitySchemes: {
+    personalAccessToken: {
+      type: "http",
+      scheme: "bearer",
+    },
+  },
   schemas: {
     Foo: {
       type: "object",
@@ -34,6 +40,7 @@ const components = {
 
 const oas = {
   info: { title: "One" },
+  security: [{ personalAccessToken: {} }],
   paths: {
     "/foo": {
       post: {
@@ -62,6 +69,7 @@ describe("#components", () => {
     expect(c.getReferencedComponents(oas)).toEqual([
       "components.requestBodies.CreateFoo",
       "components.schemas.Foo",
+      "components.securitySchemes.personalAccessToken",
     ]);
   });
 
@@ -85,6 +93,7 @@ describe("#components", () => {
 
   it("returns all defined components)", () => {
     expect(c.getDefinedComponents(oas)).toEqual([
+      "components.securitySchemes.personalAccessToken",
       "components.schemas.Foo",
       "components.schemas.Baz",
       "components.requestBodies.CreateFoo",
@@ -93,9 +102,17 @@ describe("#components", () => {
 
   it("removed unused components including parent", () => {
     expect(
-      c.removeComponents({ components }, ["components.requestBodies.CreateFoo"])
+      c.removeSpecifiedComponents({ components }, [
+        "components.requestBodies.CreateFoo",
+      ])
     ).toEqual({
       components: {
+        securitySchemes: {
+          personalAccessToken: {
+            type: "http",
+            scheme: "bearer",
+          },
+        },
         schemas: {
           Foo: {
             properties: {
@@ -117,9 +134,15 @@ describe("#components", () => {
 
   it("removed unused components but leaves the parent", () => {
     expect(
-      c.removeComponents({ components }, ["components.schemas.Foo"])
+      c.removeSpecifiedComponents({ components }, ["components.schemas.Foo"])
     ).toEqual({
       components: {
+        securitySchemes: {
+          personalAccessToken: {
+            type: "http",
+            scheme: "bearer",
+          },
+        },
         schemas: {
           Baz: {
             type: "object",
@@ -145,4 +168,94 @@ describe("#components", () => {
       },
     });
   });
+
+  it("autodiscovers and removes unused components", () => {
+    expect(c.removeUnusedComponents(oas)).toEqual({
+      info: { title: "One" },
+      security: [{ personalAccessToken: {} }],
+      paths: {
+        "/foo": {
+          post: {
+            requestBody: {
+              $ref: "#/components/requestBodies/CreateFoo",
+            },
+            responses: {
+              201: {
+                content: {
+                  "application/json": {
+                    schema: {
+                      $ref: "#/components/schemas/Foo",
+                    },
+                  },
+                },
+              },
+            },
+          },
+        },
+      },
+      components: {
+        schemas: {
+          Foo: {
+            type: "object",
+            properties: {
+              bar: { type: "string" },
+              created_at: { type: "string" },
+            },
+          },
+        },
+        securitySchemes: {
+          personalAccessToken: {
+            type: "http",
+            scheme: "bearer",
+          },
+        },
+        requestBodies: {
+          CreateFoo: {
+            content: {
+              "application/json": {
+                schema: {
+                  type: "object",
+                  properties: {
+                    bar: { type: "string" },
+                  },
+                },
+              },
+            },
+          },
+        },
+      },
+    });
+  });
+
+  it("removes unused security schemes", () => {
+    const securityOas = {
+      info: { title: "One" },
+      security: [{ personalAccessToken: {} }],
+      components: {
+        securitySchemes: {
+          personalAccessToken: {
+            type: "http",
+            scheme: "bearer",
+          },
+          systemAccessToken: {
+            type: "http",
+            scheme: "bearer",
+          },
+        },
+      },
+    };
+
+    expect(c.removeUnusedComponents(securityOas)).toEqual({
+      info: { title: "One" },
+      security: [{ personalAccessToken: {} }],
+      components: {
+        securitySchemes: {
+          personalAccessToken: {
+            type: "http",
+            scheme: "bearer",
+          },
+        },
+      },
+    });
+  });
 });

package/index.js

@@ -0,0 +1,4 @@
+module.exports = {
+  components: require("./components"),
+  merger: require("./merger"),
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oas-toolkit",
-  "version": "0.5.0",
+  "version": "0.5.2",
   "description": "",
   "main": "index.js",
   "bin": {