koa2-swagger-ui 5.4.0 → 5.6.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/README.md +1 -0
- package/dist/index.d.ts +7 -1
- package/dist/index.hbs +7 -3
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -44,6 +44,7 @@ specPrefix: '/docs/spec', // route where the spec is returned
|
|
|
44
44
|
exposeSpec: false, // expose spec file
|
|
45
45
|
hideTopbar: false, // hide swagger top bar
|
|
46
46
|
favicon: '/favicon.png', // default favicon
|
|
47
|
+
customCSS: `h1 { color: red }`, // Add Custom CSS on the html
|
|
47
48
|
```
|
|
48
49
|
|
|
49
50
|
## example
|
package/dist/index.d.ts
CHANGED
|
@@ -1,8 +1,12 @@
|
|
|
1
1
|
import type { Middleware } from 'koa';
|
|
2
2
|
export interface SwaggerOptions {
|
|
3
|
-
[key: string]: string | boolean | string[] | Record<string, unknown> | null | undefined;
|
|
3
|
+
[key: string]: string | boolean | string[] | Record<string, unknown> | Array<Record<string, unknown>> | null | undefined;
|
|
4
4
|
dom_id?: string;
|
|
5
5
|
url?: string;
|
|
6
|
+
urls?: Array<{
|
|
7
|
+
url: string;
|
|
8
|
+
name: string;
|
|
9
|
+
}>;
|
|
6
10
|
supportedSubmitMethods?: string[];
|
|
7
11
|
docExpansion?: string;
|
|
8
12
|
jsonEditor?: boolean;
|
|
@@ -17,10 +21,12 @@ export interface KoaSwaggerUiOptions {
|
|
|
17
21
|
oauthOptions: boolean | any;
|
|
18
22
|
swaggerOptions: SwaggerOptions;
|
|
19
23
|
swaggerVersion: string;
|
|
24
|
+
swaggerCdnUrl?: string;
|
|
20
25
|
routePrefix: string | false;
|
|
21
26
|
specPrefix: string;
|
|
22
27
|
exposeSpec: boolean;
|
|
23
28
|
hideTopbar: boolean;
|
|
24
29
|
favicon: string;
|
|
30
|
+
customCSS: string;
|
|
25
31
|
}
|
|
26
32
|
export declare function koaSwagger(config?: Partial<KoaSwaggerUiOptions>): Middleware;
|
package/dist/index.hbs
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
6
6
|
<title>{{title}}</title>
|
|
7
7
|
<link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700|Source+Code+Pro:300,600|Titillium+Web:400,600,700" rel="stylesheet">
|
|
8
|
-
<link rel="stylesheet" href="
|
|
8
|
+
<link rel="stylesheet" href="{{swaggerCdnUrl}}/{{swaggerVersion}}/swagger-ui.min.css">
|
|
9
9
|
<link rel="icon" type="image/png" href="{{favicon}}" />
|
|
10
10
|
<style>
|
|
11
11
|
html
|
|
@@ -25,6 +25,10 @@
|
|
|
25
25
|
margin:0;
|
|
26
26
|
background: #fafafa;
|
|
27
27
|
}
|
|
28
|
+
|
|
29
|
+
{{#if customCSS}}
|
|
30
|
+
{{{customCSS}}}
|
|
31
|
+
{{/if}}
|
|
28
32
|
</style>
|
|
29
33
|
</head>
|
|
30
34
|
|
|
@@ -66,8 +70,8 @@
|
|
|
66
70
|
|
|
67
71
|
<div id="swagger-ui"></div>
|
|
68
72
|
|
|
69
|
-
<script src="
|
|
70
|
-
<script src="
|
|
73
|
+
<script src="{{swaggerCdnUrl}}/{{swaggerVersion}}/swagger-ui-bundle.js"></script>
|
|
74
|
+
<script src="{{swaggerCdnUrl}}/{{swaggerVersion}}/swagger-ui-standalone-preset.js"></script>
|
|
71
75
|
<script>
|
|
72
76
|
function HideTopbarPlugin() {
|
|
73
77
|
// this plugin overrides the Topbar component to return nothing
|
package/dist/index.js
CHANGED
|
@@ -40,9 +40,11 @@ const defaultOptions = {
|
|
|
40
40
|
routePrefix: '/docs',
|
|
41
41
|
specPrefix: '/docs/spec',
|
|
42
42
|
swaggerVersion: '',
|
|
43
|
+
swaggerCdnUrl: 'https://cdnjs.cloudflare.com/ajax/libs/swagger-ui',
|
|
43
44
|
exposeSpec: false,
|
|
44
45
|
hideTopbar: false,
|
|
45
46
|
favicon: '/favicon.png',
|
|
47
|
+
customCSS: '',
|
|
46
48
|
};
|
|
47
49
|
function koaSwagger(config = {}) {
|
|
48
50
|
if (config.swaggerVersion === undefined) {
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2BAAoD;AACpD,+BAA4B;AAG5B,uDAAyC;AAEzC,mCAAsC;AACtC,6CAAoD;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2BAAoD;AACpD,+BAA4B;AAG5B,uDAAyC;AAEzC,mCAAsC;AACtC,6CAAoD;AAyCpD,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,aAAa,EAAE,mDAAmD;IAClE,UAAU,EAAE,KAAK;IACjB,UAAU,EAAE,KAAK;IACjB,OAAO,EAAE,cAAc;IACvB,SAAS,EAAE,EAAE;CACd,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 | Array<Record<string, unknown>>\n | null\n | undefined;\n dom_id?: string;\n url?: string;\n urls?: Array<{\n url: string;\n name: string;\n }>;\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 swaggerCdnUrl?: string;\n routePrefix: string | false;\n specPrefix: string;\n exposeSpec: boolean;\n hideTopbar: boolean;\n favicon: string;\n customCSS: 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 swaggerCdnUrl: 'https://cdnjs.cloudflare.com/ajax/libs/swagger-ui',\n exposeSpec: false,\n hideTopbar: false,\n favicon: '/favicon.png',\n customCSS: '',\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.
|
|
3
|
+
"version": "5.6.0",
|
|
4
4
|
"description": "Swagger UI middleware for koa",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -25,7 +25,7 @@
|
|
|
25
25
|
"read-pkg-up": "^7.0.1"
|
|
26
26
|
},
|
|
27
27
|
"devDependencies": {
|
|
28
|
-
"@babel/plugin-transform-modules-commonjs": "7.
|
|
28
|
+
"@babel/plugin-transform-modules-commonjs": "7.17.7",
|
|
29
29
|
"@babel/preset-typescript": "7.16.7",
|
|
30
30
|
"@ctrl/eslint-config": "3.3.1",
|
|
31
31
|
"@jest/globals": "27.5.1",
|
|
@@ -38,7 +38,7 @@
|
|
|
38
38
|
"koa": "2.13.4",
|
|
39
39
|
"koa-router": "10.1.1",
|
|
40
40
|
"supertest": "6.2.2",
|
|
41
|
-
"swagger-ui-dist": "4.6.
|
|
41
|
+
"swagger-ui-dist": "4.6.2",
|
|
42
42
|
"ts-node": "10.7.0",
|
|
43
43
|
"typescript": "4.6.2"
|
|
44
44
|
},
|