koa2-swagger-ui 5.7.0 → 5.8.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.js +1 -1
- package/dist/index.js.map +1 -1
- package/package.json +17 -14
package/dist/index.js
CHANGED
|
@@ -69,7 +69,7 @@ function koaSwagger(config = {}) {
|
|
|
69
69
|
return conditional ? opt.fn(this) : opt.inverse(this);
|
|
70
70
|
});
|
|
71
71
|
const index = Handlebars.compile((0, fs_1.readFileSync)((0, path_1.join)(__dirname, './index.hbs'), 'utf-8'));
|
|
72
|
-
// eslint-disable-next-line func-names
|
|
72
|
+
// eslint-disable-next-line func-names, @typescript-eslint/promise-function-async
|
|
73
73
|
return function koaSwaggerUi(ctx, next) {
|
|
74
74
|
if (options.exposeSpec && specPrefixRegex.test(ctx.path)) {
|
|
75
75
|
ctx.body = options.swaggerOptions.spec;
|
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;AA0CpD,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,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../lib/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,2BAAoD;AACpD,+BAA4B;AAG5B,uDAAyC;AAEzC,mCAAsC;AACtC,6CAAoD;AA0CpD,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,iFAAiF;IACjF,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 // eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents\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, @typescript-eslint/promise-function-async\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.8.0",
|
|
4
4
|
"description": "Swagger UI middleware for koa",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -12,41 +12,44 @@
|
|
|
12
12
|
"lint": "eslint --ext .ts,.js .",
|
|
13
13
|
"lint:fix": "eslint --ext .ts,.js --fix .",
|
|
14
14
|
"prepare": "npm run build",
|
|
15
|
-
"build": "
|
|
15
|
+
"build": "tsc -p tsconfig.build.json",
|
|
16
16
|
"postbuild": "cp lib/index.hbs dist && cp lib/favicon.png dist",
|
|
17
17
|
"test": "jest",
|
|
18
18
|
"test:watch": "jest --watch",
|
|
19
19
|
"test:ci": "jest --ci --coverage --no-cache"
|
|
20
20
|
},
|
|
21
21
|
"dependencies": {
|
|
22
|
-
"@types/koa": "^2.13.
|
|
22
|
+
"@types/koa": "^2.13.6",
|
|
23
23
|
"handlebars": "^4.7.7",
|
|
24
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": "3.
|
|
31
|
-
"@jest/globals": "29.
|
|
28
|
+
"@babel/plugin-transform-modules-commonjs": "7.21.5",
|
|
29
|
+
"@babel/preset-typescript": "7.21.5",
|
|
30
|
+
"@ctrl/eslint-config": "3.7.0",
|
|
31
|
+
"@jest/globals": "29.5.0",
|
|
32
32
|
"@types/koa-router": "7.4.4",
|
|
33
|
-
"@types/lodash": "4.14.
|
|
34
|
-
"@types/node": "
|
|
33
|
+
"@types/lodash": "4.14.194",
|
|
34
|
+
"@types/node": "20.1.4",
|
|
35
35
|
"@types/supertest": "2.0.12",
|
|
36
|
-
"
|
|
37
|
-
"
|
|
38
|
-
"koa": "2.14.1",
|
|
36
|
+
"jest": "29.5.0",
|
|
37
|
+
"koa": "2.14.2",
|
|
39
38
|
"koa-router": "12.0.0",
|
|
40
39
|
"supertest": "6.3.3",
|
|
41
|
-
"swagger-ui-dist": "4.
|
|
40
|
+
"swagger-ui-dist": "4.18.3",
|
|
42
41
|
"ts-node": "10.9.1",
|
|
43
|
-
"typescript": "
|
|
42
|
+
"typescript": "5.0.4"
|
|
44
43
|
},
|
|
45
44
|
"release": {
|
|
46
45
|
"branches": [
|
|
47
46
|
"master"
|
|
48
47
|
]
|
|
49
48
|
},
|
|
49
|
+
"publishConfig": {
|
|
50
|
+
"access": "public",
|
|
51
|
+
"provenance": true
|
|
52
|
+
},
|
|
50
53
|
"jest": {
|
|
51
54
|
"testEnvironment": "node"
|
|
52
55
|
},
|