Updated swagger-ui-dist to 4.13.2 and added support for Swagger UI OAuth2 redirect with oauth2-redirect.html as default (#4)

Author: blueswen

CHANGELOG

@@ -1,3 +1,8 @@
+mkdocs-swagger-ui-tag 0.4.1 (2022-08-16)
+
+    * Added support for Swagger UI OAuth2 redirect with oauth2-redirect.html as default (#4)
+    * Updated swagger-ui-dist to 4.13.2
+
 mkdocs-swagger-ui-tag 0.4.0 (2022-07-31)
 
     * Added support for Swagger UI initOAuth method (#4)

README.md

@@ -21,7 +21,7 @@ A MkDocs plugin supports for add [Swagger UI](https://github.com/swagger-api/swa
 1. Python Package
     1. beautifulsoup4>=4.11.1
 2. [Swagger UI dist](https://www.npmjs.com/package/swagger-ui-dist) javascript file and css file
-    1. swagger-ui-dist>=4.13.0
+    1. swagger-ui-dist==4.13.2
 
 ## Usage
 
@@ -65,7 +65,7 @@ A MkDocs plugin supports for add [Swagger UI](https://github.com/swagger-api/swa
     | filter                 | String or Boolean | Default: False. If set, enables filtering. The top bar will show an edit box that you can use to filter the tagged operations that are shown. Can be Boolean to enable or disable, or a string, in which case filtering will be enabled using that string as the filter expression. Filtering is case sensitive matching the filter expression anywhere inside the tag.                       |
     | syntaxHighlightTheme   | String            | Default: "agate". [Highlight.js](https://highlightjs.org/static/demo/) syntax coloring theme to use. It can be "agate", "arta", "monokai", "nord", "obsidian" or "tomorrow-night"                                                                                                                                                                                                             |
     | tryItOutEnabled        | Boolean           | Default: False. Controls whether the "Try it out" section should be enabled by default.                                                                                                                                                                                                                                                                                                       |
-    | oauth2RedirectUrl      | String            | Default: None. OAuth redirect URL.                                                                                                                                                                                                                                                                                                                                                            |
+    | oauth2RedirectUrl      | String            | Default: [site url]/assets/swagger-ui/oauth2-redirect.html. OAuth redirect URL.                                                                                                                                                                                                                                                                                                               |
     | supportedSubmitMethods | Array             | Default: All Http Methods. Array=["get", "put", "post", "delete", "options", "head", "patch", "trace"]. List of HTTP methods that have the "Try it out" feature enabled. An empty array disables "Try it out" for all operations. This does not filter the operations from the display.                                                                                                       |
     | validatorUrl           | String            | Default: "https://validator.swagger.io/validator". By default, Swagger UI attempts to validate specs against swagger.io's online validator in multiple OAS Swagger UI. You can use this parameter to set a different validator URL, for example for locally deployed validators ([Validator Badge](https://github.com/swagger-api/validator-badge)). Setting it "none" to disable validation. |
 

mkdocs_swagger_ui_tag/plugin.py

@@ -3,7 +3,7 @@
 import os
 import uuid
 from urllib.parse import unquote as urlunquote
-from urllib.parse import urlsplit, urlunsplit
+from urllib.parse import urlsplit, urlunsplit, urljoin
 
 from bs4 import BeautifulSoup
 from jinja2 import Environment, FileSystemLoader
@@ -109,7 +109,7 @@ def on_post_page(self, output, page, config, **kwargs):
             cur_id = str(uuid.uuid4())[:8]
             iframe_filename = f"swagger-{cur_id}.html"
             iframe_id_list.append(cur_id)
-            cur_options = self.process_options(swagger_ui_ele)
+            cur_options = self.process_options(config, swagger_ui_ele)
             cur_oath2_prop = self.process_oath2_prop(swagger_ui_ele)
 
             openapi_spec_url = self.path_to_url(page.file,
@@ -140,7 +140,7 @@ def on_post_page(self, output, page, config, **kwargs):
                 openapi_spec_url.append({"url": cur_url, "name": cur_name})
 
             # only use options from first grouped swagger ui tag
-            cur_options = self.process_options(grouped_list[0])
+            cur_options = self.process_options(config, grouped_list[0])
             cur_oath2_prop = self.process_oath2_prop(grouped_list[0])
             output_from_parsed_template = template.render(
                 css_dir=css_dir,
@@ -222,7 +222,7 @@ def replace_with_iframe(self, soup, swagger_ui_ele, cur_id,
         iframe['class'] = "swagger-ui-iframe"
         swagger_ui_ele.replaceWith(iframe)
 
-    def process_options(self, swagger_ui_ele):
+    def process_options(self, config, swagger_ui_ele):
         """ Retrieve Swagger UI options from attribute and use config options as default """
         global_options = {
             k: v
@@ -254,6 +254,8 @@ def process_options(self, swagger_ui_ele):
         if "syntaxHighlightTheme" in cur_options:
             cur_options["syntaxHighlight.theme"] = cur_options.pop(
                 "syntaxHighlightTheme")
+        if "oauth2RedirectUrl" not in cur_options:
+            cur_options["oauth2RedirectUrl"] = urljoin(config['site_url'], "assets/swagger-ui/oauth2-redirect.html")
         return cur_options
 
     def process_oath2_prop(self, swagger_ui_ele):
@@ -311,3 +313,10 @@ def on_post_build(self, config, **kwargs):
             utils.copy_file(
                 os.path.join(base_path, "swagger-ui", "javascripts",
                              file_name), os.path.join(js_path, file_name))
+
+        swagger_ui_path = os.path.join(output_base_path, "swagger-ui")
+        if not os.path.exists(swagger_ui_path):
+            os.mkdir(swagger_ui_path)
+        utils.copy_file(
+            os.path.join(base_path, "swagger-ui", "oauth2-redirect.html"),
+            os.path.join(swagger_ui_path, "oauth2-redirect.html"))

mkdocs_swagger_ui_tag/swagger-ui/javascripts/swagger-initializer.js

@@ -0,0 +1,79 @@
+<!doctype html>
+<html lang="en-US">
+<head>
+    <title>Swagger UI: OAuth2 Redirect</title>
+</head>
+<body>
+<script>
+    'use strict';
+    function run () {
+        var oauth2 = window.opener.swaggerUIRedirectOauth2;
+        var sentState = oauth2.state;
+        var redirectUrl = oauth2.redirectUrl;
+        var isValid, qp, arr;
+
+        if (/code|token|error/.test(window.location.hash)) {
+            qp = window.location.hash.substring(1);
+        } else {
+            qp = location.search.substring(1);
+        }
+
+        arr = qp.split("&");
+        arr.forEach(function (v,i,_arr) { _arr[i] = '"' + v.replace('=', '":"') + '"';});
+        qp = qp ? JSON.parse('{' + arr.join() + '}',
+                function (key, value) {
+                    return key === "" ? value : decodeURIComponent(value);
+                }
+        ) : {};
+
+        isValid = qp.state === sentState;
+
+        if ((
+          oauth2.auth.schema.get("flow") === "accessCode" ||
+          oauth2.auth.schema.get("flow") === "authorizationCode" ||
+          oauth2.auth.schema.get("flow") === "authorization_code"
+        ) && !oauth2.auth.code) {
+            if (!isValid) {
+                oauth2.errCb({
+                    authId: oauth2.auth.name,
+                    source: "auth",
+                    level: "warning",
+                    message: "Authorization may be unsafe, passed state was changed in server. The passed state wasn't returned from auth server."
+                });
+            }
+
+            if (qp.code) {
+                delete oauth2.state;
+                oauth2.auth.code = qp.code;
+                oauth2.callback({auth: oauth2.auth, redirectUrl: redirectUrl});
+            } else {
+                let oauthErrorMsg;
+                if (qp.error) {
+                    oauthErrorMsg = "["+qp.error+"]: " +
+                        (qp.error_description ? qp.error_description+ ". " : "no accessCode received from the server. ") +
+                        (qp.error_uri ? "More info: "+qp.error_uri : "");
+                }
+
+                oauth2.errCb({
+                    authId: oauth2.auth.name,
+                    source: "auth",
+                    level: "error",
+                    message: oauthErrorMsg || "[Authorization failed]: no accessCode received from the server."
+                });
+            }
+        } else {
+            oauth2.callback({auth: oauth2.auth, token: qp, isValid: isValid, redirectUrl: redirectUrl});
+        }
+        window.close();
+    }
+
+    if (document.readyState !== 'loading') {
+        run();
+    } else {
+        document.addEventListener('DOMContentLoaded', function () {
+            run();
+        });
+    }
+</script>
+</body>
+</html>

mkdocs_swagger_ui_tag/swagger-ui/javascripts/swagger-ui-bundle.js

@@ -1,5 +1,5 @@
 {
     "dependencies": {
-        "swagger-ui-dist": "4.13.0"
+        "swagger-ui-dist": "4.13.2"
     }
 }

mkdocs_swagger_ui_tag/swagger-ui/javascripts/swagger-ui-bundle.js.map

@@ -4,7 +4,7 @@
     long_description = f.read()
 
 setup(name="mkdocs-swagger-ui-tag",
-      version="0.4.0",
+      version="0.4.1",
       author="Blueswen",
       author_email="[email protected]",
       url="https://blueswen.github.io/mkdocs-swagger-ui-tag",

mkdocs_swagger_ui_tag/swagger-ui/javascripts/swagger-ui-standalone-preset.js

@@ -0,0 +1,24 @@
+if [ -z "$1" ]
+  then
+    echo "No version supplied"
+    exit 1
+fi
+
+VER="$1"
+DEST="./mkdocs_swagger_ui_tag/swagger-ui"
+SOURCE="https://raw.githubusercontent.com/swagger-api/swagger-ui/$1/dist"
+JS_LIST="swagger-ui-bundle.js.map swagger-ui-standalone-preset.js.map swagger-ui-bundle.js swagger-ui-standalone-preset.js"
+CSS_LIST="swagger-ui.css swagger-ui.css.map"
+HTML_LIST="oauth2-redirect.html"
+
+for f in $JS_LIST; do
+    wget ${SOURCE}/${f} -O ${DEST}/javascripts/${f}
+done
+
+for f in $CSS_LIST; do
+    wget ${SOURCE}/${f} -O ${DEST}/stylesheets/${f}
+done
+
+for f in $HTML_LIST; do
+    wget ${SOURCE}/${f} -O ${DEST}/${f}
+done