@midwayjs/swagger 3.13.10-beta.2 → 3.14.1

package/LICENSE

@@ -0,0 +1,21 @@
+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.

package/dist/config/config.default.js

@@ -2,12 +2,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.swagger = void 0;
 const render_1 = require("../ui/render");
+const core_1 = require("@midwayjs/core");
+const swaggerDist = (0, core_1.safeRequire)('swagger-ui-dist');
 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,
+    swaggerUIRender: swaggerDist && swaggerDist.getAbsoluteFSPath
+        ? render_1.renderSwaggerUIDist
+        : render_1.renderSwaggerUIRemote,
     swaggerUIRenderOptions: {},
 };
 //# sourceMappingURL=config.default.js.map

package/dist/documentBuilder.js

@@ -68,21 +68,27 @@ class DocumentBuilder {
         return undefined;
     }
     addTag(name, description = '', externalDocs) {
+        const tags = this.document.tags || [];
         if (Array.isArray(name)) {
             const arr = name;
             for (const s of arr) {
-                this.document.tags.push({
-                    name: s,
-                    description: '',
-                });
+                if (!tags.find(tag => tag.name === name)) {
+                    tags.push({
+                        name: s,
+                        description: '',
+                    });
+                }
             }
             return this;
         }
-        this.document.tags.push({
-            name,
-            description,
-            externalDocs,
-        });
+        if (!tags.find(tag => tag.name === name)) {
+            tags.push({
+                name,
+                description,
+                externalDocs,
+            });
+        }
+        this.document.tags = tags;
         return this;
     }
     addSecurity(name, options) {

package/dist/index.d.ts

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

package/dist/index.js

@@ -27,4 +27,5 @@ 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; } });
+__exportStar(require("./constants"), exports);
 //# sourceMappingURL=index.js.map

package/dist/swaggerExplorer.js

@@ -182,7 +182,7 @@ let SwaggerExplorer = class SwaggerExplorer {
      * 构造 router 提取方法
      */
     generateRouteMethod(url, webRouter, paths, metaForMethods, routerArgs, headers, target) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o;
         const operMeta = metaForMethods.filter(item => item.key === constants_1.DECORATORS.API_OPERATION &&
             item.propertyName === webRouter.method)[0];
         let opts = paths[url];
@@ -196,6 +196,10 @@ let SwaggerExplorer = class SwaggerExplorer {
             operationId: this.getOperationId(target.name, webRouter),
             tags: ((_c = operMeta === null || operMeta === void 0 ? void 0 : operMeta.metadata) === null || _c === void 0 ? void 0 : _c.tags) || [],
         };
+        if (((_d = operMeta === null || operMeta === void 0 ? void 0 : operMeta.metadata) === null || _d === void 0 ? void 0 : _d.deprecated) != null) {
+            opts[webRouter.requestMethod].deprecated =
+                !!((_e = operMeta === null || operMeta === void 0 ? void 0 : operMeta.metadata) === null || _e === void 0 ? void 0 : _e.deprecated);
+        }
         /**
          * [{"key":"web:router_param","parameterIndex":1,"propertyName":"create","metadata":{"type":2}},
          * {"key":"web:router_param","parameterIndex":0,"propertyName":"create","metadata":{"type":1,"propertyData":"createCatDto"}}]
@@ -208,8 +212,8 @@ let SwaggerExplorer = class SwaggerExplorer {
         for (const arg of args) {
             const currentType = types[arg.parameterIndex];
             const p = {
-                name: (_e = (_d = arg === null || arg === void 0 ? void 0 : arg.metadata) === null || _d === void 0 ? void 0 : _d.propertyData) !== null && _e !== void 0 ? _e : '',
-                in: convertTypeToString((_f = arg.metadata) === null || _f === void 0 ? void 0 : _f.type),
+                name: (_g = (_f = arg === null || arg === void 0 ? void 0 : arg.metadata) === null || _f === void 0 ? void 0 : _f.propertyData) !== null && _g !== void 0 ? _g : '',
+                in: convertTypeToString((_h = arg.metadata) === null || _h === void 0 ? void 0 : _h.type),
                 required: false,
             };
             if (p.in === 'path') {
@@ -242,7 +246,7 @@ let SwaggerExplorer = class SwaggerExplorer {
             }
             else {
                 p.schema = {
-                    type: convertSchemaType((_g = currentType === null || currentType === void 0 ? void 0 : currentType.name) !== null && _g !== void 0 ? _g : currentType),
+                    type: convertSchemaType((_j = currentType === null || currentType === void 0 ? void 0 : currentType.name) !== null && _j !== void 0 ? _j : currentType),
                 };
             }
             this.parseFromParamsToP(params[params.length - 1 - arg.parameterIndex], p);
@@ -251,7 +255,7 @@ let SwaggerExplorer = class SwaggerExplorer {
                     continue;
                 }
                 // 这里兼容一下 @File()、@Files()、@Fields() 装饰器
-                if (((_h = arg.metadata) === null || _h === void 0 ? void 0 : _h.type) === core_1.RouteParamTypes.FILESSTREAM) {
+                if (((_k = arg.metadata) === null || _k === void 0 ? void 0 : _k.type) === core_1.RouteParamTypes.FILESSTREAM) {
                     p.schema = {
                         type: 'object',
                         properties: {
@@ -267,7 +271,7 @@ let SwaggerExplorer = class SwaggerExplorer {
                     };
                     p.contentType = _1.BodyContentType.Multipart;
                 }
-                if (((_j = arg.metadata) === null || _j === void 0 ? void 0 : _j.type) === core_1.RouteParamTypes.FILESTREAM) {
+                if (((_l = arg.metadata) === null || _l === void 0 ? void 0 : _l.type) === core_1.RouteParamTypes.FILESTREAM) {
                     p.schema = {
                         type: 'object',
                         properties: {
@@ -280,7 +284,7 @@ let SwaggerExplorer = class SwaggerExplorer {
                     };
                     p.contentType = _1.BodyContentType.Multipart;
                 }
-                if (((_k = arg.metadata) === null || _k === void 0 ? void 0 : _k.type) === core_1.RouteParamTypes.FIELDS) {
+                if (((_m = arg.metadata) === null || _m === void 0 ? void 0 : _m.type) === core_1.RouteParamTypes.FIELDS) {
                     this.expandSchemaRef(p);
                     p.contentType = _1.BodyContentType.Multipart;
                 }
@@ -300,8 +304,8 @@ let SwaggerExplorer = class SwaggerExplorer {
                 }
                 else {
                     // 这里拼 schema properties 时肯定存在
-                    Object.assign({}, (_l = opts[webRouter.requestMethod].requestBody.content[p.contentType]
-                        .schema) === null || _l === void 0 ? void 0 : _l.properties, p.schema.properties);
+                    Object.assign({}, (_o = opts[webRouter.requestMethod].requestBody.content[p.contentType]
+                        .schema) === null || _o === void 0 ? void 0 : _o.properties, p.schema.properties);
                 }
                 delete p.contentType;
                 delete p.content;

package/dist/ui/render.d.ts

@@ -1,6 +1,9 @@
+/// <reference types="node" />
 import type { SwaggerOptions } from '../interfaces';
 import { SwaggerExplorer } from '../swaggerExplorer';
-export declare function renderSwaggerUIDist(swaggerConfig: SwaggerOptions, swaggerExplorer: SwaggerExplorer): (pathname: string) => Promise<{
+export declare function renderSwaggerUIDist(swaggerConfig: SwaggerOptions, swaggerExplorer: SwaggerExplorer, swaggerRenderOptions?: {
+    customInitializer?: Buffer | string;
+}): (pathname: string) => Promise<{
     ext: string;
     content: any;
 }>;
@@ -8,7 +11,9 @@ export declare function renderJSON(swaggerConfig: SwaggerOptions, swaggerExplore
     ext: string;
     content: Omit<import("../interfaces").OpenAPIObject, "paths">;
 }>;
-export declare function renderSwaggerUIRemote(swaggerConfig: SwaggerOptions, swaggerExplorer: SwaggerExplorer, swaggerRenderOptions: any): (pathname: string) => Promise<{
+export declare function renderSwaggerUIRemote(swaggerConfig: SwaggerOptions, swaggerExplorer: SwaggerExplorer, swaggerRenderOptions?: {
+    indexPagePath?: string;
+}): (pathname: string) => Promise<{
     ext: string;
     content: Omit<import("../interfaces").OpenAPIObject, "paths">;
 } | {

package/dist/ui/render.js

@@ -4,11 +4,20 @@ exports.renderSwaggerUIRemote = exports.renderJSON = exports.renderSwaggerUIDist
 const core_1 = require("@midwayjs/core");
 const fs_1 = require("fs");
 const path_1 = require("path");
-function renderSwaggerUIDist(swaggerConfig, swaggerExplorer) {
+function renderSwaggerUIDist(swaggerConfig, swaggerExplorer, swaggerRenderOptions) {
     const { getAbsoluteFSPath } = (0, core_1.safeRequire)('swagger-ui-dist');
     if (!getAbsoluteFSPath) {
         throw new core_1.MidwayCommonError('swagger-ui-dist is not installed');
     }
+    swaggerRenderOptions = swaggerRenderOptions || {};
+    if (swaggerRenderOptions.customInitializer) {
+        if ((0, path_1.isAbsolute)(swaggerRenderOptions.customInitializer)) {
+            swaggerRenderOptions.customInitializer = (0, fs_1.readFileSync)(swaggerRenderOptions.customInitializer);
+        }
+        else {
+            throw new core_1.MidwayInvalidConfigPropertyError('swagger.swaggerRenderOptions.customInitializer', ['Buffer', 'String']);
+        }
+    }
     function replaceInfo(content) {
         let str = `location.href.replace('${swaggerConfig.swaggerPath}/index.html', '${swaggerConfig.swaggerPath}/index.json'),\n validatorUrl: null,`;
         if (swaggerConfig.displayOptions) {
@@ -33,6 +42,10 @@ function renderSwaggerUIDist(swaggerConfig, swaggerExplorer) {
             lastName = 'index.html';
         }
         let content = (0, fs_1.readFileSync)((0, path_1.join)(swaggerUiAssetPath, lastName));
+        if (lastName === 'swagger-initializer.js' &&
+            (swaggerRenderOptions === null || swaggerRenderOptions === void 0 ? void 0 : swaggerRenderOptions.customInitializer)) {
+            return { ext: 'js', content: swaggerRenderOptions.customInitializer };
+        }
         if (lastName === 'index.html' || lastName === 'swagger-initializer.js') {
             content = content.toString('utf8');
             content = replaceInfo(content);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/swagger",
-  "version": "3.13.10-beta.2",
+  "version": "3.14.1",
   "main": "dist/index.js",
   "typings": "index.d.ts",
   "files": [
@@ -10,10 +10,10 @@
     "index.html"
   ],
   "devDependencies": {
-    "@midwayjs/core": "^3.13.7",
-    "@midwayjs/koa": "^3.13.9",
-    "@midwayjs/mock": "^3.13.9",
-    "@midwayjs/validate": "^3.13.9",
+    "@midwayjs/core": "^3.14.0",
+    "@midwayjs/koa": "^3.14.0",
+    "@midwayjs/mock": "^3.14.0",
+    "@midwayjs/validate": "^3.14.0",
     "swagger-ui-dist": "4.19.1"
   },
   "author": "Kurten Chan <chinkurten@gmail.com>",
@@ -27,5 +27,6 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/midwayjs/midway.git"
-  }
+  },
+  "gitHead": "74e08b9ee946e1aad1197c7d23f6b3165393a4a2"
 }

package/dist/ui.d.ts

@@ -1,10 +0,0 @@
-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

@@ -1,57 +0,0 @@
-"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