Add better auth support (#74)

Author: bourdakos1

.gitignore

@@ -5,6 +5,8 @@ cypress/screenshots
 # Dist
 build
 dist
+lib
+lib-next
 
 # Dependencies
 /node_modules

cypress/integration/test.spec.ts

@@ -13,4 +13,29 @@ describe("test", () => {
   it("renders query parameters", () => {
     cy.findByText(/query parameters/i).should("exist");
   });
+
+  it("loads when clicking on tabs", () => {
+    cy.on("uncaught:exception", () => {
+      // there is an uncaught error trying to load monaco in ci
+      return false;
+    });
+
+    function checkTab(tab: RegExp, heading: RegExp) {
+      cy.get(".navbar").findByRole("link", { name: tab }).click();
+      cy.findByRole("heading", { name: heading, level: 1 }).should("exist");
+    }
+
+    checkTab(/issue 21/i, /missing summary/i);
+    checkTab(/cos/i, /generating an iam token/i);
+    checkTab(/yaml/i, /hello world/i);
+    checkTab(/api/i, /recursive/i);
+  });
+
+  it("loads a page with authentication", () => {
+    cy.visit("/cos/list-buckets");
+    cy.findByRole("button", { name: /authorize/i }).should("exist");
+
+    cy.visit("/cos/create-a-bucket");
+    cy.findByRole("button", { name: /authorize/i }).should("exist");
+  });
 });

demo/docusaurus.config.js

@@ -146,7 +146,9 @@ const config = {
         theme: lightCodeTheme,
         darkTheme: darkCodeTheme,
       },
-      proxy: "https://cors-anywhere.herokuapp.com",
+      api: {
+        authPersistance: "localStorage",
+      },
     }),
 };
 

demo/examples/openapi-cos.json

@@ -68,6 +68,10 @@
             "schema": { "type": "string" }
           }
         ],
+        "security": [
+          { "BearerAuth": [] },
+          { "BearerAuth": [], "BasicAuth": [] }
+        ],
         "responses": { "200": { "description": "ok" } }
       }
     },
@@ -133,7 +137,10 @@
     }
   },
   "components": {
-    "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer" } },
+    "securitySchemes": {
+      "BearerAuth": { "type": "http", "scheme": "bearer" },
+      "BasicAuth": { "type": "http", "scheme": "basic" }
+    },
     "schemas": {
       "AuthForm": {
         "type": "object",

package.json

@@ -22,15 +22,23 @@
     "release:changelog": "scripts/changelog.ts",
     "release:version": "scripts/version.ts",
     "release:publish": "scripts/publish.ts",
-    "clean": "rm -rf node_modules build demo/.docusaurus demo/build demo/node_modules && find packages -name node_modules -type d -maxdepth 2 -exec rm -rf {} + && find packages -name dist -type d -maxdepth 2 -exec rm -rf {} +"
+    "clean": "rm -rf node_modules build demo/.docusaurus demo/build demo/node_modules && find packages -name node_modules -type d -maxdepth 2 -exec rm -rf {} + && find packages -name dist -type d -maxdepth 2 -exec rm -rf {} + && find packages -name lib -type d -maxdepth 2 -exec rm -rf {} + && find packages -name lib-next -type d -maxdepth 2 -exec rm -rf {} +"
   },
   "devDependencies": {
+    "@babel/cli": "^7.16.0",
+    "@babel/core": "^7.16.0",
+    "@babel/eslint-parser": "^7.16.3",
+    "@babel/plugin-proposal-nullish-coalescing-operator": "^7.16.0",
+    "@babel/plugin-proposal-optional-chaining": "^7.16.0",
+    "@babel/plugin-transform-modules-commonjs": "^7.16.0",
+    "@babel/preset-typescript": "^7.16.0",
     "@testing-library/cypress": "^8.0.1",
     "@types/jest": "^27.0.2",
     "@typescript-eslint/eslint-plugin": "^4.0.0",
     "@typescript-eslint/parser": "^4.0.0",
     "babel-eslint": "^10.0.0",
     "cypress": "^8.7.0",
+    "cross-env": "^7.0.3",
     "eslint": "^7.5.0",
     "eslint-config-react-app": "^6.0.0",
     "eslint-plugin-cypress": "^2.12.1",

packages/docusaurus-plugin-openapi/src/openapi.ts

@@ -231,10 +231,8 @@ export async function loadOpenapi(
         item.security = dereffedSpec.security;
       }
 
-      // TODO: we don't want this behavior anymore, but it might break things
-      // if (i === 0 && ii === 0) {
-      //   item.id = "/";
-      // }
+      // Add security schemes so we know how to handle security.
+      item.securitySchemes = dereffedSpec.components?.securitySchemes;
 
       item.permalink = normalizeUrl([baseUrl, routeBasePath, item.id]);
 

packages/docusaurus-plugin-openapi/src/types.ts

@@ -356,6 +356,13 @@ export interface ApiItem extends OperationObject {
   next: Page;
   previous: Page;
   jsonRequestBodyExample: string;
+  securitySchemes?: Map<
+    | ApiKeySecuritySchemeObject
+    | HttpSecuritySchemeObject
+    | Oauth2SecuritySchemeObject
+    | OpenIdConnectSecuritySchemeObject
+    | ReferenceObject
+  >;
 }
 
 export interface Page {

packages/docusaurus-theme-openapi/babel.config.js

@@ -0,0 +1,35 @@
+/* ============================================================================
+ * Copyright (c) Cloud Annotations
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ * ========================================================================== */
+
+module.exports = {
+  env: {
+    // USED FOR NODE/RUNTIME
+    // maybe we should differenciate both cases because
+    // we mostly need to transpile some features so that node does not crash...
+    lib: {
+      presets: [
+        ["@babel/preset-typescript", { isTSX: true, allExtensions: true }],
+      ],
+      // Useful to transpile for older node versions
+      plugins: [
+        "@babel/plugin-transform-modules-commonjs",
+        "@babel/plugin-proposal-nullish-coalescing-operator",
+        "@babel/plugin-proposal-optional-chaining",
+      ],
+    },
+
+    // USED FOR JS SWIZZLE
+    // /lib-next folder is used as source to swizzle JS source code
+    // This JS code is created from TS source code
+    // This source code should look clean/human readable to be usable
+    "lib-next": {
+      presets: [
+        ["@babel/preset-typescript", { isTSX: true, allExtensions: true }],
+      ],
+    },
+  },
+};

packages/docusaurus-theme-openapi/package.json

@@ -7,13 +7,16 @@
     "access": "public"
   },
   "types": "src/theme-openapi.d.ts",
-  "main": "dist/index.js",
+  "main": "lib/index.js",
   "files": [
     "/dist"
   ],
   "scripts": {
-    "build": "scripts/build.ts",
-    "watch": "scripts/build.ts --watch"
+    "build": "tsc --noEmit && yarn babel:lib && yarn babel:lib-next && yarn format:lib-next",
+    "watch": "concurrently --names \"lib,lib-next,tsc\" --kill-others \"yarn babel:lib --watch\" \"yarn babel:lib-next --watch\" \"yarn tsc --watch\"",
+    "babel:lib": "cross-env BABEL_ENV=lib babel src -d lib --extensions \".tsx,.ts\" --ignore \"**/*.d.ts\" --copy-files",
+    "babel:lib-next": "cross-env BABEL_ENV=lib-next babel src -d lib-next --extensions \".tsx,.ts\" --ignore \"**/*.d.ts\" --copy-files",
+    "format:lib-next": "prettier --config ../../.prettierrc.json --write \"lib-next/**/*.{js,ts,jsx,tsc}\""
   },
   "devDependencies": {
     "@docusaurus/module-type-aliases": "2.0.0-beta.9",