koa2-swagger-ui 5.0.5 → 5.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.hbs +3 -0
- package/dist/index.js +13 -9
- package/dist/index.js.map +1 -1
- package/package.json +20 -20
package/dist/index.hbs
CHANGED
|
@@ -80,6 +80,9 @@ function HideTopbarPlugin() {
|
|
|
80
80
|
|
|
81
81
|
window.onload = function() {
|
|
82
82
|
const options = {{{json swaggerOptions}}};
|
|
83
|
+
{{#isset swaggerOptions.onComplete}}
|
|
84
|
+
options.onComplete = {{{strfnc swaggerOptions.onComplete}}};
|
|
85
|
+
{{/isset}}
|
|
83
86
|
{{#isset swaggerOptions.requestInterceptor}}
|
|
84
87
|
options.requestInterceptor = {{{strfnc swaggerOptions.requestInterceptor}}};
|
|
85
88
|
{{/isset}}
|
package/dist/index.js
CHANGED
|
@@ -21,9 +21,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
|
|
|
21
21
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
22
22
|
exports.koaSwagger = void 0;
|
|
23
23
|
const fs_1 = require("fs");
|
|
24
|
+
const path_1 = require("path");
|
|
24
25
|
const Handlebars = __importStar(require("handlebars"));
|
|
25
26
|
const lodash_1 = require("lodash");
|
|
26
|
-
const path_1 = require("path");
|
|
27
27
|
const read_pkg_up_1 = require("read-pkg-up");
|
|
28
28
|
const defaultOptions = {
|
|
29
29
|
title: 'Swagger UI',
|
|
@@ -42,37 +42,41 @@ const defaultOptions = {
|
|
|
42
42
|
};
|
|
43
43
|
function koaSwagger(config = {}) {
|
|
44
44
|
if (config.swaggerVersion === undefined) {
|
|
45
|
-
const pkg = read_pkg_up_1.sync({ cwd: __dirname });
|
|
45
|
+
const pkg = (0, read_pkg_up_1.sync)({ cwd: __dirname });
|
|
46
46
|
if (pkg === undefined) {
|
|
47
47
|
throw new Error('Package not found');
|
|
48
48
|
}
|
|
49
|
-
defaultOptions.swaggerVersion =
|
|
49
|
+
defaultOptions.swaggerVersion =
|
|
50
|
+
pkg.packageJson.devDependencies['swagger-ui-dist'];
|
|
50
51
|
}
|
|
51
52
|
// Setup icons
|
|
52
53
|
const extFavicon = config.favicon;
|
|
53
|
-
const faviconPath = path_1.join(__dirname, defaultOptions.favicon);
|
|
54
|
+
const faviconPath = (0, path_1.join)(__dirname, defaultOptions.favicon);
|
|
54
55
|
// Setup default options
|
|
55
|
-
const options = lodash_1.defaultsDeep(config, defaultOptions);
|
|
56
|
+
const options = (0, lodash_1.defaultsDeep)(config, defaultOptions);
|
|
57
|
+
const specPrefixRegex = new RegExp(`${options.specPrefix}[/]*$`, 'i');
|
|
58
|
+
// eslint-disable-next-line @typescript-eslint/restrict-template-expressions
|
|
59
|
+
const routePrefixRegex = new RegExp(`${options.routePrefix}[/]*$`, 'i');
|
|
56
60
|
Handlebars.registerHelper('json', (context) => JSON.stringify(context));
|
|
57
61
|
Handlebars.registerHelper('strfnc', (fnc) => fnc);
|
|
58
62
|
Handlebars.registerHelper('isset', function (conditional, opt) {
|
|
59
63
|
return conditional ? opt.fn(this) : opt.inverse(this);
|
|
60
64
|
});
|
|
61
|
-
const index = Handlebars.compile(fs_1.readFileSync(path_1.join(__dirname, './index.hbs'), 'utf-8'));
|
|
65
|
+
const index = Handlebars.compile((0, fs_1.readFileSync)((0, path_1.join)(__dirname, './index.hbs'), 'utf-8'));
|
|
62
66
|
// eslint-disable-next-line func-names
|
|
63
67
|
return function koaSwaggerUi(ctx, next) {
|
|
64
|
-
if (options.exposeSpec && ctx.path
|
|
68
|
+
if (options.exposeSpec && specPrefixRegex.test(ctx.path)) {
|
|
65
69
|
ctx.body = options.swaggerOptions.spec;
|
|
66
70
|
return true;
|
|
67
71
|
}
|
|
68
|
-
if (options.routePrefix === false || ctx.path
|
|
72
|
+
if (options.routePrefix === false || routePrefixRegex.test(ctx.path)) {
|
|
69
73
|
ctx.type = 'text/html';
|
|
70
74
|
ctx.body = index(options);
|
|
71
75
|
return true;
|
|
72
76
|
}
|
|
73
77
|
if (extFavicon === undefined && ctx.path === defaultOptions.favicon) {
|
|
74
78
|
ctx.type = 'image/png';
|
|
75
|
-
ctx.body = fs_1.createReadStream(faviconPath);
|
|
79
|
+
ctx.body = (0, fs_1.createReadStream)(faviconPath);
|
|
76
80
|
return true;
|
|
77
81
|
}
|
|
78
82
|
return next();
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,2BAAoD;AACpD,uDAAyC;AAEzC,mCAAsC;AACtC
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,2BAAoD;AACpD,+BAA4B;AAG5B,uDAAyC;AAEzC,mCAAsC;AACtC,6CAAoD;AAkCpD,MAAM,cAAc,GAAwB;IAC1C,KAAK,EAAE,YAAY;IACnB,YAAY,EAAE,KAAK;IACnB,cAAc,EAAE;QACd,MAAM,EAAE,aAAa;QACrB,GAAG,EAAE,6CAA6C;QAClD,MAAM,EAAE,kBAAkB;KAC3B;IACD,WAAW,EAAE,OAAO;IACpB,UAAU,EAAE,YAAY;IACxB,cAAc,EAAE,EAAE;IAClB,UAAU,EAAE,KAAK;IACjB,UAAU,EAAE,KAAK;IACjB,OAAO,EAAE,cAAc;CACxB,CAAC;AAEF,SAAgB,UAAU,CACxB,SAAuC,EAAE;IAEzC,IAAI,MAAM,CAAC,cAAc,KAAK,SAAS,EAAE;QACvC,MAAM,GAAG,GAAG,IAAA,kBAAa,EAAC,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC,CAAC;QAC9C,IAAI,GAAG,KAAK,SAAS,EAAE;YACrB,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;SACtC;QAED,cAAc,CAAC,cAAc;YAC3B,GAAG,CAAC,WAAW,CAAC,eAAgB,CAAC,iBAAiB,CAAC,CAAC;KACvD;IAED,cAAc;IACd,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC;IAClC,MAAM,WAAW,GAAG,IAAA,WAAI,EAAC,SAAS,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC;IAE5D,wBAAwB;IACxB,MAAM,OAAO,GAAwB,IAAA,qBAAY,EAAC,MAAM,EAAE,cAAc,CAAC,CAAC;IAE1E,MAAM,eAAe,GAAG,IAAI,MAAM,CAAC,GAAG,OAAO,CAAC,UAAU,OAAO,EAAE,GAAG,CAAC,CAAC;IACtE,4EAA4E;IAC5E,MAAM,gBAAgB,GAAG,IAAI,MAAM,CAAC,GAAG,OAAO,CAAC,WAAW,OAAO,EAAE,GAAG,CAAC,CAAC;IAExE,UAAU,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC;IACxE,UAAU,CAAC,cAAc,CAAC,QAAQ,EAAE,CAAC,GAAmB,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC;IAClE,UAAU,CAAC,cAAc,CACvB,OAAO,EACP,UAAqB,WAAgB,EAAE,GAAkB;QACvD,OAAO,WAAW,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACxD,CAAC,CACF,CAAC;IACF,MAAM,KAAK,GAAG,UAAU,CAAC,OAAO,CAC9B,IAAA,iBAAY,EAAC,IAAA,WAAI,EAAC,SAAS,EAAE,aAAa,CAAC,EAAE,OAAO,CAAC,CACtD,CAAC;IAEF,sCAAsC;IACtC,OAAO,SAAS,YAAY,CAAC,GAAY,EAAE,IAAU;QACnD,IAAI,OAAO,CAAC,UAAU,IAAI,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YACxD,GAAG,CAAC,IAAI,GAAG,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC;YACvC,OAAO,IAAI,CAAC;SACb;QAED,IAAI,OAAO,CAAC,WAAW,KAAK,KAAK,IAAI,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;YACpE,GAAG,CAAC,IAAI,GAAG,WAAW,CAAC;YACvB,GAAG,CAAC,IAAI,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC;YAC1B,OAAO,IAAI,CAAC;SACb;QAED,IAAI,UAAU,KAAK,SAAS,IAAI,GAAG,CAAC,IAAI,KAAK,cAAc,CAAC,OAAO,EAAE;YACnE,GAAG,CAAC,IAAI,GAAG,WAAW,CAAC;YACvB,GAAG,CAAC,IAAI,GAAG,IAAA,qBAAgB,EAAC,WAAW,CAAC,CAAC;YACzC,OAAO,IAAI,CAAC;SACb;QAED,OAAO,IAAI,EAAE,CAAC;IAChB,CAAC,CAAC;AACJ,CAAC;AAzDD,gCAyDC","sourcesContent":["import { createReadStream, readFileSync } from 'fs';\nimport { join } from 'path';\n\nimport type { HelperDelegate, HelperOptions } from 'handlebars';\nimport * as Handlebars from 'handlebars';\nimport type { Context, Middleware, Next } from 'koa';\nimport { defaultsDeep } from 'lodash';\nimport { sync as readPkgUpSync } from 'read-pkg-up';\n\nexport interface SwaggerOptions {\n [key: string]:\n | string\n | boolean\n | string[]\n | Record<string, unknown>\n | null\n | undefined;\n dom_id?: string;\n url?: string;\n supportedSubmitMethods?: string[];\n docExpansion?: string;\n jsonEditor?: boolean;\n defaultModelRendering?: string;\n showRequestHeaders?: boolean;\n layout?: string;\n spec?: Record<string, unknown>;\n validatorUrl?: string | null;\n}\n\nexport interface KoaSwaggerUiOptions {\n title: string;\n oauthOptions: boolean | any;\n swaggerOptions: SwaggerOptions;\n swaggerVersion: string;\n routePrefix: string | false;\n specPrefix: string;\n exposeSpec: boolean;\n hideTopbar: boolean;\n favicon: string;\n}\n\nconst defaultOptions: KoaSwaggerUiOptions = {\n title: 'Swagger UI',\n oauthOptions: false,\n swaggerOptions: {\n dom_id: '#swagger-ui',\n url: 'https://petstore.swagger.io/v2/swagger.json',\n layout: 'StandaloneLayout',\n },\n routePrefix: '/docs',\n specPrefix: '/docs/spec',\n swaggerVersion: '',\n exposeSpec: false,\n hideTopbar: false,\n favicon: '/favicon.png',\n};\n\nexport function koaSwagger(\n config: Partial<KoaSwaggerUiOptions> = {},\n): Middleware {\n if (config.swaggerVersion === undefined) {\n const pkg = readPkgUpSync({ cwd: __dirname });\n if (pkg === undefined) {\n throw new Error('Package not found');\n }\n\n defaultOptions.swaggerVersion =\n pkg.packageJson.devDependencies!['swagger-ui-dist'];\n }\n\n // Setup icons\n const extFavicon = config.favicon;\n const faviconPath = join(__dirname, defaultOptions.favicon);\n\n // Setup default options\n const options: KoaSwaggerUiOptions = defaultsDeep(config, defaultOptions);\n\n const specPrefixRegex = new RegExp(`${options.specPrefix}[/]*$`, 'i');\n // eslint-disable-next-line @typescript-eslint/restrict-template-expressions\n const routePrefixRegex = new RegExp(`${options.routePrefix}[/]*$`, 'i');\n\n Handlebars.registerHelper('json', (context) => JSON.stringify(context));\n Handlebars.registerHelper('strfnc', (fnc: HelperDelegate) => fnc);\n Handlebars.registerHelper(\n 'isset',\n function (this: any, conditional: any, opt: HelperOptions) {\n return conditional ? opt.fn(this) : opt.inverse(this);\n },\n );\n const index = Handlebars.compile(\n readFileSync(join(__dirname, './index.hbs'), 'utf-8'),\n );\n\n // eslint-disable-next-line func-names\n return function koaSwaggerUi(ctx: Context, next: Next) {\n if (options.exposeSpec && specPrefixRegex.test(ctx.path)) {\n ctx.body = options.swaggerOptions.spec;\n return true;\n }\n\n if (options.routePrefix === false || routePrefixRegex.test(ctx.path)) {\n ctx.type = 'text/html';\n ctx.body = index(options);\n return true;\n }\n\n if (extFavicon === undefined && ctx.path === defaultOptions.favicon) {\n ctx.type = 'image/png';\n ctx.body = createReadStream(faviconPath);\n return true;\n }\n\n return next();\n };\n}\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "koa2-swagger-ui",
|
|
3
|
-
"version": "5.0
|
|
3
|
+
"version": "5.3.0",
|
|
4
4
|
"description": "Swagger UI middleware for koa",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -19,28 +19,28 @@
|
|
|
19
19
|
"test:ci": "jest --ci --coverage --no-cache"
|
|
20
20
|
},
|
|
21
21
|
"dependencies": {
|
|
22
|
-
"@types/koa": "^2.
|
|
23
|
-
"handlebars": "^4.7.
|
|
24
|
-
"lodash": "^4.17.
|
|
22
|
+
"@types/koa": "^2.13.4",
|
|
23
|
+
"handlebars": "^4.7.7",
|
|
24
|
+
"lodash": "^4.17.21",
|
|
25
25
|
"read-pkg-up": "^7.0.1"
|
|
26
26
|
},
|
|
27
27
|
"devDependencies": {
|
|
28
|
-
"@babel/plugin-transform-modules-commonjs": "7.
|
|
29
|
-
"@babel/preset-typescript": "7.
|
|
30
|
-
"@ctrl/eslint-config": "1.
|
|
31
|
-
"@jest/globals": "
|
|
32
|
-
"@types/koa-router": "7.4.
|
|
33
|
-
"@types/lodash": "4.14.
|
|
34
|
-
"@types/node": "
|
|
35
|
-
"@types/supertest": "2.0.
|
|
36
|
-
"del-cli": "
|
|
37
|
-
"jest": "
|
|
38
|
-
"koa": "2.13.
|
|
39
|
-
"koa-router": "10.
|
|
40
|
-
"supertest": "6.
|
|
41
|
-
"swagger-ui-dist": "
|
|
42
|
-
"ts-node": "
|
|
43
|
-
"typescript": "4.
|
|
28
|
+
"@babel/plugin-transform-modules-commonjs": "7.16.0",
|
|
29
|
+
"@babel/preset-typescript": "7.16.0",
|
|
30
|
+
"@ctrl/eslint-config": "3.1.1",
|
|
31
|
+
"@jest/globals": "27.3.1",
|
|
32
|
+
"@types/koa-router": "7.4.4",
|
|
33
|
+
"@types/lodash": "4.14.176",
|
|
34
|
+
"@types/node": "16.11.7",
|
|
35
|
+
"@types/supertest": "2.0.11",
|
|
36
|
+
"del-cli": "4.0.1",
|
|
37
|
+
"jest": "27.3.1",
|
|
38
|
+
"koa": "2.13.4",
|
|
39
|
+
"koa-router": "10.1.1",
|
|
40
|
+
"supertest": "6.1.6",
|
|
41
|
+
"swagger-ui-dist": "4.1.0",
|
|
42
|
+
"ts-node": "10.4.0",
|
|
43
|
+
"typescript": "4.4.4"
|
|
44
44
|
},
|
|
45
45
|
"release": {
|
|
46
46
|
"branch": "master"
|