@midwayjs/swagger 3.13.9 → 3.13.10-beta.2

package/dist/config/config.default.js

@@ -1,10 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.swagger = void 0;
+const render_1 = require("../ui/render");
 exports.swagger = {
     title: 'My Project',
     description: 'This is a swagger-ui for midwayjs project',
     version: '1.0.0',
     swaggerPath: '/swagger-ui',
+    swaggerUIRender: render_1.renderSwaggerUIRemote,
+    swaggerUIRenderOptions: {},
 };
 //# sourceMappingURL=config.default.js.map

package/dist/index.d.ts

@@ -3,4 +3,5 @@ export * from './interfaces';
 export { SwaggerConfiguration as Configuration } from './configuration';
 export { SwaggerExplorer } from './swaggerExplorer';
 export { SwaggerMiddleware } from './swaggerMiddleware';
+export { renderSwaggerUIRemote, renderSwaggerUIDist, renderJSON, } from './ui/render';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SwaggerMiddleware = exports.SwaggerExplorer = exports.Configuration = void 0;
+exports.renderJSON = exports.renderSwaggerUIDist = exports.renderSwaggerUIRemote = exports.SwaggerMiddleware = exports.SwaggerExplorer = exports.Configuration = void 0;
 __exportStar(require("./decorators"), exports);
 __exportStar(require("./interfaces"), exports);
 var configuration_1 = require("./configuration");
@@ -23,4 +23,8 @@ var swaggerExplorer_1 = require("./swaggerExplorer");
 Object.defineProperty(exports, "SwaggerExplorer", { enumerable: true, get: function () { return swaggerExplorer_1.SwaggerExplorer; } });
 var swaggerMiddleware_1 = require("./swaggerMiddleware");
 Object.defineProperty(exports, "SwaggerMiddleware", { enumerable: true, get: function () { return swaggerMiddleware_1.SwaggerMiddleware; } });
+var render_1 = require("./ui/render");
+Object.defineProperty(exports, "renderSwaggerUIRemote", { enumerable: true, get: function () { return render_1.renderSwaggerUIRemote; } });
+Object.defineProperty(exports, "renderSwaggerUIDist", { enumerable: true, get: function () { return render_1.renderSwaggerUIDist; } });
+Object.defineProperty(exports, "renderJSON", { enumerable: true, get: function () { return render_1.renderJSON; } });
 //# sourceMappingURL=index.js.map

package/dist/interfaces/index.d.ts

@@ -2,7 +2,8 @@
  * inspired by https://github.com/metadevpro/openapi3-ts
  * @see https://github.com/OAI/OpenAPI-Specification/blob/3.0.0-rc0/versions/3.0.md
  */
-import type { RouterOption } from '@midwayjs/core';
+import { RouterOption } from '@midwayjs/core';
+import { SwaggerExplorer } from '../swaggerExplorer';
 export interface OpenAPIObject {
     openapi: string;
     info: InfoObject;
@@ -363,5 +364,10 @@ export interface SwaggerOptions {
          */
         operationIdFactory?: (controllerKey: string, webRouter: RouterOption) => string;
     };
+    swaggerUIRender?: (config: SwaggerOptions, swaggerExplorer: SwaggerExplorer, swaggerRenderOptions?: any) => (pathname: string) => Promise<{
+        ext: string;
+        content: any;
+    }>;
+    swaggerUIRenderOptions?: Record<string, any>;
 }
 //# sourceMappingURL=index.d.ts.map

package/dist/swaggerMiddleware.d.ts

@@ -1,12 +1,11 @@
 import { IMiddleware, IMidwayApplication, IMidwayContext, NextFunction, MidwayEnvironmentService } from '@midwayjs/core';
 export declare class SwaggerMiddleware implements IMiddleware<IMidwayContext, NextFunction, unknown> {
     private swaggerConfig;
-    private swaggerUiAssetPath;
+    private swaggerRender;
     private swaggerExplorer;
     environmentService: MidwayEnvironmentService;
     init(): Promise<void>;
     resolve(app: IMidwayApplication): (req: any, res: any, next: NextFunction) => Promise<any>;
-    replaceInfo(content: string): string;
     static getName(): string;
 }
 //# sourceMappingURL=swaggerMiddleware.d.ts.map

package/dist/swaggerMiddleware.js

@@ -11,106 +11,66 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SwaggerMiddleware = void 0;
 const core_1 = require("@midwayjs/core");
-const fs_1 = require("fs");
-const path_1 = require("path");
 const swaggerExplorer_1 = require("./swaggerExplorer");
 let SwaggerMiddleware = class SwaggerMiddleware {
     async init() {
-        const { getAbsoluteFSPath } = (0, core_1.safeRequire)('swagger-ui-dist');
-        if (getAbsoluteFSPath) {
-            this.swaggerUiAssetPath = getAbsoluteFSPath();
-        }
-        else {
-            throw new core_1.MidwayCommonError('swagger-ui-dist is not installed');
+        if (typeof this.swaggerConfig.swaggerUIRender !== 'function') {
+            throw new core_1.MidwayInvalidConfigPropertyError('swagger.swaggerRender');
         }
+        this.swaggerRender = this.swaggerConfig.swaggerUIRender(this.swaggerConfig, this.swaggerExplorer);
     }
     resolve(app) {
         if (app.getFrameworkType() === core_1.MidwayFrameworkType.WEB_EXPRESS) {
             return async (req, res, next) => {
                 const pathname = req.path;
-                if (!this.swaggerUiAssetPath ||
-                    pathname.indexOf(this.swaggerConfig.swaggerPath) === -1) {
+                const renderResult = await this.swaggerRender(pathname);
+                if (renderResult) {
+                    const { ext, content } = renderResult;
+                    if (ext === '.js') {
+                        res.type('application/javascript');
+                    }
+                    else if (ext === '.map') {
+                        res.type('application/json');
+                    }
+                    else if (ext === '.css') {
+                        res.type('text/css');
+                    }
+                    else if (ext === '.png') {
+                        res.type('image/png');
+                    }
+                    res.send(content);
+                }
+                else {
                     return next();
                 }
-                const arr = pathname.split('/');
-                let lastName = arr.pop();
-                if (lastName === 'index.json') {
-                    res.send(this.swaggerExplorer.getData());
-                    return;
-                }
-                if (!lastName) {
-                    lastName = 'index.html';
-                }
-                let content = (0, fs_1.readFileSync)((0, path_1.join)(this.swaggerUiAssetPath, lastName));
-                if (lastName === 'index.html' ||
-                    lastName === 'swagger-initializer.js') {
-                    content = content.toString('utf8');
-                    content = this.replaceInfo(content);
-                }
-                const ext = (0, path_1.extname)(lastName);
-                if (ext === '.js') {
-                    res.type('application/javascript');
-                }
-                else if (ext === '.map') {
-                    res.type('application/json');
-                }
-                else if (ext === '.css') {
-                    res.type('text/css');
-                }
-                else if (ext === '.png') {
-                    res.type('image/png');
-                }
-                res.send(content);
             };
         }
         else {
             return async (ctx, next) => {
                 const pathname = ctx.path;
-                if (!this.swaggerUiAssetPath ||
-                    pathname.indexOf(this.swaggerConfig.swaggerPath) === -1) {
+                const renderResult = await this.swaggerRender(pathname);
+                if (renderResult) {
+                    const { ext, content } = renderResult;
+                    if (ext === '.js') {
+                        ctx.set('Content-Type', 'application/javascript');
+                    }
+                    else if (ext === '.map') {
+                        ctx.set('Content-Type', 'application/json');
+                    }
+                    else if (ext === '.css') {
+                        ctx.set('Content-Type', 'text/css');
+                    }
+                    else if (ext === '.png') {
+                        ctx.set('Content-Type', 'image/png');
+                    }
+                    ctx.body = content;
+                }
+                else {
                     return next();
                 }
-                const arr = pathname.split('/');
-                let lastName = arr.pop();
-                if (lastName === 'index.json') {
-                    ctx.body = this.swaggerExplorer.getData();
-                    return;
-                }
-                if (!lastName) {
-                    lastName = 'index.html';
-                }
-                let content = (0, fs_1.readFileSync)((0, path_1.join)(this.swaggerUiAssetPath, lastName));
-                if (lastName === 'index.html' ||
-                    lastName === 'swagger-initializer.js') {
-                    content = content.toString('utf8');
-                    content = this.replaceInfo(content);
-                }
-                const ext = (0, path_1.extname)(lastName);
-                if (ext === '.js') {
-                    ctx.set('Content-Type', 'application/javascript');
-                }
-                else if (ext === '.map') {
-                    ctx.set('Content-Type', 'application/json');
-                }
-                else if (ext === '.css') {
-                    ctx.set('Content-Type', 'text/css');
-                }
-                else if (ext === '.png') {
-                    ctx.set('Content-Type', 'image/png');
-                }
-                ctx.body = content;
             };
         }
     }
-    replaceInfo(content) {
-        let str = `location.href.replace('${this.swaggerConfig.swaggerPath}/index.html', '${this.swaggerConfig.swaggerPath}/index.json'),\n validatorUrl: null,`;
-        if (this.swaggerConfig.displayOptions) {
-            Object.keys(this.swaggerConfig.displayOptions).forEach(key => {
-                str += `\n${key}: ${this.swaggerConfig.displayOptions[key]},`;
-            });
-        }
-        return content.replace('"https://petstore.swagger.io/v2/swagger.json",', str);
-    }
     static getName() {
         return 'swagger';
     }

package/dist/ui/render.d.ts

@@ -0,0 +1,18 @@
+import type { SwaggerOptions } from '../interfaces';
+import { SwaggerExplorer } from '../swaggerExplorer';
+export declare function renderSwaggerUIDist(swaggerConfig: SwaggerOptions, swaggerExplorer: SwaggerExplorer): (pathname: string) => Promise<{
+    ext: string;
+    content: any;
+}>;
+export declare function renderJSON(swaggerConfig: SwaggerOptions, swaggerExplorer: SwaggerExplorer): (pathname: string) => Promise<{
+    ext: string;
+    content: Omit<import("../interfaces").OpenAPIObject, "paths">;
+}>;
+export declare function renderSwaggerUIRemote(swaggerConfig: SwaggerOptions, swaggerExplorer: SwaggerExplorer, swaggerRenderOptions: any): (pathname: string) => Promise<{
+    ext: string;
+    content: Omit<import("../interfaces").OpenAPIObject, "paths">;
+} | {
+    ext: string;
+    content: string;
+}>;
+//# sourceMappingURL=render.d.ts.map

package/dist/ui/render.js

@@ -0,0 +1,79 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderSwaggerUIRemote = exports.renderJSON = exports.renderSwaggerUIDist = void 0;
+const core_1 = require("@midwayjs/core");
+const fs_1 = require("fs");
+const path_1 = require("path");
+function renderSwaggerUIDist(swaggerConfig, swaggerExplorer) {
+    const { getAbsoluteFSPath } = (0, core_1.safeRequire)('swagger-ui-dist');
+    if (!getAbsoluteFSPath) {
+        throw new core_1.MidwayCommonError('swagger-ui-dist is not installed');
+    }
+    function replaceInfo(content) {
+        let str = `location.href.replace('${swaggerConfig.swaggerPath}/index.html', '${swaggerConfig.swaggerPath}/index.json'),\n validatorUrl: null,`;
+        if (swaggerConfig.displayOptions) {
+            Object.keys(swaggerConfig.displayOptions).forEach(key => {
+                str += `\n${key}: ${swaggerConfig.displayOptions[key]},`;
+            });
+        }
+        return content.replace('"https://petstore.swagger.io/v2/swagger.json",', str);
+    }
+    const swaggerUiAssetPath = getAbsoluteFSPath();
+    return async (pathname) => {
+        if (!swaggerUiAssetPath ||
+            pathname.indexOf(swaggerConfig.swaggerPath) === -1) {
+            return;
+        }
+        const arr = pathname.split('/');
+        let lastName = arr.pop();
+        if (lastName === 'index.json') {
+            return { ext: 'json', content: swaggerExplorer.getData() };
+        }
+        if (!lastName) {
+            lastName = 'index.html';
+        }
+        let content = (0, fs_1.readFileSync)((0, path_1.join)(swaggerUiAssetPath, lastName));
+        if (lastName === 'index.html' || lastName === 'swagger-initializer.js') {
+            content = content.toString('utf8');
+            content = replaceInfo(content);
+        }
+        const ext = (0, path_1.extname)(lastName);
+        return { ext, content };
+    };
+}
+exports.renderSwaggerUIDist = renderSwaggerUIDist;
+function renderJSON(swaggerConfig, swaggerExplorer) {
+    return async (pathname) => {
+        if (pathname.indexOf(swaggerConfig.swaggerPath) === -1) {
+            return;
+        }
+        if (pathname === 'index.json') {
+            return { ext: 'json', content: swaggerExplorer.getData() };
+        }
+        return;
+    };
+}
+exports.renderJSON = renderJSON;
+function renderSwaggerUIRemote(swaggerConfig, swaggerExplorer, swaggerRenderOptions) {
+    const indexPagePath = (swaggerRenderOptions === null || swaggerRenderOptions === void 0 ? void 0 : swaggerRenderOptions.indexPagePath) || (0, path_1.join)(__dirname, '../../index.html');
+    return async (pathname) => {
+        if (pathname.indexOf(swaggerConfig.swaggerPath) === -1) {
+            return;
+        }
+        const arr = pathname.split('/');
+        let lastName = arr.pop();
+        if (lastName === 'index.json') {
+            return { ext: 'json', content: swaggerExplorer.getData() };
+        }
+        if (!lastName) {
+            lastName = 'index.html';
+        }
+        if (lastName === 'index.html') {
+            const content = (0, fs_1.readFileSync)(indexPagePath, 'utf8');
+            return { ext: 'html', content };
+        }
+        return;
+    };
+}
+exports.renderSwaggerUIRemote = renderSwaggerUIRemote;
+//# sourceMappingURL=render.js.map

package/dist/ui.d.ts

@@ -0,0 +1,10 @@
+import type { SwaggerOptions } from './interfaces';
+export declare function renderSwaggerUI(swaggerConfig: SwaggerOptions): (pathname: string) => Promise<{
+    ext: string;
+    content: any;
+}>;
+export declare function renderJSON(swaggerConfig: SwaggerOptions): (pathname: string) => Promise<{
+    ext: string;
+    content: any;
+}>;
+//# sourceMappingURL=ui.d.ts.map

package/dist/ui.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.renderJSON = exports.renderSwaggerUI = void 0;
+const core_1 = require("@midwayjs/core");
+const fs_1 = require("fs");
+const path_1 = require("path");
+function renderSwaggerUI(swaggerConfig) {
+    const { getAbsoluteFSPath } = (0, core_1.safeRequire)('swagger-ui-dist');
+    if (!getAbsoluteFSPath) {
+        throw new core_1.MidwayCommonError('swagger-ui-dist is not installed');
+    }
+    function replaceInfo(content) {
+        let str = `location.href.replace('${this.swaggerConfig.swaggerPath}/index.html', '${this.swaggerConfig.swaggerPath}/index.json'),\n validatorUrl: null,`;
+        if (this.swaggerConfig.displayOptions) {
+            Object.keys(this.swaggerConfig.displayOptions).forEach(key => {
+                str += `\n${key}: ${this.swaggerConfig.displayOptions[key]},`;
+            });
+        }
+        return content.replace('"https://petstore.swagger.io/v2/swagger.json",', str);
+    }
+    const swaggerUiAssetPath = getAbsoluteFSPath();
+    return async (pathname) => {
+        if (!swaggerUiAssetPath ||
+            pathname.indexOf(swaggerConfig.swaggerPath) === -1) {
+            return;
+        }
+        const arr = pathname.split('/');
+        let lastName = arr.pop();
+        if (lastName === 'index.json') {
+            return { ext: 'json', content: this.swaggerExplorer.getData() };
+        }
+        if (!lastName) {
+            lastName = 'index.html';
+        }
+        let content = (0, fs_1.readFileSync)((0, path_1.join)(swaggerUiAssetPath, lastName));
+        if (lastName === 'index.html' || lastName === 'swagger-initializer.js') {
+            content = content.toString('utf8');
+            content = replaceInfo(content);
+        }
+        const ext = (0, path_1.extname)(lastName);
+        return { ext, content };
+    };
+}
+exports.renderSwaggerUI = renderSwaggerUI;
+function renderJSON(swaggerConfig) {
+    return async (pathname) => {
+        if (pathname.indexOf(swaggerConfig.swaggerPath) === -1) {
+            return;
+        }
+        if (pathname === 'index.json') {
+            return { ext: 'json', content: this.swaggerExplorer.getData() };
+        }
+        return;
+    };
+}
+exports.renderJSON = renderJSON;
+//# sourceMappingURL=ui.js.map

package/index.html

@@ -0,0 +1,32 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <meta
+            name="description"
+            content="SwaggerUI"
+    />
+    <title>SwaggerUI</title>
+    <link rel="stylesheet" href="https://unpkg.com/swagger-ui-dist@5.10.5/swagger-ui.css" />
+</head>
+<body>
+<div id="swagger-ui"></div>
+<script src="https://unpkg.com/swagger-ui-dist@5.10.5/swagger-ui-bundle.js" crossorigin></script>
+<script src="https://unpkg.com/swagger-ui-dist@5.10.5/swagger-ui-standalone-preset.js" crossorigin></script>
+<script>
+  window.onload = () => {
+    window.ui = SwaggerUIBundle({
+      url: '/swagger-ui/index.json',
+      dom_id: '#swagger-ui',
+      presets: [
+        SwaggerUIBundle.presets.apis,
+        SwaggerUIStandalonePreset
+      ],
+      layout: 'StandaloneLayout',
+      persistAuthorization: true,
+    });
+  };
+</script>
+</body>
+</html>

package/package.json

@@ -1,12 +1,13 @@
 {
   "name": "@midwayjs/swagger",
-  "version": "3.13.9",
+  "version": "3.13.10-beta.2",
   "main": "dist/index.js",
   "typings": "index.d.ts",
   "files": [
     "dist/**/*.js",
     "dist/**/*.d.ts",
-    "index.d.ts"
+    "index.d.ts",
+    "index.html"
   ],
   "devDependencies": {
     "@midwayjs/core": "^3.13.7",
@@ -26,6 +27,5 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/midwayjs/midway.git"
-  },
-  "gitHead": "00750219506f4e3ad0e1dbb167d295610005b328"
+  }
 }

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2013 - Now midwayjs
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.