oas-toolkit 0.10.2 → 0.10.4

package/canonical-server.js

@@ -11,6 +11,9 @@ function run(oas) {
   // Extract the base path from servers
   const basePaths = uniqWith(
     oas.servers.map((server) => {
+      if (server.variables) {
+        return null;
+      }
       const path = url.parse(server.url).pathname;
       if (path.slice(-1) === "/") {
         return path.slice(0, -1);
@@ -18,7 +21,11 @@ function run(oas) {
       return path;
     }),
     isEqual
-  );
+  ).filter((n) => n);
+
+  if (basePaths.length === 0) {
+    return oas;
+  }
 
   if (basePaths.length > 1) {
     throw new Error(
@@ -36,6 +43,9 @@ function run(oas) {
 
   // Remove paths from servers
   oas.servers = oas.servers.map((server) => {
+    if (server.variables) {
+      return server;
+    }
     const u = url.parse(server.url);
     return {
       ...server,

package/canonical-server.test.js

@@ -12,13 +12,20 @@ const oas = {
   },
 };
 
-function getOas(urls) {
+function getOas(urls, variables) {
   const o = {
     paths: oas.paths,
   };
 
   if (urls.length > 0) {
     o.servers = urls.map((url) => {
+      if (variables) {
+        return {
+          url,
+          variables,
+        };
+      }
+
       return {
         url,
       };
@@ -36,6 +43,22 @@ describe("#run", () => {
     });
   });
 
+  it("is idempotent", () => {
+    const o = getOas(["https://api.example.com/v1"]);
+
+    const updatedOas = c.run(o);
+    expect(updatedOas.paths).toEqual({
+      "/v1/foo/hello": {},
+      "/v1/foo/world": {},
+    });
+
+    // Run a second time
+    expect(c.run(updatedOas).paths).toEqual({
+      "/v1/foo/hello": {},
+      "/v1/foo/world": {},
+    });
+  });
+
   it("handles multiple servers", () => {
     const o = getOas([
       "https://api.example.com/v1",
@@ -88,4 +111,33 @@ describe("#run", () => {
       },
     });
   });
+
+  it("ignores variable based urls", () => {
+    const vars = {
+      hostname: {
+        default: "localhost",
+        description: "Hostname for Kong's Admin API",
+      },
+      path: {
+        default: "/",
+        description: "Base path for Kong's Admin API",
+      },
+      port: {
+        default: "8001",
+        description: "Port for Kong's Admin API",
+      },
+      protocol: {
+        default: "http",
+        description: "Protocol for requests to Kong's Admin API",
+        enum: ["http", "https"],
+      },
+    };
+    const o = getOas(["{protocol}://{hostname}:{port}{path}"], vars);
+    expect(c.run(o).servers).toEqual([
+      {
+        url: "{protocol}://{hostname}:{port}{path}",
+        variables: vars,
+      },
+    ]);
+  });
 });

package/package.json

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