oas-toolkit 0.9.0 → 0.10.0

package/canonical-server.js

@@ -0,0 +1,47 @@
+const isEqual = require("lodash.isequal");
+const uniqWith = require("lodash.uniqwith");
+const url = require("url");
+function run(oas) {
+  oas = JSON.parse(JSON.stringify(oas)); // Prevent modification of original object
+
+  // Extract the base path from servers
+  const basePaths = uniqWith(
+    oas.servers.map((server) => {
+      const path = url.parse(server.url).pathname;
+      if (path.slice(-1) === "/") {
+        return path.slice(0, -1);
+      }
+      return path;
+    }),
+    isEqual
+  );
+
+  if (basePaths.length > 1) {
+    throw new Error(
+      `Base paths are different in the servers block. Found: ${basePaths.join(
+        ", "
+      )}`
+    );
+  }
+
+  for (let path in oas.paths) {
+    let newPath = basePaths[0] + path;
+    oas.paths[newPath] = oas.paths[path];
+    delete oas.paths[path];
+  }
+
+  // Remove paths from servers
+  oas.servers = oas.servers.map((server) => {
+    const u = url.parse(server.url);
+    return {
+      ...server,
+      url: `${u.protocol}//${u.hostname}/`,
+    };
+  });
+
+  return oas;
+}
+
+module.exports = {
+  run,
+};

package/canonical-server.test.js

@@ -0,0 +1,77 @@
+const c = require("./canonical-server");
+
+const oas = {
+  servers: [
+    {
+      url: "https://api.example.com/v1",
+    },
+  ],
+  paths: {
+    "/foo/hello": {},
+    "/foo/world": {},
+  },
+};
+
+function getOas(urls) {
+  return {
+    servers: urls.map((url) => {
+      return {
+        url,
+      };
+    }),
+    paths: oas.paths,
+  };
+}
+
+describe("#run", () => {
+  it("prefixes all routes", () => {
+    const o = getOas(["https://api.example.com/v1"]);
+    expect(c.run(o).paths).toEqual({
+      "/v1/foo/hello": {},
+      "/v1/foo/world": {},
+    });
+  });
+
+  it("handles multiple servers", () => {
+    const o = getOas([
+      "https://api.example.com/v1",
+      "https://stagingapi.example.com/v1",
+    ]);
+    expect(c.run(o).paths).toEqual({
+      "/v1/foo/hello": {},
+      "/v1/foo/world": {},
+    });
+  });
+
+  it("handles trailing slashes", () => {
+    const o = getOas([
+      "https://api.example.com/v1/",
+      "https://stagingapi.example.com/v1/",
+    ]);
+    expect(c.run(o).paths).toEqual({
+      "/v1/foo/hello": {},
+      "/v1/foo/world": {},
+    });
+  });
+
+  it("throws if the paths are different in a single OAS", () => {
+    const o = getOas([
+      "https://api.example.com/v1",
+      "https://api.example.com/v2",
+    ]);
+    expect(() => c.run(o).paths).toThrow(
+      "Base paths are different in the servers block. Found: /v1, /v2"
+    );
+  });
+
+  it("rewrites the servers", () => {
+    const o = getOas([
+      "https://api.example.com/v1",
+      "https://stagingapi.example.com/v1",
+    ]);
+    expect(c.run(o).servers).toEqual([
+      { url: "https://api.example.com/" },
+      { url: "https://stagingapi.example.com/" },
+    ]);
+  });
+});

package/cli/bin.js

@@ -5,22 +5,22 @@ const { hideBin } = require("yargs/helpers");
 
 yargs(hideBin(process.argv))
   .command(
-    "merge <openapi.yaml> <...more.yaml>",
+    "merge <openapi> <...more.yaml>",
     "merge the provided OpenAPI files",
     require("./commands/merge")
   )
   .command(
-    "check-conflicts <openapi.yaml> <...more.yaml>",
+    "check-conflicts <openapi> <...more.yaml>",
     "check for conflicting components, paths, tags, and security schemes",
     require("./commands/check-conflicts")
   )
   .command(
-    "remove-unused-components <openapi.yaml>",
+    "remove-unused-components <openapi>",
     "remove unused components from the provided OpenAPI file",
     require("./commands/remove-unused-components")
   )
   .command(
-    "remove-unused-tags <openapi.yaml>",
+    "remove-unused-tags <openapi>",
     "remove unused tags from the provided OpenAPI file",
     require("./commands/remove-unused-tags")
   )
@@ -61,4 +61,16 @@ yargs(hideBin(process.argv))
     },
     require("./commands/rewrite-path")
   )
+  .command(
+    "canonical-server <openapi>",
+    "move the path from the servers block in to /paths",
+    (yargs) => {
+      yargs.positional("openapi", {
+        require: true,
+        describe: "the OpenAPI file to rewrite",
+        type: "string",
+      });
+    },
+    require("./commands/canonical-server")
+  )
   .parse();

package/cli/commands/canonical-server.js

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

package/package.json

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