@unleash/express-openapi - npm Package Compare versions

Comparing version 0.2.0 to 0.2.1-beta.0

lib/ui.js

@@ -6,4 +6,19 @@ 'use strict'
 module.exports.serveSwaggerUI = function serveSwaggerUI (documentUrl) {
-  return [serve(path.resolve(require.resolve('swagger-ui-dist'), '..'), { index: false }), function renderSwaggerHtml (req, res) {
-    res.type('html').send(renderHtmlPage('Swagger UI', `
+  return [serve(path.resolve(require.resolve('swagger-ui-dist'), '..'), { index: false }),
+    function returnUiInit (req, res, next) {
+      if (req.path.endsWith('/swagger-ui-init.js')) {
+        res.type('.js')
+        res.send(`window.onload = function () {
+  window.ui = SwaggerUIBundle({
+    url: "${documentUrl}",
+    dom_id: '#swagger-ui'
+  })
+}
+        `)
+      } else {
+        next()
+      }
+    },
+    function renderSwaggerHtml (req, res) {
+      res.type('html').send(renderHtmlPage('Swagger UI', `
       <link rel="stylesheet" type="text/css" href="./swagger-ui.css" >
@@ -14,12 +29,6 @@ `, `
       <script src="./swagger-ui-standalone-preset.js"></script>
-      <script>
-        window.onload = function () {
-          window.ui = SwaggerUIBundle({
-            url: "${documentUrl}",
-            dom_id: '#swagger-ui'
-          })
-        }
-      </script>
+      <script src="./swagger-ui-init.js"></script>
     `))
-  }]
+    }
+  ]
 }
@@ -26,0 +35,0 @@

package.json

 {
   "name": "@unleash/express-openapi",
-  "version": "0.2.0",
+  "version": "0.2.1-beta.0",
   "description": "Middleware for generating OpenAPI/Swagger documentation for your Express app",
@@ -5,0 +5,0 @@ "author": "@unleash",

README.md

@@ -7,3 +7,1 @@ # unleash-express-openapi
 2. removes the redoc dependency which we don't use.
-
-The fork is not published to npm, and only used by https://github.com/Unleash/unleash.

test/index.js

@@ -84,2 +84,14 @@ 'use strict'
 
+  test('serves onload function in swagger-ui-init.js file', function (done) {
+    const app = express()
+    app.use(openapi().swaggerui)
+    supertest(app)
+      .get(`${openapi.defaultRoutePrefix}/swagger-ui-init.js`)
+      .end((err, res) => {
+        assert(!err, err)
+        assert(res.text.includes('window.onload = function () {'))
+        done()
+      })
+  })
+
   test('load routes from the express app', function (done) {
@@ -86,0 +98,0 @@ const app = express()

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

34066

increased by2.21%

Number of package files

15

increased by15.38%

Lines of code

997

increased by2.05%

Worsened metrics

Number of lines in readme file

7

decreased by-22.22%

Number of medium supply chain risk alerts

3

increased by50%

No dependency changes